Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2015-01-10 22:31:14 +01:00
android/phoenix Change 'Resume Content' to 'Load RetroArch' 2015-01-04 15:14:15 +01:00
apple (iOS) Buildfix 2015-01-10 16:49:10 +01:00
audio (ALSA) Some simplifications 2015-01-10 04:26:19 +01:00
blackberry-qnx (BB10) Change Cascades labels 2015-01-05 02:06:00 +01:00
camera Start using MAX_PATH_LENGTH - relying on MAX_PATH for 360 can cause 2015-01-07 20:42:36 +01:00
compat/rxml Add/fix some trivial null checks 2014-11-14 23:06:34 -05:00
debian Update headers 2015-01-07 18:31:19 +01:00
decompress Start using MAX_PATH_LENGTH - relying on MAX_PATH for 360 can cause 2015-01-07 20:42:36 +01:00
deps (7zip) Clean up some 7z code 2014-10-22 07:47:21 +02:00
dist-scripts
docs Change some more instances of 'player' to 'user' 2014-12-05 14:21:04 +01:00
emscripten Start updating headers 2015-01-07 17:46:50 +01:00
frontend Move main_entry_decide function prototype to frontend.h 2015-01-10 06:46:21 +01:00
gfx Some cleanups in video_thread_wrapper.c 2015-01-10 18:55:37 +01:00
griffin Split up input_common.c into two files - input_joypad.c and 2015-01-10 20:10:45 +01:00
gx/ld
input Some more documentation for input_common.c 2015-01-10 21:17:34 +01:00
intl Start updating headers 2015-01-07 17:46:50 +01:00
libretro-sdk (SDK) Document file_path.c 2015-01-08 23:08:53 +01:00
libretro-test
libretro-test-gl Refactor gl/libretro-test.c a bit 2014-12-03 21:43:41 +01:00
location Start updating headers 2015-01-07 17:46:50 +01:00
logger Update headers 2015-01-07 18:24:13 +01:00
media (XDK360) Align the UI elements perfectly and make them share the same space 2015-01-08 01:08:10 +01:00
mem/neon
menu Split up input_common.c into two files - input_joypad.c and 2015-01-10 20:10:45 +01:00
msvc (XDK360) Disable CopyToHardDrive for Release_LTCG 2015-01-04 19:36:32 +01:00
ngc
pandora
performance
ps3 Update headers 2015-01-07 18:24:13 +01:00
psp1
qb (qb) Add header argument to check_lib 2014-10-28 22:30:29 -02:00
rarchdb (rarchdb) Silence some warnings 2015-01-09 17:55:56 +01:00
record Start updating headers 2015-01-07 17:46:50 +01:00
tests
tools Split up input_common.c into two files - input_joypad.c and 2015-01-10 20:10:45 +01:00
wii (Libretro SDK) Add crt/include/string.h 2014-10-25 06:52:47 +02:00
xdk Update headers 2015-01-07 18:24:13 +01:00
.empty
.gitignore Ignore build folder, never going to commit it 2014-10-15 18:53:47 +03:00
.project
AUTHORS (CoreText) Add to AUTHORS 2014-10-20 19:41:39 +02:00
autosave.c Add documentation for autosave.c and turn some functions static 2015-01-09 02:53:08 +01:00
autosave.h Add documentation for autosave.c and turn some functions static 2015-01-09 02:53:08 +01:00
cheats.c Cleanups 2015-01-09 15:33:58 +01:00
cheats.h Start updating headers 2015-01-07 17:46:50 +01:00
command.c Start updating headers 2015-01-07 17:46:50 +01:00
command.h Start updating headers 2015-01-07 17:46:50 +01:00
config.def.h Start updating headers 2015-01-07 17:46:50 +01:00
config.features.h Fix typo. 2014-11-30 15:43:58 +01:00
configure
content.c Cleanups 2015-01-09 15:33:58 +01:00
content.h add documentation to content.h 2015-01-08 19:12:55 +01:00
CONTRIBUTING.md
COPYING
core_info.c (core_info.c) Minor cleanups 2015-01-10 04:10:02 +01:00
core_info.h Start updating headers 2015-01-07 17:46:50 +01:00
core_options.c Start documenting core_options.c 2015-01-09 22:01:19 +01:00
core_options.h Start documenting core_options.c 2015-01-09 22:01:19 +01:00
driver.c Rename menu_common.c to menu.c 2015-01-10 04:53:37 +01:00
driver.h Move convenience macros used in runloop to runloop.c 2015-01-10 04:18:54 +01:00
dynamic_dummy.c Start updating headers 2015-01-07 17:46:50 +01:00
dynamic_dummy.h Start updating headers 2015-01-07 17:46:50 +01:00
dynamic.c Start documenting dynamic.c 2015-01-09 21:30:07 +01:00
dynamic.h Start documenting dynamic.c 2015-01-09 21:30:07 +01:00
fifo_buffer.c Some cleanups 2015-01-09 02:12:08 +01:00
fifo_buffer.h Start updating headers 2015-01-07 17:46:50 +01:00
file_ext.h Start updating headers 2015-01-07 17:46:50 +01:00
file_extract.c Fixup zlib_file_size early return 2015-01-09 16:57:04 +01:00
file_extract.h Start documenting file_extract.c 2015-01-09 15:46:22 +01:00
file_ops.c Document file_ops.c 2015-01-08 15:08:44 +01:00
file_ops.h Start updating headers 2015-01-07 17:46:50 +01:00
general.h Move rarch_main_wrap struct to retroarch.h 2015-01-09 18:53:16 +01:00
git_version.c Start updating headers 2015-01-07 17:46:50 +01:00
git_version.h Start updating headers 2015-01-07 17:46:50 +01:00
hash.c Start updating headers 2015-01-07 17:46:50 +01:00
hash.h Start updating headers 2015-01-07 17:46:50 +01:00
http_intf.c Start updating headers 2015-01-07 17:46:50 +01:00
http_intf.h Start updating headers 2015-01-07 17:46:50 +01:00
http_lib.c This HTTP thing works now. Also add a test tool. 2014-12-21 01:21:54 +01:00
http_lib.h Add header guard to http_lib.h 2014-12-20 22:17:50 +01:00
http_test.c Start updating headers 2015-01-07 17:46:50 +01:00
libretro_private.h Start updating headers 2015-01-07 17:46:50 +01:00
libretro_version_1.c Get rid of some tertiary conditionals and move conditional inside 2015-01-10 19:40:57 +01:00
libretro.h Update headers 2015-01-07 18:31:19 +01:00
Makefile Add rm -f *.d to Makefile clean targets 2014-11-18 16:01:36 +01:00
Makefile.common Split up input_common.c into two files - input_joypad.c and 2015-01-10 20:10:45 +01:00
Makefile.emscripten fix emscripten build 2014-12-31 20:26:49 -06:00
Makefile.griffin Update default shader dir - becomes media/shaders_cg 2014-10-29 07:44:06 +01:00
Makefile.openpandora
Makefile.pandora
Makefile.ps3 Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
Makefile.ps3.cobra
Makefile.ps3.rgl Move miscellaneous header over to libretro SDK 2014-10-21 08:39:37 +02:00
Makefile.ps3.salamander Update Salamander targets/Android 2014-10-22 03:42:07 +02:00
Makefile.psl1ght
Makefile.psp1 Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
Makefile.psp1.salamander Update Salamander targets/Android 2014-10-22 03:42:07 +02:00
Makefile.wii.salamander Update Salamander targets/Android 2014-10-22 03:42:07 +02:00
Makefile.win Add rm -f *.d to Makefile clean targets 2014-11-18 16:01:36 +01:00
Makefile.xenon
message_queue.c Document header of message_queue.h too 2015-01-08 18:48:31 +01:00
message_queue.h Document header of message_queue.h too 2015-01-08 18:48:31 +01:00
movie.c movie.c - move variable declarations to top of function 2015-01-10 06:43:56 +01:00
movie.h Start updating headers 2015-01-07 17:46:50 +01:00
netplay_compat.h Start updating headers 2015-01-07 17:46:50 +01:00
netplay.c Add documentation for netplay 2015-01-09 18:34:00 +01:00
netplay.h Add documentation for netplay 2015-01-09 18:34:00 +01:00
patch.c (patch.c) Declare variables at top of function 2015-01-07 19:58:19 +01:00
patch.h Start updating headers 2015-01-07 17:46:50 +01:00
performance.c Start adding documentation for performance.c 2015-01-09 02:37:46 +01:00
performance.h Start adding documentation for performance.c 2015-01-09 02:37:46 +01:00
playlist.c Take out retroarch logger dependencies from playlist.c 2015-01-08 15:58:09 +01:00
playlist.h Start updating headers 2015-01-07 17:46:50 +01:00
rarch_compr_file_path.c Start using MAX_PATH_LENGTH - relying on MAX_PATH for 360 can cause 2015-01-07 20:42:36 +01:00
rarch_compr_file_path.h Update headers 2015-01-07 18:24:13 +01:00
README-exynos.md
README-mali_fbdev_r4p0.md Add README-mali_fbdev_r4p0.md 2014-11-18 16:07:08 +01:00
README-OMAP.md
README.md Update README.md 2014-12-26 00:15:01 +01:00
retro.h Document retro.h too 2015-01-08 18:42:27 +01:00
retroarch_logger.h Start updating headers 2015-01-07 17:46:50 +01:00
retroarch-mingw-build.sh
retroarch.c Rename apply_deferred_settings 2015-01-10 06:37:27 +01:00
retroarch.cfg Initial implementation of remap binds feature 2015-01-05 22:53:21 +01:00
retroarch.h Move rarch_main_wrap struct to retroarch.h 2015-01-09 18:53:16 +01:00
rewind.c rewind.c - declare variables at top 2015-01-09 21:39:44 +01:00
rewind.h Start updating headers 2015-01-07 17:46:50 +01:00
runloop.c Push analog pad for every user 2015-01-10 22:31:14 +01:00
runloop.h Start documenting overlay.c 2015-01-10 00:59:05 +01:00
screenshot.c Start using MAX_PATH_LENGTH - relying on MAX_PATH for 360 can cause 2015-01-07 20:42:36 +01:00
screenshot.h Start updating headers 2015-01-07 17:46:50 +01:00
settings_data.c Remove menu_type_is - now obsolete 2015-01-10 05:25:37 +01:00
settings_data.h More documentation for settings_data.c 2015-01-09 16:45:58 +01:00
settings_list.c Start updating headers 2015-01-07 17:46:50 +01:00
settings_list.h Remove menu_type_is - now obsolete 2015-01-10 05:25:37 +01:00
settings.c settings.c - cleanups 2015-01-09 16:59:19 +01:00
settings.h Create new header 'settings.h' 2015-01-09 16:56:21 +01:00

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 -(http://buildbot.libretro.com/).

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:

  • PlayStation3
  • Xbox 360 (Libxenon/XeXDK)
  • Xbox 1
  • Wii, Gamecube (Libogc)
  • Raspberry Pi
  • Android
  • iOS
  • Blackberry

Dependencies (PC)

On Windows, RetroArch can run with only Win32 as dependency. On Linux, you need:

  • GL 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

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

PlayStation3

RetroArch PS3 needs to be compiled in the following order:

  1. Compile RetroArch Salamander

make -f Makefile.ps3.salamander

  1. Compile the RGL video driver

make -f Makefile.ps3.rgl

  1. Compile RetroArch as a library

make -f Makefile.ps3.retroarch

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

make -f Makefile.ps3

PlayStation3 - 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:

msvc-360/RetroArch-360.sln

NOTE: A pre-existing libretro library needs to be present in the 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.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.