Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2013-01-04 17:25:10 +01:00
360 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
android Hook up XML shader and overlay prefs. 2013-01-04 16:46:22 +01:00
audio Update license headers to 2013. 2013-01-01 01:41:15 +01:00
compat Add extern "C" to rxml.h for C++ builds 2013-01-02 17:32:35 +01:00
conf Update license headers to 2013. 2013-01-01 01:41:15 +01:00
console (RGL) More cleanups pt. 6 2013-01-04 07:28:14 +01:00
deps Update griffin for RXML. Purge libxml2. 2013-01-02 15:23:22 +01:00
docs Manpage linting. 2012-12-01 20:50:35 -07:00
gfx (PS3) Should fix resolution switching issues 2013-01-03 04:47:12 +01:00
gx (RARCH_CONSOLE) Use void* for param passing type 2013-01-03 03:02:52 +01:00
input Update license headers to 2013. 2013-01-01 01:41:15 +01:00
libretro-test Use XLookupKeysym instead. Add test. 2012-12-08 12:51:04 +01:00
media (Android) Smaller 'overlay next' button for basic overlay 2012-12-24 14:08:50 +01:00
msvc Update license headers to 2013. 2013-01-01 01:41:15 +01:00
ngc (NGC) fix dol loading error 2012-09-03 19:46:21 -04:00
pandora (Pandora) allow launcher to use retroarch-zip script 2012-09-18 20:02:26 -04:00
ps3 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
psp Update license headers to 2013. 2013-01-01 01:41:15 +01:00
psp1 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
qb Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
record Update license headers to 2013. 2013-01-01 01:41:15 +01:00
thread Update license headers to 2013. 2013-01-01 01:41:15 +01:00
tools Clarify batch mode for cg2xml.py. 2013-01-04 17:11:18 +01:00
vita Update license headers to 2013. 2013-01-01 01:41:15 +01:00
wii (Wii) Code style cleanups 2012-12-18 08:42:53 +01:00
xbox1 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
xdk (RARCH_CONSOLE) Use void* for param passing type 2013-01-03 03:02:52 +01:00
.empty initial new branch 2011-11-30 01:07:38 +01:00
.gitignore update .gitignore 2012-12-04 17:36:13 -05:00
AUTHORS (Android) Refactor JNI code 2012-12-23 07:30:15 +01: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 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
command.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
config.def.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
config.features.h Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
configure Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01: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
driver_funcs.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
driver.c Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
driver.h Add fallback path for RGBA. 2013-01-03 01:20:35 +01:00
dynamic.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
dynamic.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
fifo_buffer.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
fifo_buffer.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
file_path.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
file.c Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
file.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
general.h (XDK) Build fixes 2013-01-02 17:23:31 +01:00
hash.c Fix warnings. 2013-01-02 16:43:53 +01:00
hash.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
libretro.h Clarify multi-touch functionality for _POINTER. 2012-12-27 23:16:21 +01:00
Makefile Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
Makefile.ngc Remove remnants of HAVE_CONFIGFILE 2012-12-23 18:16:33 +01:00
Makefile.ngc.salamander Remove remnants of HAVE_CONFIGFILE 2012-12-23 18:16:33 +01:00
Makefile.pandora (Pandora) planning to use retroarch-zip later 2012-09-18 17:26:16 -04:00
Makefile.ps3 Just pull if shader directory is already cloned. 2013-01-04 16:55:15 +01:00
Makefile.ps3.rgl (RGL) More cleanups pt. 6 2013-01-04 07:28:14 +01:00
Makefile.ps3.salamander (Salamander PS3) Salamander links with GCC build if I use the SNC 2012-11-27 23:13:27 +01:00
Makefile.psl1ght Remove remnants of HAVE_CONFIGFILE 2012-12-23 18:16:33 +01:00
Makefile.psp1 Remove remnants of HAVE_CONFIGFILE 2012-12-23 18:16:33 +01:00
Makefile.wii Remove remnants of HAVE_CONFIGFILE 2012-12-23 18:16:33 +01:00
Makefile.wii.salamander Remove remnants of HAVE_CONFIGFILE 2012-12-23 18:16:33 +01:00
Makefile.win Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
Makefile.xenon Remove remnants of HAVE_CONFIGFILE 2012-12-23 18:16:33 +01:00
message.c Update license headers to 2013. 2013-01-01 01:41:15 +01:00
message.h Update license headers to 2013. 2013-01-01 01:41:15 +01: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 Update license headers to 2013. 2013-01-01 01:41:15 +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 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
performance.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
README.md Updated README.md to reflect changes 2012-06-30 16:41:35 +02: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-zip Minor change to retorach-zip 2012-11-09 12:56:39 -06:00
retroarch.c Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
retroarch.cfg Remove obsolete comment. 2013-01-04 17:25:10 +01: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 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
screenshot.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
settings.c Add custom xml parser. Use as fallback. 2013-01-02 15:18:42 +01:00
thread.c Update license headers to 2013. 2013-01-01 01:41:15 +01: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)
  • Wii (Libogc)
  • Raspberry Pi

Dependencies (PC)

RetroArch requires these libraries to build:

  • SDL

RetroArch can utilize these libraries if enabled:

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

RetroArch needs at least one of these audio driver libraries:

  • ALSA
  • OSS
  • RoarAudio
  • RSound
  • OpenAL
  • JACK
  • SDL
  • XAudio2 (Win32)
  • PulseAudio

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)

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