Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Hans-Kristian Arntzen 8a1dab2493 Create CONTRIBUTING.md
2012-12-09 00:56:51 -08:00
360 [CONSOLE] Make separate timers for holding scroll and menu/exit button delay. 2012-11-28 19:55:08 -05:00
android (Android) Add back PHOENIX_LEGACY hack because new Phoenix frontend 2012-12-08 12:58:16 +01:00
audio (Android) Fixes crippled performance on 4.1 (Jelly Bean) - I thought 2012-12-08 18:10:08 +01:00
compat getopt_long_ssnes -> getopt_long_rarch 2012-07-07 17:22:25 +02:00
conf Use strtod in config_get_float regardless. 2012-11-26 22:16:29 +01:00
console (Android) Refactor Android.mk - better defines 2012-12-03 04:58:44 +01:00
deps (Libxml2) Take out threads support 2012-11-30 17:40:18 +01:00
docs Manpage linting. 2012-12-01 20:50:35 -07:00
gfx Clarify use of gl->conv_buffer. 2012-12-08 13:38:48 +01:00
gx [CONSOLE] Make separate timers for holding scroll and menu/exit button delay. 2012-11-28 19:55:08 -05:00
input Use common code for handling keysym translations. 2012-12-08 13:26:10 +01:00
libretro-test Use XLookupKeysym instead. Add test. 2012-12-08 12:51:04 +01:00
media win32: update msvc project file 2012-11-13 20:54:46 +01:00
msvc Updates to 0.9.8-beta3 2012-11-25 12:56:25 +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 [CONSOLE] Make separate timers for holding scroll and menu/exit button delay. 2012-11-28 19:55:08 -05:00
psp (PSP1) Compile in custom getopt, still crashes somewher around file.c 2012-11-28 15:11:27 +01:00
psp1 (PSP1) Compile in custom getopt, still crashes somewher around file.c 2012-11-28 15:11:27 +01:00
qb Drop -pedantic. 2012-12-08 22:50:02 +01:00
record Realloc correct amount. 2012-12-09 10:14:34 +01:00
thread Minor stylistic cleanups. 2012-08-11 19:43:55 +02:00
tools Add volume control. 2012-11-03 14:15:03 +01:00
vita (PSP2) Rename to Vita 2012-11-26 03:16:20 +01:00
wii Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
xbox1 Update credits for collaborated files 2012-10-18 06:06:55 +02:00
xdk (XDK) Build fix 2012-12-02 06:01:39 +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 Update credits for collaborated files 2012-10-18 06:06:55 +02:00
autosave.c Snes exorcism 2012-07-07 17:19:32 +02:00
autosave.h More fixups. 2012-04-21 23:31:57 +02:00
boolean.h More fixups. 2012-04-21 23:31:57 +02:00
cheats.c Do not compare equal to empty string for cheats. 2012-08-19 14:05:28 +02:00
cheats.h More fixups. 2012-04-21 23:31:57 +02:00
command.c Add VOLUME_UP, VOLUME_DOWN to command interface. 2012-11-03 20:12:57 +01:00
command.h Add missing command.h. 2012-07-28 07:47:35 +02:00
config.def.h (PSP2) Rename to Vita 2012-11-26 03:16:20 +01:00
config.features.h Add feature logs in --feature. 2012-09-25 12:58:45 +02:00
configure Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
CONTRIBUTING.md Create CONTRIBUTING.md 2012-12-09 00:56:51 -08:00
COPYING Add GPLv3 text I suppose. 2011-01-25 13:31:55 +01:00
driver_funcs.h (Android) Set buffer count to 4 instead of 8 for Jelly Bean and 2012-12-02 07:32:28 +01:00
driver.c (PSP2) Rename to Vita 2012-11-26 03:16:20 +01:00
driver.h Small refactor 2012-11-26 22:12:26 +01:00
dynamic.c Add RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. An interface for allowing keyboard event data to be sent to the core. 2012-11-25 20:23:31 -05:00
dynamic.h More fixups. 2012-04-21 23:31:57 +02:00
fifo_buffer.c Fix rarch_stdint.h reference in fifo_buffer.c 2012-06-24 21:48:10 +02:00
fifo_buffer.h Update license headers. 2012-01-08 01:12:05 +01:00
file_path.c Make the correct strlcat assertion. 2012-11-25 16:29:34 +01:00
file.c Do not strip copier headers. 2012-11-17 00:32:36 +01:00
file.h Add fill_pathname_parent_dir. 2012-11-25 16:22:53 +01:00
general.h Merge pull request #72 from meancoot/master 2012-12-08 03:29:03 -08:00
hash.c More fixups. 2012-04-21 23:31:57 +02:00
hash.h Move baked-in dependencies to 'deps' directory 2012-11-20 03:34:45 +01:00
libretro.h Ensure enum size being int. 2012-12-08 12:32:33 +01:00
Makefile Drop -pedantic. 2012-12-08 22:50:02 +01:00
Makefile.ngc Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
Makefile.ngc.salamander Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
Makefile.pandora (Pandora) planning to use retroarch-zip later 2012-09-18 17:26:16 -04:00
Makefile.ps3 (PS3) Add create-salamander to .PHONY targets 2012-11-28 01:28:42 +01:00
Makefile.ps3.rgl (PS3) Committed RGL v2 - PS3 build should now compile again 2012-11-06 09:23:41 +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 Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
Makefile.psp1 (PSP1) Compile in custom getopt, still crashes somewher around file.c 2012-11-28 15:11:27 +01:00
Makefile.wii Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
Makefile.wii.salamander Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
Makefile.win Use SINC by default on x86. 2012-11-25 14:50:29 +01:00
Makefile.xenon Updates to 0.9.8-beta3 2012-11-25 12:56:25 +01:00
message.c More fixups. 2012-04-21 23:31:57 +02:00
message.h More fixups. 2012-04-21 23:31:57 +02:00
movie.c More fixups. 2012-04-21 23:31:57 +02:00
movie.h Revert rarch_stdint.h references 2012-06-24 21:55:36 +02:00
netplay_compat.h (PSL1GHT/PS3) Move more header includes/redefinitions to sdk_defines.h 2012-09-16 04:04:59 +02:00
netplay.c (360) Build fix - see previous commit 2012-11-15 14:32:06 +01:00
netplay.h Snes exorcism 2012-07-07 17:19:32 +02:00
patch.c Purge some still lingering SSNES-isms. 2012-09-07 21:56:26 +02:00
patch.h Revert rarch_stdint.h references 2012-06-24 21:55:36 +02:00
performance.c (Xbox 1) Build fixes 2012-11-10 13:46:24 +01:00
performance.h Style nits. 2012-11-05 11:57:40 +01:00
README.md Updated README.md to reflect changes 2012-06-30 16:41:35 +02:00
retroarch_logger.h (Salamander) Push quick fix for Salamander 2012-11-27 22:58:03 +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 Move log_fp to g_extern. 2012-11-26 16:59:00 +01:00
retroarch.cfg Add config file support to FFmpeg recording. 2012-11-23 22:46:36 +01:00
rewind.c More fixups. 2012-04-21 23:31:57 +02:00
rewind.h More fixups. 2012-04-21 23:31:57 +02:00
screenshot.c Add fill_pathname_join(). 2012-11-25 16:03:16 +01:00
screenshot.h Make screenshot_generate_filename public. 2012-08-19 21:36:22 +02:00
settings.c (PSP2) Rename to Vita 2012-11-26 03:16:20 +01:00
thread.c Move platform-specific thread code into common thread/ folder 2012-08-11 14:27:12 +02:00
thread.h Replace more SSNES strings/references 2012-04-22 02:06:34 +02: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'.