Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Themaister 40591bfdb5 Don't bake in RSound forcibly.
If HAVE_RSOUND is 1, it's already detected to be present anyways.
2013-11-01 09:16:08 +01:00
android (Android andretro) get rid of andretro 2013-11-01 07:49:07 +01:00
apple Saves 'Show Framerate' setting to config file now too 2013-10-11 01:19:54 +02:00
audio Remove sthread_exit(). Fix detach. 2013-11-01 09:12:36 +01:00
blackberry-qnx (RARCH_CONSOLE) Remove DECREMENT_BIND/INCREMENT_BIND 2013-10-06 20:01:44 +00:00
compat Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
conf Don't try to parse empty lines. 2013-10-24 23:47:11 +02:00
console (RMenu) remove input_presets_dir variable 2013-09-29 04:53:00 +02:00
deps (RSound) Bake in rsound for Android port - should also be possible 2013-11-01 00:07:52 +01:00
dist-scripts
docs Use skeleton config as basis for new configs. 2013-10-04 15:38:57 +02:00
emscripten [EMSCRIPTEN] remove chrome workaround in RWebAudio, it didn't actually activate or work well anyway 2013-10-30 21:52:38 -04:00
frontend (Android JNI) Use strlcpy 2013-11-01 07:02:38 +01:00
gfx (PS3/XDK) Set input and input_data pointers to NULL in context files 2013-10-30 14:03:21 +01:00
griffin (RSound) Bake in rsound for Android port - should also be possible 2013-11-01 00:07:52 +01:00
gx [GX] remove unused variables 2013-10-15 18:41:47 -04:00
input Fix some minor logging regression. 2013-10-26 00:26:31 +02:00
libretro-test Support variable strength for rumble motors. 2013-09-26 12:55:05 +02:00
libretro-test-gl
media Fix overlay calculations with rect. 2013-10-21 14:27:38 +02:00
msvc Split up file_list into separate compilable file 2013-10-07 08:56:16 +00:00
ngc
pandora
ps3 Fix a memory leak in function rglCgCreateProgramGroupFromFile in rgl_ps3_cg.cpp. 2013-10-13 23:19:50 -04:00
psp Take out messy Dpad emulation code - this will require an entire 2013-10-05 20:55:37 +00:00
psp1
qb Add mmap() backend to zlib extract. 2013-10-14 18:10:17 +02:00
record Fixup C89 for loops. 2013-10-22 21:37:56 +02:00
thread (GX) pthread wrapper - fill in some stubs (and some missing funcs) 2013-11-01 04:59:02 +01:00
tools Fixup C89 for loops. 2013-10-22 21:37:56 +02:00
wii
xdk (XDK) Fix message queue 2013-10-07 23:57:55 +02:00
xenon Take out messy Dpad emulation code - this will require an entire 2013-10-05 20:55:37 +00:00
.empty
.gitignore
.project
AUTHORS
autosave.c ARRAY_SIZE fixup. 2013-10-22 16:11:34 +02:00
autosave.h
boolean.h
cheats.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
cheats.h
command.c Fixup C89 for loops. 2013-10-22 21:37:56 +02:00
command.h
config.def.h (QNX) Add default_libretro_path for __QNX__ 2013-10-31 02:36:31 +01:00
config.features.h
configure
CONTRIBUTING.md
COPYING
core_info.c core_info.c - we no longer need the Android shenanigans to do 2013-10-30 01:52:44 +01:00
core_info.h Only display autodetect if there are info files. 2013-10-15 10:29:45 +02:00
core_options.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
core_options.h
driver_funcs.h
driver.c Clean up driver prev/next/find a bit. 2013-10-30 23:37:46 +01:00
driver.h Fix driver next/previous switching 2013-10-30 17:50:43 +01:00
dynamic_dummy.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
dynamic_dummy.h
dynamic.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
dynamic.h
fifo_buffer.c
fifo_buffer.h
file_ext.h
file_extract.c Start using C89-style for loop initial declarations for 2013-10-19 19:39:38 +02:00
file_extract.h Add mmap() backend to zlib extract. 2013-10-14 18:10:17 +02:00
file_path.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
file.c Start using C89-style for loop initial declarations for 2013-10-19 19:39:38 +02:00
file.h Use native side asset extraction. 2013-10-14 21:08:41 +02:00
general.h Get rid of MODE_INFO_DRAW 2013-10-11 01:28:26 +02:00
hash.c Start using C89-style for loop initial declarations for 2013-10-19 19:39:38 +02:00
hash.h
libretro_private.h
libretro.h Freeze GET_RUMBLE_INTERFACE. 2013-09-26 15:15:31 +02:00
Makefile Don't bake in RSound forcibly. 2013-11-01 09:16:08 +01:00
Makefile.emscripten [EMSCRIPTEN] fix build 2013-10-30 21:37:48 -04:00
Makefile.ngc
Makefile.openpandora
Makefile.pandora
Makefile.ps3
Makefile.ps3.rgl
Makefile.ps3.salamander
Makefile.psl1ght
Makefile.psp1
Makefile.shaders
Makefile.wii (GX) Get rid of HAVE_MINIOGC 2013-10-07 16:10:20 +02:00
Makefile.wii.salamander
Makefile.win Add GNU90_BUILD flag to toggle off -std=gnu99. 2013-10-22 21:41:51 +02:00
Makefile.xenon
message.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
message.h
movie.c
movie.h
netplay_compat.h
netplay.c Fixup C89 for loops. 2013-10-22 21:37:56 +02:00
netplay.h
patch.c Start using C89-style for loop initial declarations for 2013-10-19 19:39:38 +02:00
patch.h
performance.c Start using C89-style for loop initial declarations for 2013-10-19 19:39:38 +02:00
performance.h
README.md Update README.md 2013-10-02 10:54:03 +02:00
retroarch_logger.h Use native side asset extraction. 2013-10-14 21:08:41 +02:00
retroarch-mingw-build.sh Disable SSE in 32-bit Win32 Mingw build. 2013-09-27 00:11:32 +02:00
retroarch.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
retroarch.cfg Add description for rgui_show_start_screen in config. 2013-10-05 13:08:15 +02:00
rewind.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
rewind.h
screenshot.c Convert most C99-style for loop initial declarations to C89-compliant 2013-10-22 15:08:17 +02:00
screenshot.h
settings.c Move some more default settings to config.def.h 2013-10-31 02:34:49 +01:00
thread.c Remove sthread_exit(). Fix detach. 2013-11-01 09:12:36 +01:00
thread.h Remove sthread_exit(). Fix detach. 2013-11-01 09:12:36 +01:00

