Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Twinaphex a2778cf77b Merge pull request #930 from lioncash/lakka
Small changes to lakka
2014-09-04 05:57:44 +02:00
android/phoenix (Android) Compile in 7zip support 2014-09-02 21:26:31 +02:00
apple (iOS) Add HAVE_7ZIP support 2014-09-02 20:28:32 +02:00
audio Fix buffer overflow in JACK audio driver 2014-08-31 15:50:34 +01:00
blackberry-qnx Add null drivers 2014-08-14 03:05:44 +02:00
camera (Camera/Location stub drivers) Changes 2014-08-17 06:09:23 +02:00
compat Allow unix-like build under mingw 2014-08-29 16:40:25 -03:00
conf (config_file.c) Cleanups 2014-09-02 19:20:03 +02:00
debian Fix debian/rules. 2014-08-20 23:17:29 -03:00
decompress Move 7zip to deps/ 2014-09-02 21:45:14 +02:00
deps Move 7zip to deps/ 2014-09-02 21:45:14 +02:00
dist-scripts (PSP) update dist-script 2014-06-06 04:14:02 +01:00
docs (Recording) Bake in HAVE_RECORD implicitly 2014-08-12 05:28:43 +02:00
emscripten Replace more ROM references 2014-07-28 20:08:37 +02:00
frontend Merge pull request #930 from lioncash/lakka 2014-09-04 05:57:44 +02:00
gfx d3d_ctx: Fix indentation 2014-09-03 22:10:15 -04:00
griffin Move 7zip to deps/ 2014-09-02 21:45:14 +02:00
gx/ld (GX) Move sicksaxis GX files to input/ and rename it 2014-08-15 21:18:46 +02:00
input (PS3) ps3_input.c - Get rid of unneeded else 2014-09-03 17:59:55 +02:00
intl Move more strings to intl/english.h 2014-09-02 06:20:31 +02:00
libretro-test Libretro tests - Fixup Windows target filenames 2014-07-30 17:08:33 +02:00
libretro-test-gl Libretro tests - Fixup Windows target filenames 2014-07-30 17:08:33 +02:00
location (Camera/Location stub drivers) Changes 2014-08-17 06:09:23 +02:00
logger Move netlogger code around 2014-06-01 16:09:12 +02:00
media (XDK1) Get rid of xbox1/titleimage.jpg 2014-08-19 15:56:22 +02:00
mem Move memcpy implementations into separate dir 2014-07-20 05:33:53 +02:00
msvc (Menu) Split up menu entries code to menu_entries.c 2014-08-31 18:36:26 +02:00
ngc (Griffin) Take out ifndef HW_RVL out of ngc/ssaram.c - already guarded against 2013-07-28 20:15:26 +02:00
pandora (Pandora) Cleanup retroarch.cfg 2014-08-19 16:02:17 +02:00
performance (Logger) Some changes 2013-11-27 23:36:46 +01:00
ps3 (RGLGCM PS3) Get rid of some extraneous elses 2014-09-02 17:01:09 +02:00
psp1 (PSP1) update icons 2014-08-19 16:09:21 +02:00
qb Add --enable-preserve_dylib configure option 2014-09-02 21:12:24 +01:00
record Code reformatting (80-char limit); C-style comments 2014-08-20 17:18:43 +02:00
tests Rename more 'roms' references 2014-07-28 19:57:36 +02:00
thread (PSP) Add initial version of PSP pthread wrapper - very incomplete right now 2014-06-29 01:05:13 +02:00
tools retroarch-joyconfig: Fix two printf specifiers 2014-09-03 21:39:10 -04:00
wii (GX) Build fix 2014-08-15 21:08:56 +02:00
xdk (XDK) Update xdk_defines.h include 2014-08-15 21:01:23 +02:00
.empty initial new branch 2011-11-30 01:07:38 +01:00
.gitignore Revert "Add .project to .gitignore for Eclipse support" 2014-09-02 00:18:42 +01:00
.project Allow to load roms from external apps. 2013-08-19 23:23:39 +02:00
AUTHORS AUTHORS - add e-mail address 2014-08-18 18:54:11 +02:00
autosave.c Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
autosave.h Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
boolean.h Expand boolean.h 2014-02-11 07:52:10 +01:00
cheats.c Cleanups, 80-char limit 2014-09-02 16:13:42 +02:00
cheats.h Update years on all license headers 2014-01-01 01:50:59 +01:00
command.c Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
command.h Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
config.def.h (intl) Split up localization strings into separate header files 2014-09-02 00:21:51 +02:00
config.features.h Add SDL2 to feature list 2014-08-10 19:13:49 -03:00
configure PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md 2012-12-09 10:16:35 +01:00
COPYING Add GPLv3 text I suppose. 2011-01-25 13:31:55 +01:00
core_info.c Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
core_info.h Cleanups, 80-char limit 2014-09-02 16:13:42 +02:00
core_options.c Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
core_options.h Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
driver_menu.h (Menu) Get rid of hardcoded MENU_SETTINGS_PERFORMANCE_COUNTERS enum 2014-09-03 22:04:46 +02:00
driver.c Cleanups - C-style comments, 80-char limit, etc 2014-09-02 04:43:31 +02:00
driver.h Cleanups - C-style comments, 80-char limit, etc 2014-09-02 04:43:31 +02:00
dynamic_dummy.c Cleanups - 80-char limit 2014-09-02 05:57:53 +02:00
dynamic_dummy.h Cleanups - 80-char limit 2014-09-02 05:57:53 +02:00
dynamic.c Hide more manipulation of lifecycle_state behind rarch_main_set_state 2014-09-03 18:36:46 +02:00
dynamic.h Cleanups - 80-char limit 2014-09-02 05:57:53 +02:00
fifo_buffer.c Get rid of some extraneous elses 2014-08-27 03:11:06 +02:00
fifo_buffer.h Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
file_ext.h Cleanups to file_ext.h 2014-08-30 04:34:41 +02:00
file_extract.c Remove extraneous elses 2014-08-27 02:06:39 +02:00
file_extract.h Update more references to 'roms' 2014-08-13 08:52:13 +02:00
file_list.c (file_list.c) Add label set/get 2014-09-01 23:40:23 +02:00
file_list.h Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
file_path.c Added commandline 7z support 2014-09-02 17:05:15 +02:00
file_path.h Added commandline 7z support 2014-09-02 17:05:15 +02:00
file.c Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
file.h Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
general.h (Deferred core) Fix direct loading of deferred core 2014-09-04 05:10:44 +02:00
git_version.c Make C++ compiler happy. 2014-02-06 22:52:48 +01:00
git_version.h Make C++ compiler happy. 2014-02-06 22:52:48 +01:00
hash.c Move SHA-1 hashing to hash.c 2014-08-13 03:36:44 +02:00
hash.h Cleanups, 80-char limit 2014-09-02 16:13:42 +02:00
libretro_private.h Update years on all license headers 2014-01-01 01:50:59 +01:00
libretro.h (performance.c) Add RETRO_SIMD_AES 2014-09-02 20:50:43 +02:00
Makefile Merge pull request #926 from mprobinson/valgrind-support-renamed 2014-09-02 22:18:24 +02:00
Makefile.emscripten (Menu) Split up menu entries code to menu_entries.c 2014-08-31 18:36:26 +02:00
Makefile.griffin Take out HAVE_SCREENSHOTS everywhere 2014-07-22 03:22:18 +02:00
Makefile.openpandora Use __ARM_NEON__ define instead of HAVE_NEON 2014-07-26 20:18:37 +02:00
Makefile.pandora (Pandora) planning to use retroarch-zip later 2012-09-18 17:26:16 -04:00
Makefile.ps3 (PS3) Undefining HAVE_OVERLAY makes PS3 work again - look into 2014-08-18 15:08:21 +02:00
Makefile.ps3.cobra (OSK) Get rid of HAVE_OSK ifdef 2014-08-14 06:40:33 +02:00
Makefile.ps3.rgl (PS3) Change HAVE_RGL to HAVE_GCMGL 2014-02-25 22:01:46 +01:00
Makefile.ps3.salamander Cleanup frontend/frontend_salamander.c 2014-06-06 23:15:46 +02:00
Makefile.psl1ght Move netlogger code around 2014-06-01 16:09:12 +02:00
Makefile.psp1 (PSP1) Fix build 2014-08-22 10:46:14 +02:00
Makefile.psp1.salamander Cleanup frontend/frontend_salamander.c 2014-06-06 23:15:46 +02:00
Makefile.wii.salamander Cleanup frontend/frontend_salamander.c 2014-06-06 23:15:46 +02:00
Makefile.win Move 7zip to deps/ 2014-09-02 21:45:14 +02:00
Makefile.xenon Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
message_queue.c Cleanups - 80-char limit 2014-09-02 05:32:04 +02:00
message_queue.h Cleanups - 80-char limit 2014-09-02 05:32:04 +02:00
miscellaneous.h Cleanups - 80-char limit 2014-09-02 05:57:53 +02:00
movie.c Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
movie.h Update years on all license headers 2014-01-01 01:50:59 +01:00
netplay_compat.h Cleanups, 80-char limit 2014-09-02 16:13:42 +02:00
netplay.c Cleanups, 80-char limit 2014-09-02 16:13:42 +02:00
netplay.h Update years on all license headers 2014-01-01 01:50:59 +01:00
patch.c Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
patch.h Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
performance.c (performance.c) Add RETRO_SIMD_AES 2014-09-02 20:50:43 +02:00
performance.h Use __ARM_NEON__ define instead of HAVE_NEON 2014-07-26 20:18:37 +02:00
playlist.c Refactor load_menu_content_history 2014-09-03 00:14:02 +02:00
playlist.h Cleanups - 80-char limit 2014-09-02 05:32:04 +02:00
README-exynos.md exynos: update TODO list 2014-08-09 16:43:48 +02:00
README-OMAP.md video_omap: more docu fixes 2014-01-14 16:39:24 -06:00
README.md Update README.md 2014-08-20 13:22:00 +02:00
retroarch_logger.h Rename g_extern.verbose to g_extern.verbosity to avoid 2014-07-18 00:39:31 +02:00
retroarch-mingw-build.sh Add support for different "make" binaries 2014-07-30 01:14:57 +02:00
retroarch.c (Deferred core) Fix direct loading of deferred core 2014-09-04 05:10:44 +02:00
retroarch.cfg Make frame delay description clearer 2014-08-28 20:14:17 +01:00
rewind.c Cleanups - 80-char limit 2014-09-02 05:57:53 +02:00
rewind.h Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
screenshot.c Cleanups, 80-char limit 2014-09-02 16:13:42 +02:00
screenshot.h Update years on all license headers 2014-01-01 01:50:59 +01:00
settings_data.c Revert "(Menu) Change label detect_core_list to deferred_core_list for consistency" 2014-09-04 04:10:41 +02:00
settings_data.h (Menu) Add ifdef around get_mainmenu 2014-08-27 23:17:32 +02:00
settings.c Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
thread.c (PSP) Add initial version of PSP pthread wrapper - very incomplete right now 2014-06-29 01:05:13 +02:00
thread.h Cleanups - 80-char limit 2014-09-02 05:57:53 +02: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 Themaister's homepage. Builds can also be found on the forum.

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.