Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2014-11-20 02:44:30 +01:00
android/phoenix Merge pull request #1261 from lioncash/xml 2014-11-19 21:03:46 +01:00
apple (OSX) Rename target to RetroArch 10.6 2014-11-18 18:46:53 +01:00
audio xaudio: Fix a typo in xa_stop 2014-11-14 22:55:44 -05:00
blackberry-qnx Fixup some headers 2014-10-23 03:54:18 +02:00
camera Misc. minor cleanups 2014-10-27 04:04:04 +01:00
compat/rxml Add/fix some trivial null checks 2014-11-14 23:06:34 -05:00
debian Fix debian/rules. 2014-08-20 23:17:29 -03:00
decompress zip_support: Fix potential memory leaks 2014-10-26 12:39:29 -04:00
deps (7zip) Clean up some 7z code 2014-10-22 07:47:21 +02:00
dist-scripts (PSP) update dist-script 2014-06-06 04:14:02 +01:00
docs Move Retrolaunch to separate repo 2014-10-16 07:34:59 +02:00
emscripten Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
frontend Take out unused process_events callback from frontend_context driver 2014-11-08 16:45:55 +01:00
gfx (2xBR) Build fix 2014-11-19 03:00:00 +01:00
griffin First draft of ios_menu 2014-11-04 22:01:01 -05:00
gx/ld (GX) Move sicksaxis GX files to input/ and rename it 2014-08-15 21:18:46 +02:00
input Add wrapper functions for WPAD_StickX/WPAD_StickY 2014-11-19 02:51:34 +01:00
intl fix disk_next, add option for disk_prev 2014-10-07 20:19:12 -05:00
libretro-sdk (SDK) Add memory_stream 2014-11-01 20:49:57 +01:00
libretro-test Libretro tests - Fixup Windows target filenames 2014-07-30 17:08:33 +02:00
libretro-test-gl Libretro tests - Fixup Windows target filenames 2014-07-30 17:08:33 +02:00
location Minor cleanup in location/android.c 2014-10-27 04:05:51 +01:00
logger (XDK1) Some build fixes 2014-10-22 02:00:12 +02:00
media (XDK1) Get rid of xbox1/titleimage.jpg 2014-08-19 15:56:22 +02:00
mem/neon (PS3) Get rid of altivec_mem 2014-09-07 05:49:34 +02:00
menu Move more code to settings_data.c 2014-11-20 02:44:30 +01:00
msvc (MSVC) Make x64 target work 2014-10-27 16:17:09 +01:00
ngc
pandora (Pandora) Cleanup retroarch.cfg 2014-08-19 16:02:17 +02:00
performance
ps3 (GCM GL) Cleanups 2014-10-22 05:42:03 +02:00
psp1 (PSP1) update icons 2014-08-19 16:09:21 +02:00
qb (qb) Add header argument to check_lib 2014-10-28 22:30:29 -02:00
record Move scaler code over to libretro SDK 2014-10-23 04:34:35 +02:00
tests Style / indent nits 2014-09-09 05:24:32 +02:00
tools (Joyconfig) Create retroarch-joyconfig-griffin.c - should be a lot 2014-10-27 15:45:18 +01:00
wii (Libretro SDK) Add crt/include/string.h 2014-10-25 06:52:47 +02:00
xdk (D3D) Add d3d_set_transform 2014-09-13 21:50:23 +02:00
.empty
.gitignore Ignore build folder, never going to commit it 2014-10-15 18:53:47 +03:00
.project
AUTHORS (CoreText) Add to AUTHORS 2014-10-20 19:41:39 +02:00
autosave.c Reduce header includes pt. 2 2014-10-21 19:10:14 +02:00
autosave.h Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
cheats.c Take out dynamic.h header include from general.h 2014-10-22 04:27:51 +02:00
cheats.h Style cleanups 2014-09-07 05:47:18 +02:00
command.c Remove driver.h include in command.c 2014-10-22 07:09:31 +02:00
command.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
config.def.h (Camera) Make it more backwards-compatible 2014-11-18 18:11:01 +01:00
config.features.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
configure
content.c content: Fix potential memory leak 2014-10-26 12:18:00 -04:00
content.h Rename file.c/file.h to content.c/content.h 2014-10-21 23:44:03 +02:00
CONTRIBUTING.md
COPYING
core_info.c Remove core_info_get_first_custom_config - no longer used 2014-11-08 15:16:25 +01:00
core_info.h (XMB) Display core icons 2014-11-11 16:28:40 +01:00
core_options.c Move config-file code to SDK 2014-10-22 03:35:04 +02:00
core_options.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
driver.c (Apple) Change __IPHONE_3_0 to __IPHONE_4_0 for AVFoundation camera 2014-11-18 18:11:43 +01:00
driver.h (Apple) Start making camera driver OSX-compatible (OSX 10.7 and up/requires AVFoundation) 2014-11-18 18:04:17 +01:00
dynamic_dummy.c (dynamic_dummy.c) Change index variable to idx 2014-10-20 22:46:44 +02:00
dynamic_dummy.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
dynamic.c Set g_extern.frontend_key_event to new keyboard callback as soon as RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK is called 2014-10-30 06:19:51 +01:00
dynamic.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
fifo_buffer.c Move dependencies out of fifo_buffer.h 2014-10-21 02:48:51 +02:00
fifo_buffer.h Move dependencies out of fifo_buffer.h 2014-10-21 02:48:51 +02:00
file_ext.h Cleanups to file_ext.h 2014-08-30 04:34:41 +02:00
file_extract.c Move file_path.c to libretro SDK 2014-10-22 00:23:06 +02:00
file_extract.h file_extract.h - take out dependency on file.h 2014-10-21 18:49:17 +02:00
file_ops.c Move file_path.c to libretro SDK 2014-10-22 00:23:06 +02:00
file_ops.h Move file_path.c to libretro SDK 2014-10-22 00:23:06 +02:00
general.c Take out dynamic.h header include from general.h 2014-10-22 04:27:51 +02:00
general.h (Menu) Add stub Navigation Wrap-Around options 2014-11-17 16:16:52 +01:00
git_version.c Get rid of fragile escaping shenanigans. 2014-10-23 19:20:33 +02:00
git_version.h Style cleanups 2014-09-07 05:47:18 +02:00
hash.c Move miscellaneous header over to libretro SDK 2014-10-21 08:39:37 +02:00
hash.h Move compat/ over to libretro SDK 2014-10-21 07:58:58 +02:00
libretro_private.h Style / indent nits 2014-09-09 18:31:44 +02:00
libretro_version_1.c Take out dynamic.h header include from general.h 2014-10-22 04:27:51 +02:00
libretro.h RETRO_ENVIRONMENT_GET_LANGUAGE - Fixup note in libretro.h - takes 2014-09-07 17:31:36 +02:00
Makefile Add rm -f *.d to Makefile clean targets 2014-11-18 16:01:36 +01:00
Makefile.common Move menu code up one root dir 2014-10-28 19:54:23 +01:00
Makefile.emscripten Add rm -f *.d to Makefile clean targets 2014-11-18 16:01:36 +01:00
Makefile.griffin Update default shader dir - becomes media/shaders_cg 2014-10-29 07:44:06 +01:00
Makefile.openpandora Move resampler drivers to audio/resamplers 2014-09-09 21:54:41 +02:00
Makefile.pandora
Makefile.ps3 Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
Makefile.ps3.cobra (OSK) Get rid of HAVE_OSK ifdef 2014-08-14 06:40:33 +02:00
Makefile.ps3.rgl Move miscellaneous header over to libretro SDK 2014-10-21 08:39:37 +02:00
Makefile.ps3.salamander Update Salamander targets/Android 2014-10-22 03:42:07 +02:00
Makefile.psl1ght Move netlogger code around 2014-06-01 16:09:12 +02:00
Makefile.psp1 Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
Makefile.psp1.salamander Update Salamander targets/Android 2014-10-22 03:42:07 +02:00
Makefile.wii.salamander Update Salamander targets/Android 2014-10-22 03:42:07 +02:00
Makefile.win Add rm -f *.d to Makefile clean targets 2014-11-18 16:01:36 +01:00
Makefile.xenon
message_queue.c Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
message_queue.h Cleanups - 80-char limit 2014-09-02 05:32:04 +02:00
movie.c Cleanups - C-style comments, 80-char limit 2014-09-03 06:14:13 +02:00
movie.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
netplay_compat.h Cleanups, 80-char limit 2014-09-02 16:13:42 +02:00
netplay.c Rewrite netplay_flip_port 2014-10-21 01:04:57 +02:00
netplay.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
patch.c Move compat/ over to libretro SDK 2014-10-21 07:58:58 +02:00
patch.h Cleanups, 80-char limit 2014-09-02 05:10:54 +02:00
performance.c performance.c - rename 'time' variable to avoid declaration shadowing 2014-10-22 07:24:37 +02:00
performance.h Style cleanups 2014-09-07 05:47:18 +02:00
playlist.c Reduce header includes 2014-10-21 19:07:14 +02:00
playlist.h Cleanups - 80-char limit 2014-09-02 05:32:04 +02:00
rarch_compr_file_path.c Move file_path.c to libretro SDK 2014-10-22 00:23:06 +02:00
rarch_compr_file_path.h Move file_path.c to libretro SDK 2014-10-22 00:23:06 +02:00
README-exynos.md exynos: update TODO list 2014-08-09 16:43:48 +02:00
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-08-20 13:22:00 +02:00
retro.h Move flush_audio to libretro_version_1.c as static function 2014-10-02 23:43:28 +02:00
retroarch_logger.h retroarch_logger: Fix linux build 2014-09-13 20:22:16 -04:00
retroarch-mingw-build.sh Add support for different "make" binaries 2014-07-30 01:14:57 +02:00
retroarch.c (Menu) Ensure VSync is on after context reconfiguration 2014-11-13 15:17:29 -03:00
retroarch.cfg (Menu) Add stub Navigation Wrap-Around options 2014-11-17 16:16:52 +01:00
rewind.c rewind: Change tabs to spaces 2014-09-23 08:16:54 -04:00
rewind.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
runloop.c rarch_main_command actually does the pause toggling now 2014-10-29 05:54:29 +01:00
screenshot.c Move file_path.c to libretro SDK 2014-10-22 00:23:06 +02:00
screenshot.h Start properly implementing libretro SDK for boolean.h include 2014-10-21 05:05:52 +02:00
settings_data.c Move more code to settings_data.c 2014-11-20 02:44:30 +01:00
settings_data.h Add prototype to settings_data.h 2014-11-15 00:21:16 +01:00
settings_list.c Rename local variables named 'index' elsewhere 2014-10-20 19:22:33 +02:00
settings_list.h Add Archive Options 2014-11-14 14:54:20 +01:00
settings.c (Apple) Start making camera driver OSX-compatible (OSX 10.7 and up/requires AVFoundation) 2014-11-18 18:04:17 +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 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. 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.