Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
meancoot 31a3611fa0 ios: Consolidate generation of the config file path.
Add the system directory whenever writing the config file.
     Refresh the config file before loaded a game.
2013-02-10 15:24:35 -05:00
android (Android) delete accidentally-added overlays/shaders 2013-02-05 23:13:08 -05:00
audio Use NEON conditionally for sample conversions. 2013-01-24 18:37:42 +01:00
compat Fix some bugs in attr handling in RXML. 2013-01-07 02:10:54 +01:00
conf Update license headers to 2013. 2013-01-01 01:41:15 +01:00
console (RARCH_CONSOLE) Remove HAVE_HDD_CACHE_PARTITION code 2013-01-22 13:09:18 +01:00
deps Fix Android build. 2013-01-12 22:32:21 +01:00
dist-scripts (dist_scripts) nit - xdk360-cores.sh 2013-02-06 09:55:41 +01:00
docs Update docs to clarify that zipped roms work. 2013-01-22 00:01:25 +01:00
frontend (GX) Remove 640x576 VI width/height option - height too big for EFB 2013-02-06 09:54:22 +01:00
gfx ios: Add a hack to skip frames when video non-block is used, this allows the fast forward function to be used. 2013-02-08 20:35:19 -05:00
gx (GX) Pass GX_NEAR_MIP_NEAR to GX_InitTexObjLOD just to be safe 2013-02-06 09:33:24 +01:00
input Allow scaling of overlays. 2013-02-03 23:36:27 +01:00
ios ios: Consolidate generation of the config file path. 2013-02-10 15:24:35 -05:00
libretro-test Use XLookupKeysym instead. Add test. 2012-12-08 12:51:04 +01:00
media add box's overlays 2013-02-04 21:02:40 -05:00
msvc (RARCH_CONSOLE) Remove HAVE_HDD_CACHE_PARTITION code 2013-01-22 13:09:18 +01:00
ngc (NGC) fix dol loading error 2012-09-03 19:46:21 -04:00
pandora Rename bSNES XML shaders to GLSL XML shader in comments 2013-01-07 17:07:21 +01:00
ps3 (PS3) Add ability to set menu skin 2013-02-01 07:42:36 +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 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 Fix compat with rubyFrameCount in cg2xml. 2013-01-26 14:44:25 +01:00
vita Update license headers to 2013. 2013-01-01 01:41:15 +01:00
wii (Wii) Bump up version to 0.9.8.1 2013-02-02 07:14:27 +01:00
xdk (XDK) Remove xdk_xinput_input.h header file 2013-01-22 01:05:48 +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 ios: Add a simple input driver draft; tracks only one touch for now. 2013-02-06 18:23:11 -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 (Xenon) Avoid some naming conflicts 2013-01-13 21:20:59 +01:00
driver.c ios: Add a simple input driver draft; tracks only one touch for now. 2013-02-06 18:23:11 -05:00
driver.h ios: Add a simple input driver draft; tracks only one touch for now. 2013-02-06 18:23:11 -05: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_extract.c Clearer switch code in extractor. 2013-01-24 07:35:52 +01:00
file_extract.h Add zip loading support to core. 2013-01-21 23:52:47 +01:00
file_path.c Fix path logic bug for Windows. 2013-01-12 23:34:24 +01:00
file.c delete the correct file 2013-01-21 20:28:30 -05:00
file.h Add zip loading support to core. 2013-01-21 23:52:47 +01:00
general.h Rework FPS measurement. 2013-02-05 12:51:12 +01:00
hash.c Fix warnings. 2013-01-02 16:43:53 +01:00
hash.h Fix regression in patching when zlib CRC32 is used. 2013-01-24 16:49:23 +01:00
libretro.h Clarify multi-touch functionality for _POINTER. 2012-12-27 23:16:21 +01:00
Makefile Use /usr/share/pixmaps instead of icons. 2013-01-26 17:52:04 +01:00
Makefile.ngc (Wii) Bump up version to 0.9.8.2 2013-02-03 18:48:34 +01:00
Makefile.ngc.salamander Update version numbers to 0.9.8. 2013-01-22 00:22:09 +01:00
Makefile.pandora (Pandora) planning to use retroarch-zip later 2012-09-18 17:26:16 -04:00
Makefile.ps3 (PS3) Link nxengine correctly in dist-scripts 2013-02-06 03:38:32 +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 Update version numbers to 0.9.8. 2013-01-22 00:22:09 +01:00
Makefile.psp1 Update version numbers to 0.9.8. 2013-01-22 00:22:09 +01:00
Makefile.shaders Add Makefile.shaders 2013-01-04 22:08:11 +01:00
Makefile.wii (Wii) link nxengine correctly in distscript 2013-02-05 19:29:35 -05:00
Makefile.wii.salamander Update version numbers to 0.9.8. 2013-01-22 00:22:09 +01:00
Makefile.win Update version numbers to 0.9.8. 2013-01-22 00:22:09 +01:00
Makefile.xenon Update version numbers to 0.9.8. 2013-01-22 00:22:09 +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 (XDK) Use QueryPerformanceCounter on _XBOX as well 2013-02-05 21:49:58 +01:00
performance.h Rework FPS measurement. 2013-02-05 12:51:12 +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 First revision of iOS port. Only tested on simulator thus far. 2013-02-06 10:14:05 -05:00
retroarch.cfg Add integer scale options. 2013-01-29 19:28: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 Add BGR24 saving mode. 2013-01-19 02:23:16 +01:00
screenshot.h Update license headers to 2013. 2013-01-01 01:41:15 +01:00
settings.c ios: Add a simple input driver draft; tracks only one touch for now. 2013-02-06 18:23:11 -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'.