Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2013-03-09 20:09:32 -05:00
android HAVE_RGUI and HAVE_RMENU are now mutually exclusive - no longer 2013-03-09 17:42:19 +01:00
audio Merge branch 'master' of https://github.com/Themaister/RetroArch into ios 2013-03-09 20:09:32 -05:00
compat Fix some bugs in attr handling in RXML. 2013-01-07 02:10:54 +01:00
conf (Playbook) Hardcode definition of CLOCK_MONOTONIC (looked at 2013-02-25 02:36:42 +01:00
console Rename rmenu_settings to menu_settings 2013-03-09 22:19:25 +01:00
deps (miniz) Take out header cruft to do with deflation routines 2013-02-17 00:43:45 +01:00
dist-scripts (GX) update dist scripts for big stack cores 2013-02-22 15:24:05 -05:00
docs Let $XDG_CONFIG_HOME fallback to $HOME/.config. 2013-02-26 18:46:07 +01:00
frontend (RGUI) Enable all menu features for Android 2013-03-10 01:30:41 +01:00
gfx Merge branch 'master' of https://github.com/Themaister/RetroArch into ios 2013-03-09 20:09:32 -05:00
gx (GX) No public visibility for gx_set_aspect 2013-03-09 22:47:09 +01:00
input Merge branch 'master' into cd-swap 2013-03-09 09:27:14 +01:00
ios (iOS) Rework BTstack handling: 2013-03-06 12:15:26 -05:00
libretro-test Use XLookupKeysym instead. Add test. 2012-12-08 12:51:04 +01:00
media (RMenu) Indent fixes 2013-02-17 22:02:42 +01:00
msvc (MSVC) Add strncasecmp to msvc_compat.h 2013-03-01 14:01:53 +01:00
ngc (NGC) Remove sidestep code 2013-02-14 15:48:14 +01:00
pandora Rename bSNES XML shaders to GLSL XML shader in comments 2013-01-07 17:07:21 +01:00
playbook (Playbook) request 'access to shared files' so that we can read 2013-03-01 17:29:38 +01:00
ps3 Rename RARCH_RMENU_TOGGLE to RARCH_MENU_TOGGLE 2013-03-09 16:14:26 +01:00
psp Move all frontend files to new dir 'frontend' 2013-01-06 05:22:21 +01:00
psp1 Update license headers to 2013. 2013-01-01 01:41:15 +01:00
qb Fix build on updated Pi-firmware. 2013-01-26 11:53:30 +00:00
record Add video_threaded option to Android. 2013-02-17 00:26:17 +01:00
thread Update license headers to 2013. 2013-01-01 01:41:15 +01:00
tools Add disk control to retroarch-joyconfig. 2013-03-09 09:58:31 +01:00
vita Update license headers to 2013. 2013-01-01 01:41:15 +01:00
wii (GX) Remove Wiiuse 2013-02-15 01:34:03 +01:00
xdk (360) Move class definitions to rmenu_xui.cpp instead of header 2013-03-09 22:31:13 +01:00
xenon (Xenon) Some more build fixes 2013-01-13 23:02:42 +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 Add ficoos to AUTHORS (for RetroLaunch) 2013-01-11 06:05:05 +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 Rework index parameter to set_shader(). 2013-01-08 04:08:15 +01:00
command.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
config.def.h Merge branch 'master' of https://github.com/Themaister/RetroArch into ios 2013-03-09 20:09:32 -05:00
config.features.h Add zip loading support to core. 2013-01-21 23:52:47 +01:00
configure Update version numbers to 0.9.8. 2013-01-22 00:22:09 +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 Make android_handle_events an implementation of input_poll function - 2013-03-04 14:12:04 +01:00
driver.c Merge branch 'master' of https://github.com/Themaister/RetroArch into ios 2013-03-09 20:09:32 -05:00
driver.h Merge branch 'master' of https://github.com/Themaister/RetroArch into ios 2013-03-09 20:09:32 -05:00
dynamic.c Add preliminary disk swapping interface. 2013-02-21 23:44:07 +01:00
dynamic.h Fix Win32 MSVC 2010 build. 2013-02-09 10:39:23 +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_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 (Playbook) Add Playbook ifdefs - cut down on compilation errors 2013-02-25 01:19:12 +01:00
file.c Error out correctly if ROM fopen() fails. 2013-02-18 20:31:29 +01:00
file.h Don't hardcode in an ext in fill_dated_*. 2013-02-17 10:20:10 +01:00
general.h Add rarch_bits_t. 2013-03-10 01:43:57 +01: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 Clarify that it's possible to remove images from the list. 2013-03-09 09:52:24 +01:00
Makefile Split up main() function to frontend/frontend.c 2013-02-25 07:01:16 +01:00
Makefile.ngc HAVE_RGUI and HAVE_RMENU are now mutually exclusive - no longer 2013-03-09 17:42:19 +01:00
Makefile.pandora (Pandora) planning to use retroarch-zip later 2012-09-18 17:26:16 -04:00
Makefile.ps3 Add HAVE_RARCH_MAIN_IMPLEMENTATION define - hook up console ports 2013-02-25 06:47:26 +01:00
Makefile.ps3.rgl (RGL) More cleanups, pt. 8 2013-01-05 20:29:54 +01:00
Makefile.ps3.salamander (PS3/Wii) fix builds 2013-01-09 02:57:26 +01:00
Makefile.psl1ght Add HAVE_RARCH_MAIN_IMPLEMENTATION define - hook up console ports 2013-02-25 06:47:26 +01:00
Makefile.psp1 HAVE_RGUI and HAVE_RMENU are now mutually exclusive - no longer 2013-03-09 17:42:19 +01:00
Makefile.shaders Add Makefile.shaders 2013-01-04 22:08:11 +01:00
Makefile.wii HAVE_RGUI and HAVE_RMENU are now mutually exclusive - no longer 2013-03-09 17:42:19 +01:00
Makefile.wii.salamander Update version numbers to 0.9.8. 2013-01-22 00:22:09 +01:00
Makefile.win Split up main() function to frontend/frontend.c 2013-02-25 07:01:16 +01:00
Makefile.xenon Add HAVE_RARCH_MAIN_IMPLEMENTATION define - hook up console ports 2013-02-25 06:47:26 +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 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 (Playbook) Add NEON sinc/audio_utils 2013-02-28 15:25:27 +01:00
performance.h Fix CXX_BUILD. 2013-02-08 12:05:22 +01:00
README.md Rename bSNES XML shaders to GLSL XML shader in comments 2013-01-07 17:07:21 +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-zip Minor change to retorach-zip 2012-11-09 12:56:39 -06:00
retroarch.c Drop another HAVE_RMENU ifdef in retroarch.c 2013-03-09 17:04:18 +01:00
retroarch.cfg Merge branch 'master' into cd-swap 2013-02-23 14:50:33 +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 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 Merge branch 'master' of https://github.com/Themaister/RetroArch into ios 2013-03-09 20:09:32 -05: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 (GLSL 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'.