Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2017-08-13 18:05:51 +02:00
.github add more fields 2017-01-14 15:16:59 -05:00
audio C89_BUILD fixes 2017-08-12 17:42:52 +02:00
bootstrap Small fix 2017-04-06 11:47:19 +02:00
camera Merge retro_stat and file_path 2017-06-16 15:00:11 +02:00
cheevos Cast ctype args to unsigned char 2017-08-08 12:21:48 +01:00
cores Add retro_timers.h/retro_math.h 2017-06-28 04:41:38 +02:00
ctr Updated assets.7z 2017-02-28 16:32:52 +00:00
defines [VITA] Fix 30 fps menu and frame throttle 2017-05-11 02:51:10 +02:00
deps Restore libui_main 2017-08-12 19:54:31 -04:00
dist-scripts Bump up to 1.6.4 2017-08-07 19:16:09 +02:00
docs
emscripten
frontend Silence some more C89_BUILD warnings 2017-08-12 18:15:26 +02:00
gfx Revert "Don't hide 'Resolution' setting behind compile-time ifdefs anymore" 2017-08-13 18:05:51 +02:00
griffin Convert gdi_ctx.cpp to C 2017-08-09 13:56:47 +02:00
input Silence some more C89_BUILD warnings 2017-08-12 18:15:26 +02:00
intl fix Other strings (#5286) 2017-08-12 17:38:56 +02:00
libretro-common Silence some more C89_BUILD warnings 2017-08-12 18:15:26 +02:00
libretro-db Update RDB building to ignore missing keys 2017-06-07 10:43:56 -04:00
location Merge runloop.c and retroarch.c 2017-05-11 09:11:46 +02:00
managers Cleanups 2017-05-21 16:43:40 +02:00
media update icons 2017-08-09 13:04:56 -05:00
memory (VITA) Add support for -mthumb 2016-11-14 19:13:07 +01:00
menu Cut down on code duplication 2017-08-13 07:14:10 +02:00
network netplay: show country next to lobby nickname 2017-07-29 02:24:11 +00:00
pkg update banner 2017-08-09 13:13:59 -05:00
qb Preliminary MOD/S3M/XM support through ibmx library (part of micromod repository) 2017-08-04 15:05:29 +02:00
record Add retro_timers.h/retro_math.h 2017-06-28 04:41:38 +02:00
tasks C89 buildfix 2017-08-06 17:11:13 +02:00
tools ps3: use python2 for pkg.py script 2017-08-06 20:17:00 -04:00
ui More C89_BUILD fixes 2017-08-12 18:02:39 +02:00
wifi Merge runloop.c and retroarch.c 2017-05-11 09:11:46 +02:00
wii/app_booter
wiiu Update imports.h 2017-08-07 23:25:05 +02:00
.editorconfig
.gitignore Add Wii U files to .gitignore 2017-06-15 15:20:05 +10:00
.project
.travis.yml (Travis CI) Use freeglut3-dev 2016-12-16 14:39:11 +01:00
autosave.h Rewrite autosave_init 2017-05-07 17:45:53 +02:00
CHANGES.md Update CHANGES.md 2017-08-13 03:36:45 +02:00
command.c Merge branch 'master' of github.com:libretro/RetroArch into libui 2017-08-12 20:50:19 -04:00
command.h allow specifying libretro device and analog dpad mode on remap files 2017-08-05 11:21:06 -05:00
config.def.h add new variables for "content dir" 2017-08-05 12:31:58 -05:00
config.def.keybinds.h Add QNX-specific settings to config.def.h, refactor default keybinds into a separate file for cleaner per-platform setup 2017-01-09 20:26:09 +00:00
config.features.h TinyALSA support 2017-06-23 20:44:00 -05:00
configuration.c Added option to change controller port to listen to for showing overlay input. 2017-08-08 09:56:27 -05:00
configuration.h Added option to change controller port to listen to for showing overlay input. 2017-08-08 09:56:27 -05:00
configure
content.h Simplify content_get_crc 2017-05-06 16:41:22 +02:00
CONTRIBUTING.md
COPYING
core_impl.c (Menu) Menu driver no longer uses a duplicate system info 2017-05-28 17:21:57 +02:00
core_info.c Merge retro_stat and file_path 2017-06-16 15:00:11 +02:00
core_info.h Update copyrights 2017-03-22 03:09:18 +01:00
core_type.h Update copyrights 2017-03-22 03:09:18 +01:00
core.h Revert "New attempt to fix memory leaks of struct retro_system_info" 2017-05-30 01:44:49 +02:00
database_info.c move content list builder into scanner task with progress, fixes menu freeze with large playlists 2017-07-09 00:44:02 -04:00
database_info.h move content list builder into scanner task with progress, fixes menu freeze with large playlists 2017-07-09 00:44:02 -04:00
defaults.h Music history list no longer tied to HAVE_FFMPEG 2017-05-28 00:00:51 +02:00
diff.diff update diff.diff 2017-01-17 17:13:42 +01:00
dirs.c Merge retro_stat and file_path 2017-06-16 15:00:11 +02:00
dirs.h Update copyrights 2017-03-22 03:09:18 +01:00
driver.c Fix driver menu left wrap 2017-07-11 21:00:44 -04:00
driver.h Fix driver menu left wrap 2017-07-11 21:00:44 -04:00
dynamic.c Add RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT 2017-08-07 18:06:03 +02:00
dynamic.h Add RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT 2017-08-07 18:06:03 +02:00
fetch-submodules.sh
file_path_special.c Move path variables 2017-04-29 00:39:29 +02:00
file_path_special.h Preliminary MOD/S3M/XM support through ibmx library (part of micromod repository) 2017-08-04 15:05:29 +02:00
file_path_str.c Preliminary MOD/S3M/XM support through ibmx library (part of micromod repository) 2017-08-04 15:05:29 +02:00
lakka.h
list_special.c Merge input_hid_driver 2017-06-11 08:56:36 +02:00
list_special.h Update copyrights 2017-03-22 03:09:18 +01:00
Makefile FreeBSD buildfix 2017-03-29 16:47:58 +00:00
Makefile.common Add include directory for glib 2017-08-12 20:42:40 -04:00
Makefile.ctr Move deps/zlib to deps/libz 2017-03-25 10:05:33 +01:00
Makefile.ctr.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.emscripten Move deps/zlib to deps/libz 2017-03-25 10:05:33 +01:00
Makefile.griffin Preliminary MOD/S3M/XM support through ibmx library (part of micromod repository) 2017-08-04 15:05:29 +02:00
Makefile.openpandora
Makefile.pandora
Makefile.ps3 Bump up to 1.6.4 2017-08-07 19:16:09 +02:00
Makefile.ps3.cobra (PS3) Add HAVE_STB_VORBIS 2017-06-01 01:25:41 +02:00
Makefile.ps3.salamander (PS3) Fix Salamander 2017-08-06 14:12:09 +02:00
Makefile.psl1ght Bump up to 1.6.4 2017-08-07 19:16:09 +02:00
Makefile.psp1 Move deps/zlib to deps/libz 2017-03-25 10:05:33 +01:00
Makefile.psp1.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.vita adding cheevos support to Vita port 2017-07-06 07:19:17 -03:00
Makefile.vita.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.wii.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.wiiu Add missing_libc_functions.c (for DOSBox) 2017-06-15 15:21:38 +10:00
Makefile.wiiu.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.win add wasapi audio driver 2017-04-11 00:24:37 +02:00
movie.c start fixing bsv recording 2017-05-29 22:49:12 -05:00
movie.h Revert "Refactor BSV movie code" 2017-05-07 18:28:07 +02:00
msg_hash.c Preliminary MOD/S3M/XM support through ibmx library (part of micromod repository) 2017-08-04 15:05:29 +02:00
msg_hash.h Added option to change controller port to listen to for showing overlay input. 2017-08-08 09:56:27 -05:00
no-xib.diff
paths.c allow savestates and savefiles to go into content dir via bool setting in addition of the empty string 2017-08-05 13:41:05 -05:00
paths.h Update copyrights 2017-03-22 03:09:18 +01:00
performance_counters.c Combine runloop_ctl and rarch_ctl 2017-05-15 05:06:23 +02:00
performance_counters.h Update copyrights 2017-03-22 03:09:18 +01:00
playlist.c Improve logs some more 2017-07-01 04:37:32 +02:00
playlist.h (playlist.c) Don't expose struct details to outside 2017-07-01 03:38:36 +02:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md README.md: Minor Markdown fixes 2016-12-11 17:55:36 -02:00
retroarch-mingw-build.sh
retroarch.c Add HAVE_LIBUI define 2017-08-12 18:43:16 -04:00
retroarch.cfg Disable showing hidden files by default 2017-06-21 10:46:32 -04:00
retroarch.desktop
retroarch.h remove remaps 2017-08-05 11:21:07 -05:00
setting_list.c Fix uint menu options wrap left 2017-07-09 00:55:31 -04:00
setting_list.h Update copyrights 2017-03-22 03:09:18 +01:00
verbosity.c Clean up the log output 2017-07-04 21:46:22 -04:00
verbosity.h Clean up the log output 2017-07-04 21:46:22 -04:00
version_git.c Update copyrights 2017-03-22 03:09:18 +01:00
version_git.h Update copyrights 2017-03-22 03:09:18 +01:00
version.h Bump up to 1.6.4 2017-08-07 19:16:09 +02:00

Build Status Coverity Scan Build Status

RetroArch

RetroArch is the reference frontend for the libretro API. Popular examples of implementations for this API includes videogame system emulators and game engines, but also more generalized 3D programs. These programs are instantiated as dynamic libraries. We refer to these as "libretro cores".

libretro

libretro is an API that exposes generic audio/video/input callbacks. A frontend for libretro (such as RetroArch) handles video output, audio output, input and application lifecycle. A libretro core written in portable C or C++ can run seamlessly on many platforms with very little/no porting effort.

While RetroArch is the reference frontend for libretro, several other projects have used the libretro interface to include support for emulators and/or game engines. libretro is completely open and free for anyone to use.

libretro API header

Binaries

Latest Windows binaries are currently hosted on the buildbot.

Support

To reach developers, either make an issue here on GitHub, make a thread on the forum, or visit our IRC channel: #retroarch @ irc.freenode.org.

Documentation

See our wiki. On Unix, man-pages are provided. More developer-centric stuff is found here.

Philosophy

RetroArch attempts to be small and lean, while still having all the useful core features expected from an emulator. It is designed to be very portable and features a gamepad-centric UI. It also has a full-featured command-line interface.

In some areas, RetroArch goes beyond and emphasizes on not-so-common technical features such as multi-pass shader support, real-time rewind (Braid-style), video recording (using FFmpeg), etc.

RetroArch also emphasizes on being easy to integrate into various launcher frontends.

Platforms

RetroArch has been ported to the following platforms outside PC:

  • PlayStation 3
  • Xbox 360 (Libxenon/XeXDK)
  • Xbox 1
  • Wii, Gamecube (Libogc)
  • Nintendo 3DS
  • Raspberry Pi
  • Android
  • iOS
  • Blackberry

Dependencies (PC)

There are no true hard dependencies per se.

On Windows, RetroArch can run with only Win32 as dependency.

On Linux, there are no true dependencies. For optimal usage, the following dependencies come as recommended:

  • GL headers / Vulkan headers
  • X11 headers and libs, or EGL/KMS/GBM

OSX port of RetroArch requires latest versions of XCode to build.

RetroArch can utilize these libraries if enabled:

  • nvidia-cg-toolkit
  • libxml2 (GLSL XML shaders)
  • libfreetype2 (TTF font rendering on screen)

RetroArch needs at least one of these audio driver libraries:

  • ALSA
  • OSS
  • RoarAudio
  • RSound
  • OpenAL
  • JACK
  • SDL
  • PulseAudio
  • XAudio2 (Win32, Xbox 360)
  • DirectSound (Win32, Xbox 1)
  • CoreAudio (OSX, iOS)

To run properly, RetroArch requires a libretro implementation present, however, as it's typically loaded dynamically, it's not required at build time.

Dependencies (Console ports, mobile)

Console ports have their own dependencies, but generally do not require anything other than what the respective SDKs provide.

Configuring

The default configuration is defined in config.def.h. It is not recommended to change this unless you know what you're doing. These can later be tweaked by using a config file. A sample configuration file is installed to /etc/retroarch.cfg. This is the system-wide config file.

RetroArch will on startup create a config file in $XDG_CONFIG_HOME/retroarch/retroarch.cfg if doesn't exist. Users only need to configure a certain option if the desired value deviates from the value defined in config.def.h.

To configure joypads, use the built-in menu or the retroarch-joyconfig command-line tool.

Compiling and installing

Linux

  • Prerequisites:
sudo apt-get install -y make git-core curl g++ pkg-config libglu1-mesa-dev freeglut3-dev mesa-common-dev libsdl1.2-dev libsdl-image1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev
  • Compiling:
./configure
make

Mac

  • Prerequisites: XCode, Cg.
  • You can open the project (pkg/apple/RetroArch.xcodeproj) in the Xcode IDE and build (⌘-B) and run (⌘-R) it there. Or you can use the command line...
  • Debug:
# Build
xcodebuild -target RetroArch -configuration Debug -project pkg/apple/RetroArch.xcodeproj
# Run
open ./pkg/apple/build/Debug/RetroArch.app/
  • Release:
# Build
xcodebuild -target RetroArch -configuration Release -project pkg/apple/RetroArch.xcodeproj
# Run
open ./pkg/apple/build/Release/RetroArch.app/

PC

Instructions for compiling on PC can be found in the wiki.

PlayStation 3

RetroArch PS3 needs to be compiled in the following order:

  1. Compile RetroArch Salamander

    make -f Makefile.ps3.salamander

  2. Finally, compile RetroArch packed together with the GUI:

    make -f Makefile.ps3

PlayStation 3 - Creating a PKG installable file

You can add pkg as a parameter in order to make a PKG file - for example:

make -f Makefile.ps3 pkg

This creates an NPDRM package. This can be installed on debug PS3s.

To make a non-NPDRM package that can be installed on a jailbroken/CFW PS3 (such as PSGroove or PS3 CFWs and other 3.55 CFW derivatives), do:

make -f Makefile.ps3 pkg-signed

If you're using Kmeaw 3.55 firmware, the package needs to be signed:

make -f Makefile.ps3 pkg-signed-cfw

NOTE: A pre-existing libretro library needs to be present in the root directory in order to link RetroArch PS3. This file needs to be called libretro_ps3.a.

Xbox 360 (XeXDK)

You will need Microsoft Visual Studio 2010 installed (or higher) in order to compile RetroArch 360.

The solution file can be found at the following location:

pkg/msvc-360/RetroArch-360.sln

NOTE: A pre-existing libretro library needs to be present in the pkg/msvc-360/RetroArch-360/Release directory in order to link RetroArch 360. This file needs to be called libretro_xdk360.lib.

Xbox 360 (Libxenon)

You will need to have the libxenon libraries and a working Devkit Xenon toolchain installed in order to compile RetroArch 360 Libxenon.

make -f Makefile.xenon

NOTE: A pre-existing libretro library needs to be present in the root directory in order to link RetroArch 360 Libxenon. This file needs to be called libretro_xenon360.a.

Wii

You will need to have the libogc libraries and a working Devkit PPC toolchain installed in order to compile RetroArch Wii.

make -f Makefile.griffin platform=wii

NOTE: A pre-existing libretro library needs to be present in the root directory in order to link RetroArch Wii. This file needs to be called libretro_wii.a.