Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2015-01-20 21:15:43 -03:00
android/phoenix CoreManager: Load the x86 URL if the CPU ABI isn't ARM 2015-01-14 19:46:45 -05:00
apple remove reference to overlays dir so we can build again 2015-01-20 16:08:09 -05:00
audio Cleanup audio_monitor_set_refresh_rate 2015-01-18 19:02:28 +01:00
blackberry-qnx Rename audio/utils.c to audio/audio_utils.c 2015-01-13 00:19:46 +01:00
camera (OSX 10.6) Fix declaration shadows global variable warnings 2015-01-15 21:10:36 +01:00
compat/rxml Add/fix some trivial null checks 2014-11-14 23:06:34 -05:00
debian Update headers 2015-01-07 18:31:19 +01:00
decompress Cleanups in zip_support.c 2015-01-11 19:21:03 +01:00
deps (7zip) Clean up some 7z code 2014-10-22 07:47:21 +02:00
dist-scripts
docs Change some more instances of 'player' to 'user' 2014-12-05 14:21:04 +01:00
emscripten Start updating headers 2015-01-07 17:46:50 +01:00
frontend (iOS) Setup some default dirs 2015-01-17 06:52:54 +01:00
gfx Fix FPS drop due to suppress_screensaver being called on each frame 2015-01-20 22:31:59 +01:00
griffin Update Griffin 2015-01-20 01:06:46 +01:00
gx/ld
input linuxraw_joypad.c - Fix button polling 2015-01-20 21:15:43 -03:00
intl Start updating headers 2015-01-07 17:46:50 +01:00
libretro-sdk (Libretro SDK) Add file_list_sort_on_type to file_list.c 2015-01-19 07:15:16 +01:00
libretro-test
libretro-test-gl Refactor gl/libretro-test.c a bit 2014-12-03 21:43:41 +01:00
libretrodb Get rid of warning in query.c 2015-01-20 22:36:51 +01:00
location (OSX 10.6) Fix declaration shadows global variable warnings 2015-01-15 21:10:36 +01:00
logger Simplify retroarch_logger.h 2015-01-11 16:16:26 +01:00
media (Win32 UI) Add Audio Mute Toggle 2015-01-15 23:55:49 +01:00
mem/neon
menu Add function http_file_download 2015-01-21 01:12:26 +01:00
msvc Removed background from main repo 2015-01-13 01:09:06 +01:00
ngc
osk (OSX 10.6) Fix declaration shadows global variable warnings 2015-01-15 21:10:36 +01:00
pandora
performance
ps3 Update headers 2015-01-07 18:24:13 +01:00
psp1
qb (qb) Add header argument to check_lib 2014-10-28 22:30:29 -02:00
record Rename audio/utils.c to audio/audio_utils.c 2015-01-13 00:19:46 +01:00
tests
tools Rename input_context.c to input_joypad_driver.c 2015-01-12 20:29:01 +01:00
wii Move psp and gx drivers to gfx/drivers 2015-01-12 06:55:31 +01:00
win32 (Win32 UI) Add Audio Mute Toggle 2015-01-15 23:55:49 +01:00
xdk Use PATH_MAX_LENGTH instead of PATH_MAX. 2015-01-17 05:47:52 +01:00
.empty
.gitignore add apple/iOS/modules to the ignore list 2015-01-20 16:37:02 -05:00
.project
AUTHORS (CoreText) Add to AUTHORS 2014-10-20 19:41:39 +02:00
autosave.c Add documentation for autosave.c and turn some functions static 2015-01-09 02:53:08 +01:00
autosave.h Add documentation for autosave.c and turn some functions static 2015-01-09 02:53:08 +01:00
cheats.c (OSX) Cleanups 2015-01-19 21:11:08 +01:00
cheats.h Add Cheat File Save As 2015-01-19 19:00:26 +01:00
command.c Use PATH_MAX_LENGTH instead of PATH_MAX. 2015-01-17 05:47:52 +01:00
command.h Start updating headers 2015-01-07 17:46:50 +01:00
config.def.h Add gfx/video_viewport.c/viewport.h 2015-01-18 23:59:57 +01:00
config.features.h Fix typo. 2014-11-30 15:43:58 +01:00
configure
content.c Document file_ops.h 2015-01-16 02:01:05 +01:00
content.h add documentation to content.h 2015-01-08 19:12:55 +01:00
CONTRIBUTING.md
COPYING
core_info.c Remove unused core_info_list_get_by_id 2015-01-16 02:14:23 +01:00
core_info.h Remove unused core_info_list_get_by_id 2015-01-16 02:14:23 +01:00
core_options.c More documentation for core options functions and change 2015-01-16 02:10:17 +01:00
core_options.h More documentation for core options functions and change 2015-01-16 02:10:17 +01:00
driver.c Move get_proc_address/get_current_framebuffer to gfx/video_driver.c 2015-01-19 04:19:30 +01:00
driver.h Move get_proc_address/get_current_framebuffer to gfx/video_driver.c 2015-01-19 04:19:30 +01:00
dynamic_dummy.c (dynamic_dummy.c) Declare variables at top 2015-01-17 03:21:37 +01:00
dynamic_dummy.h Start updating headers 2015-01-07 17:46:50 +01:00
dynamic.c Move get_proc_address/get_current_framebuffer to gfx/video_driver.c 2015-01-19 04:19:30 +01:00
dynamic.h Add documentation to dynamic.c 2015-01-15 02:48:40 +01:00
file_ext.h Start updating headers 2015-01-07 17:46:50 +01:00
file_extract.c Move read_compressed_file to file_ops.c 2015-01-11 16:38:20 +01:00
file_extract.h Move compressed_file_list_new to file_extract.h 2015-01-16 01:37:34 +01:00
file_ops.c Remove unused write_empty_file() 2015-01-16 01:33:07 +01:00
file_ops.h Document file_ops.h 2015-01-16 02:01:05 +01:00
general.h Add Input Remapping Directory setting 2015-01-19 07:24:12 +01:00
git_version.c Start updating headers 2015-01-07 17:46:50 +01:00
git_version.h Start updating headers 2015-01-07 17:46:50 +01:00
hash.c (hash.c) Use C-style comments 2015-01-15 02:06:01 +01:00
hash.h (hash.c) Some cleanups/documentation 2015-01-15 02:04:14 +01:00
http_intf.c Add function http_file_download 2015-01-21 01:12:26 +01:00
http_intf.h Add function http_file_download 2015-01-21 01:12:26 +01:00
http_lib.c Add function http_file_download 2015-01-21 01:12:26 +01:00
http_lib.h (http_lib.c) Cleanups 2015-01-21 00:39:10 +01:00
libretro_private.h Start updating headers 2015-01-07 17:46:50 +01:00
libretro_version_1.c audio mute enable is now saved to config file 2015-01-16 23:26:09 +01:00
libretro_version_1.h Cleanups in libretro_version_1.c 2015-01-13 02:33:29 +01:00
libretro.h Update headers 2015-01-07 18:31:19 +01:00
Makefile Add rm -f *.d to Makefile clean targets 2014-11-18 16:01:36 +01:00
Makefile.common Update libretroDB and bake in compat_fnmatch.c 2015-01-20 01:00:17 +01:00
Makefile.emscripten Move Xaudio C interface to audio/drivers 2015-01-13 00:25:01 +01:00
Makefile.griffin Update default shader dir - becomes media/shaders_cg 2014-10-29 07:44:06 +01:00
Makefile.openpandora Rename audio/utils.c to audio/audio_utils.c 2015-01-13 00:19:46 +01:00
Makefile.pandora Build fixes 2015-01-12 23:38:21 +01:00
Makefile.ps3 Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
Makefile.ps3.cobra
Makefile.ps3.rgl Move miscellaneous header over to libretro SDK 2014-10-21 08:39:37 +02:00
Makefile.ps3.salamander Build fixes for RetroArch Salamander 2015-01-12 22:30:26 +01:00
Makefile.psl1ght
Makefile.psp1 Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
Makefile.psp1.salamander Build fixes for RetroArch Salamander 2015-01-12 22:30:26 +01:00
Makefile.wii.salamander Build fixes for RetroArch Salamander 2015-01-12 22:30:26 +01:00
Makefile.win Add rm -f *.d to Makefile clean targets 2014-11-18 16:01:36 +01:00
Makefile.xenon
movie.c movie.c - move variable declarations to top of function 2015-01-10 06:43:56 +01:00
movie.h Start updating headers 2015-01-07 17:46:50 +01:00
netplay_compat.h Start updating headers 2015-01-07 17:46:50 +01:00
netplay.c Move message queue to libretro-sdk 2015-01-11 05:35:47 +01:00
netplay.h Rename retro.h to libretro_version_1.h 2015-01-13 02:29:08 +01:00
patch.c (patch.c) Declare variables at top of function 2015-01-07 19:58:19 +01:00
patch.h Start updating headers 2015-01-07 17:46:50 +01:00
performance.c Start adding documentation for performance.c 2015-01-09 02:37:46 +01:00
performance.h Start adding documentation for performance.c 2015-01-09 02:37:46 +01:00
playlist.c More documentation 2015-01-18 09:25:48 +01:00
playlist.h Cleanup playlist.c/.h 2015-01-17 03:48:59 +01:00
README-exynos.md
README-mali_fbdev_r4p0.md Add README-mali_fbdev_r4p0.md 2014-11-18 16:07:08 +01:00
README-OMAP.md
README.md Update README.md 2014-12-26 00:15:01 +01:00
retroarch_logger.h Simplify retroarch_logger.h 2015-01-11 16:16:26 +01:00
retroarch-mingw-build.sh
retroarch.c Move set_rumble function to input/input_driver.c 2015-01-19 04:16:43 +01:00
retroarch.cfg Add Input Remapping Directory setting 2015-01-19 07:24:12 +01:00
retroarch.h (retroarch.h) Update documentation 2015-01-11 07:48:02 +01:00
rewind.c rewind.c - declare variables at top 2015-01-09 21:39:44 +01:00
rewind.h Start updating headers 2015-01-07 17:46:50 +01:00
runloop.c More documentation 2015-01-18 09:25:48 +01:00
runloop.h Start documenting overlay.c 2015-01-10 00:59:05 +01:00
screenshot.c Cleanups in screenshot code. 2015-01-16 07:03:26 +01:00
screenshot.h Start updating headers 2015-01-07 17:46:50 +01:00
settings_data.c Rename gfx_shader* to video_shader* 2015-01-19 21:24:08 +01:00
settings_data.h settings.c - cleanups 2015-01-14 00:35:27 +01:00
settings_list.c Start updating headers 2015-01-07 17:46:50 +01:00
settings_list.h Add UI Options 2015-01-16 16:15:58 +01:00
settings.c Add config_save_keybinds_file 2015-01-19 07:43:28 +01:00
settings.h Add config_save_keybinds_file 2015-01-19 07:43:28 +01:00

RetroArch

RetroArch is the reference frontend for the libretro API. Popular examples of implementations for this API includes videogame system emulators and game engines, but also more generalized 3D programs. These programs are instantiated as dynamic libraries. We refer to these as "libretro cores".

libretro

libretro is an API that exposes generic audio/video/input callbacks. 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 the buildbot -(http://buildbot.libretro.com/).

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. 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), video recording (using FFmpeg), 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 the built-in menu 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.