RetroArch

RetroArch is the reference frontend for the libretro API, an API which attempts to generalize a retro gaming system, such as emulators and game engines. Popular examples include SNES, NES, GameBoy, Arcade machines, Quake, DOOM, etc. Emulator and game cores are instantiated as dynamic libraries.

libretro

libretro is an API that exposes the core of a retro gaming system. A frontend for libretro (such as RetroArch) handles video output, audio output, input and application lifecycle. A libretro core written in portable C or C++ can run seamlessly on many platforms with very little/no porting effort.

While RetroArch is the reference frontend for libretro, several other projects have used the libretro interface to include support for emulators and/or game engines. libretro is completely open and free for anyone to use.

libretro API header

Binaries

Latest Windows binaries are currently hosted on Themaister's homepage. Builds can also be found on the forum.

Support

To reach developers, either make an issue here on Github, make a thread on the forum, or visit our IRC channel: #retroarch @ irc.freenode.org.

Documentation

See our wiki. On Unix, man-pages are provided. More developer-centric stuff is found here.

Philosophy

RetroArch attempts to be small and lean, while still having all the useful core features expected from an emulator. It is designed to be very portable and features a gamepad-centric UI called RGUI. It also has a full-featured command-line interface.

In some areas, RetroArch goes beyond and emphasizes on not-so-common technical features such as multi-pass shader support, real-time rewind (Braid-style), FFmpeg video recording, etc.

RetroArch also emphasizes on being easy to integrate into various launcher frontends.

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 requires latest versions of XCode to build.

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. It is not recommended to change this unless you know what you're doing. 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.

RetroArch will on startup create a config file in $XDG_CONFIG_HOME/retroarch/retroarch.cfg if doesn't exist. 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 RGUI or the retroarch-joyconfig command-line tool.

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.