Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2013-07-19 16:20:14 +02:00
android (Android) Don't use JELLY_BEAN_MR1 constant as it wasn't available on 2013-07-18 13:27:30 +02:00
apple PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02:00
audio Use GCC atomics to avoid locking in callback. 2013-07-17 22:47:34 +02:00
blackberry-qnx PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02:00
compat (iOS) Precompiled header gets turned into regular header - moved 2013-07-05 03:34:34 +02:00
conf Reintroduce CGP refactor. 2013-04-06 12:00:10 +02:00
console Remove screenshots_dir and cgp_dir from default_paths - cgp_dir 2013-04-06 22:37:07 +02:00
deps Add librsound_orig.c for targets other than PS3 2013-07-08 00:38:03 +02:00
dist-scripts Add changelog note about Cave Story/NXEngine 2013-06-28 14:32:32 +02:00
docs Update joyconfig docs. 2013-05-04 10:34:53 +02:00
frontend (APPLE) Build fixes for new frontend.c 2013-07-16 22:44:34 +02:00
gfx Take out GRIFFIN macro hacks 2013-07-18 19:54:00 +02:00
griffin Take out GRIFFIN macro hacks 2013-07-18 19:54:00 +02:00
gx (GX) implement joystick support 2013-07-04 14:52:53 -04:00
input Fix CXX_BUILD. 2013-06-05 10:47:19 +02:00
libretro-test (libretro-test) Add iOS target 2013-05-16 13:38:16 +02:00
libretro-test-gl (libretro-test-gl) Add ARM target 2013-07-14 13:37:37 +02:00
media Added a nice icon to the OSX port. Added the optimized SVG logo. 2013-07-11 19:38:14 +02:00
msvc Update maintenance - define/update PACKAGE_VERSION only once 2013-07-07 19:43:22 +02:00
ngc (NGC) Remove sidestep code 2013-02-14 15:48:14 +01:00
pandora Revert "More scrubbing (pt. 2)" 2013-04-06 03:52:58 +02:00
ps3 Cleanups 2013-06-03 00:44:09 +02:00
psp Revert "Remove platform-specific MAX_PADS - use global define MAX_PLAYERS" 2013-03-16 17:51:45 +01:00
psp1 (RARCH_CONSOLE) Get rid of video_stop_func 2013-04-24 16:08:18 +02:00
qb PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02:00
record Include avutil/channel_layout.h correctly. 2013-03-15 14:47:45 +01:00
thread Update license headers to 2013. 2013-01-01 01:41:15 +01:00
tools Work around awkward GLSL compiler bug on iOS. 2013-05-31 14:04:20 +02:00
vita (RARCH_CONSOLE) Get rid of video_stop_func 2013-04-24 16:08:18 +02:00
wii Bump version to 0.9.9 official 2013-05-27 01:28:32 +02:00
xdk (XDK1) Fix build 2013-07-16 00:47:09 +02:00
xenon Revert "Remove platform-specific MAX_PADS - use global define MAX_PLAYERS" 2013-03-16 17:51:45 +01:00
.empty initial new branch 2011-11-30 01:07:38 +01:00
.gitignore Changes iOS directory to apple in gitignore. 2013-07-13 00:06:41 -03:00
AUTHORS Update AUTHORS 2013-07-05 13:52:59 +02:00
autosave.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
autosave.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
boolean.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
cheats.c Fix warnings. 2013-01-02 16:43:53 +01:00
cheats.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
command.c Remove fixed shader index in set_shader. 2013-04-07 13:00:21 +02:00
command.h Fix MSVC 2010 build. 2013-04-21 10:05:26 +02:00
config.def.h Use 44.1kHz audio on Android. 2013-07-17 22:48:03 +02:00
config.features.h Add zip loading support to core. 2013-01-21 23:52:47 +01: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 (XDK1) Fix build 2013-07-16 00:47:09 +02:00
core_info.h Cleanup core info code for blackberry (not tested) 2013-06-25 21:04:38 -04:00
core_options.c Set updated to false when core_config_get is called. 2013-04-04 18:10:34 +02:00
core_options.h Fix MSVC 2010 build. 2013-04-21 10:05:26 +02:00
driver_funcs.h Take out GRIFFIN macro hacks 2013-07-18 19:54:00 +02:00
driver.c (Apple) Add keyboard input support for OSX 2013-07-07 16:01:58 -04:00
driver.h Added auto detection for the iControlPad when using the HID joystick profile and adjusted the iControlPad Bluez IME detection to look for the IME. 2013-07-14 10:06:10 +02:00
dynamic_dummy.c Allow game selection directly if core is set. 2013-04-22 16:58:00 +02:00
dynamic_dummy.h Add dummy core loading. 2013-04-14 16:29:30 +02:00
dynamic.c Add RETRO_ENVIRONMENT_GET_LIBRETRO_PATH. 2013-07-07 13:24:08 +02:00
dynamic.h Clean up load_no_rom grabbing interface. 2013-05-02 15:17:31 +02:00
fifo_buffer.c Update fifo_buffer.c license header - license header was still 2013-04-04 07:26:29 +02:00
fifo_buffer.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
file_ext.h (file_ext.h) lowercase .dll/.so 2013-07-15 14:56:38 +02:00
file_extract.c Change WANT_RZLIB to WANT_MINIZ 2013-02-16 21:43:29 +01:00
file_extract.h Add zip loading support to core. 2013-01-21 23:52:47 +01:00
file_path.c Ensure that g_settings.libretro is absolute path. 2013-05-13 23:25:37 +02:00
file.c Add RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME. 2013-05-01 00:59:43 +02:00
file.h Ensure that g_settings.libretro is absolute path. 2013-05-13 23:25:37 +02:00
general.h (APPLE) Build fixes for new frontend.c 2013-07-16 22:44:34 +02:00
hash.c Fix warnings. 2013-01-02 16:43:53 +01:00
hash.h Change WANT_RZLIB to WANT_MINIZ 2013-02-16 21:43:29 +01:00
libretro.h Add RETRO_ENVIRONMENT_GET_LIBRETRO_PATH. 2013-07-07 13:24:08 +02:00
Makefile Purge SDL/GL context. 2013-07-18 01:48:23 +02:00
Makefile.ngc Update maintenance - define/update PACKAGE_VERSION only once 2013-07-07 19:43:22 +02:00
Makefile.openpandora (Pandora) Set default input driver for OpenPandora 2013-07-07 20:05:03 +02:00
Makefile.pandora (Pandora) planning to use retroarch-zip later 2012-09-18 17:26:16 -04:00
Makefile.ps3 Update maintenance - define/update PACKAGE_VERSION only once 2013-07-07 19:43:22 +02:00
Makefile.ps3.rgl (RGL PS3) Combine files 2013-03-30 17:06:19 +01:00
Makefile.ps3.salamander (Salamander) Split up Salamander into its own separate file 2013-03-22 21:27:34 +01:00
Makefile.psl1ght PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02:00
Makefile.psp1 Update maintenance - define/update PACKAGE_VERSION only once 2013-07-07 19:43:22 +02:00
Makefile.shaders Makefile.shaders - now checks out shaders on OSX 2013-05-29 12:57:20 +02:00
Makefile.wii Update maintenance - define/update PACKAGE_VERSION only once 2013-07-07 19:43:22 +02:00
Makefile.wii.salamander PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02:00
Makefile.win PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02:00
Makefile.xenon Update maintenance - define/update PACKAGE_VERSION only once 2013-07-07 19:43:22 +02:00
message.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
message.h Fix MSVC 2010 build. 2013-04-21 10:05:26 +02:00
movie.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
movie.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
netplay_compat.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
netplay.c Don't compile in autosave for consoles 2013-02-17 02:00:51 +01:00
netplay.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
patch.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
patch.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
performance.c Add HAVE_NEON define preprocessor rule for performance.c 2013-07-12 21:31:14 +02:00
performance.h Fix CXX_BUILD. 2013-02-08 12:05:22 +01:00
README.md Update README.md 2013-03-22 14:52:55 +01:00
retroarch_logger.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
retroarch-mingw-build.sh Use SINC by default on x86. 2012-11-25 14:50:29 +01:00
retroarch.c remove ifdefs around puts PACKAGEVERSION line 2013-07-04 15:06:28 +02:00
retroarch.cfg Fix ROM history being deleted when ROM includes ;. 2013-06-09 22:24:30 +02:00
rewind.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
rewind.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
screenshot.c Don't hardcode in an ext in fill_dated_*. 2013-02-17 10:20:10 +01:00
screenshot.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
settings.c (Apple) Add keyboard input support for OSX 2013-07-07 16:01:58 -04:00
thread.c Simplify some _WIN32 includes 2013-04-11 22:35:15 +02:00
thread.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00

RetroArch

RetroArch (formerly known as SSNES) is a simple frontend for the libretro API. An API that attempts to generalize a retro gaming system, such as SNES, NES, GameBoy, Arcade machines, etc. Emulator/game cores are instantiated as loadable plugins.

libretro

libretro is an API that exposes the core of a retro gaming system. A frontend for libretro handles video output, audio output and input. A libretro core written in portable C or C++ can run seamlessly on many platforms.

libretro API header

Binaries

Latest Windows binaries are currently hosted on my homepage.

Related projects

Philosophy

RetroArch attempts to be very small and lean, while still having all the useful core features expected from an emulator. It is used through command-line. It is also designed to be portable.

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 still requires SDL 1.2 libraries.

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. 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. Each user should create a config file in $XDG_CONFIG_HOME/retroarch/retroarch.cfg. The 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 retroarch-joyconfig tool. It is also possible to configure joypads using the RetroArch-Phoenix GUI frontend.

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'.