Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Themaister 6eb349dca6 Remove passing around video_data inside RGUI.
Makes very little sense to add cruft to the interface
when it also risks using an invalidated video_data ...
2014-03-25 10:19:02 +01:00
android (Android) Set min SDK version back to 9 2014-03-17 19:07:24 +01:00
apple Update views.h 2014-03-10 19:46:24 +01:00
audio Add resampler tests for CC resampler. 2014-03-23 14:27:31 +01:00
blackberry-qnx Move core_info to frontend/info. 2014-03-01 11:53:04 +01:00
camera Update years on all license headers 2014-01-01 01:50:59 +01:00
compat Update years on all license headers 2014-01-01 01:50:59 +01:00
conf Update years on all license headers 2014-01-01 01:50:59 +01:00
console Update years on all license headers 2014-01-01 01:50:59 +01:00
deps/rzlib (PSP) gzguts.h - build fix 2014-02-11 16:12:50 +01:00
dist-scripts (PSP1) Add rm ../retroarchpsp.elf to psp1-cores.sh 2014-02-22 22:43:47 +01:00
docs Remove completely obsoleted "XML map" support. 2014-01-02 16:01:43 +01:00
emscripten Include boolean.h instead of stdbool.h 2014-02-11 07:49:15 +01:00
frontend Remove passing around video_data inside RGUI. 2014-03-25 10:19:02 +01:00
gfx (D3D) Don't add Direct3D to window title 2014-03-16 14:50:09 +01:00
griffin Add resampler tests for CC resampler. 2014-03-23 14:27:31 +01:00
gx (GX) Don't clear analog_state at start of gx_poll 2014-02-28 05:14:58 +01:00
input Move image files to gfx/image/ 2014-02-25 21:24:15 +01:00
libretro-test Clarify check_variables(). 2014-02-23 23:04:18 +01:00
libretro-test-gl Add OPENGLES3 context support in libretro GL. 2013-12-13 14:20:49 +01:00
location Update years on all license headers 2014-01-01 01:50:59 +01:00
logger (XDK1) Fix RARCH_LOG/RARCH_WARN/RARCH_ERR - will need some 2014-01-11 12:04:16 +01:00
media (XUI) Fix SD menu layout 2014-03-06 01:51:26 +01:00
msvc Build fix MinGW. 2014-03-09 15:49:20 +01:00
ngc (Griffin) Take out ifndef HW_RVL out of ngc/ssaram.c - already guarded against 2013-07-28 20:15:26 +02:00
pandora List all special keys in sample configuration file. 2014-01-08 21:11:09 -08:00
performance (Logger) Some changes 2013-11-27 23:36:46 +01:00
ps3 (PS3/XDK) Custom bind fixes 2014-02-28 01:08:16 +01:00
psp (PSP) Keybinds from RGUI should work in-game now 2014-02-28 05:23:19 +01:00
psp1 (PSP) some improvements to the video driver 2014-03-17 00:22:13 +01:00
qb libavutil-dev version 1.0.8 support, requires we conditionalize the avutil/channel_layout.h include 2014-03-15 14:27:33 -04:00
record Don't have to include channel layout header. 2014-03-15 19:58:58 +01:00
thread Include boolean.h instead of stdbool.h 2014-02-11 07:49:15 +01:00
tools Update years on all license headers 2014-01-01 01:50:59 +01:00
wii (Wii) Bump up version 2014-03-10 03:39:19 +01:00
xdk (XDK) Build fix 2014-03-09 18:51:35 +01:00
xenon Include boolean.h instead of stdbool.h 2014-02-11 07:49:15 +01:00
.empty initial new branch 2011-11-30 01:07:38 +01:00
.gitignore ignore xcode workspaces 2013-12-05 00:45:38 -05:00
.project Allow to load roms from external apps. 2013-08-19 23:23:39 +02:00
AUTHORS Add myself to this list. 2014-02-21 18:15:18 +01:00
autosave.c Update years on all license headers 2014-01-01 01:50:59 +01:00
autosave.h Update years on all license headers 2014-01-01 01:50:59 +01:00
boolean.h Expand boolean.h 2014-02-11 07:52:10 +01:00
cheats.c Update years on all license headers 2014-01-01 01:50:59 +01:00
cheats.h Update years on all license headers 2014-01-01 01:50:59 +01:00
command.c Check command interface in rarch_input_poll. 2014-03-17 11:34:25 +01:00
command.h Check command interface in rarch_input_poll. 2014-03-17 11:34:25 +01:00
config.def.h (PSP) add an audio resampler using VFPU/allegrex assembly 2014-03-14 16:53:04 +01:00
config.features.h Log udev feature. 2013-12-08 16:07:14 +01:00
configure PACKAGE_VERSION is defined now in general.h for all versions 2013-07-19 16:20:14 +02: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
core_options.c Update years on all license headers 2014-01-01 01:50:59 +01:00
core_options.h Update years on all license headers 2014-01-01 01:50:59 +01:00
driver_funcs.h Small cleanup for HAVE_COMMAND. 2014-01-11 12:16:23 +01:00
driver.c (XDK) Build fix #2 2014-03-07 20:21:12 +01:00
driver.h (GX) Add experimental libsicksaxis support - doesn't work properly 2014-02-26 23:07:16 +01:00
dynamic_dummy.c Update years on all license headers 2014-01-01 01:50:59 +01:00
dynamic_dummy.h Update years on all license headers 2014-01-01 01:50:59 +01:00
dynamic.c Add log level support for libretro cores. 2014-03-01 12:02:48 +01:00
dynamic.h Update years on all license headers 2014-01-01 01:50:59 +01:00
fifo_buffer.c Update years on all license headers 2014-01-01 01:50:59 +01:00
fifo_buffer.h Update years on all license headers 2014-01-01 01:50:59 +01:00
file_ext.h (RARCH_CONSOLE) Take out 'DEFAULT_EXE_EXT' 2014-03-05 23:49:12 +01:00
file_extract.c Add rzlib to include dirs to avoid ugly ifdef for WANT_MINIZ 2014-01-10 19:46:31 +01:00
file_extract.h Update years on all license headers 2014-01-01 01:50:59 +01:00
file_path.c Join core info lists with new string_list_join_concat(). 2014-03-04 10:17:00 +01:00
file_path.h Join core info lists with new string_list_join_concat(). 2014-03-04 10:17:00 +01:00
file.c Remove completely obsoleted "XML map" support. 2014-01-02 16:01:43 +01:00
file.h Update years on all license headers 2014-01-01 01:50:59 +01:00
general.h (Menu) Add OSK enable option 2014-03-02 06:07:18 +01:00
git_version.c Make C++ compiler happy. 2014-02-06 22:52:48 +01:00
git_version.h Make C++ compiler happy. 2014-02-06 22:52:48 +01:00
hash.c Fix some unused function warnings. 2014-01-22 16:39:39 +01:00
hash.h Add rzlib to include dirs to avoid ugly ifdef for WANT_MINIZ 2014-01-10 19:46:31 +01:00
libretro_private.h Update years on all license headers 2014-01-01 01:50:59 +01:00
libretro.h Add GET_PROC_ADDRESS interface. 2014-03-22 12:34:30 +01:00
Makefile Cleanups to keyboard callback stuff. 2014-03-02 11:45:41 +01:00
Makefile.emscripten (Menu) Split up keyboard input line cb code to separate file - menu_input_line_cb 2014-03-02 05:24:57 +01:00
Makefile.griffin (GX) Add experimental libsicksaxis support - doesn't work properly 2014-02-26 23:07:16 +01:00
Makefile.openpandora Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
Makefile.pandora (Pandora) planning to use retroarch-zip later 2012-09-18 17:26:16 -04:00
Makefile.ps3 (PS3) Change HAVE_RGL to HAVE_GCMGL 2014-02-25 22:01:46 +01:00
Makefile.ps3.cobra (PS3) Change HAVE_RGL to HAVE_GCMGL 2014-02-25 22:01:46 +01:00
Makefile.ps3.rgl (PS3) Change HAVE_RGL to HAVE_GCMGL 2014-02-25 22:01:46 +01:00
Makefile.ps3.salamander Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
Makefile.psl1ght (PS3) Change HAVE_RGL to HAVE_GCMGL 2014-02-25 22:01:46 +01:00
Makefile.psp1 Add resampler tests for CC resampler. 2014-03-23 14:27:31 +01:00
Makefile.wii.salamander (Salamander) GX build fix 2013-07-27 21:50:20 +02:00
Makefile.win Build fix MinGW. 2014-03-09 15:49:20 +01:00
Makefile.xenon Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
message_queue.c Update years on all license headers 2014-01-01 01:50:59 +01:00
message_queue.h Update years on all license headers 2014-01-01 01:50:59 +01:00
miscellaneous.h (PSP) Build fixes 2014-02-11 16:10:40 +01:00
movie.c Update years on all license headers 2014-01-01 01:50:59 +01:00
movie.h Update years on all license headers 2014-01-01 01:50:59 +01:00
netplay_compat.h (360) netplay_compat - 360 build fixes 2014-02-11 13:19:18 +01:00
netplay.c Update years on all license headers 2014-01-01 01:50:59 +01:00
netplay.h Update years on all license headers 2014-01-01 01:50:59 +01:00
patch.c Update years on all license headers 2014-01-01 01:50:59 +01:00
patch.h Update years on all license headers 2014-01-01 01:50:59 +01:00
performance.c (GX) Add RETRO_SIMD_PS (Paired single) to performance.c/libretro.h 2014-03-08 05:00:52 +01:00
performance.h Don't redefine HAVE_NEON 2014-03-03 23:58:45 +01:00
README-lima.md video_lima: be more explicit about limare dependencies in the docs 2014-03-06 16:04:47 +01:00
README-OMAP.md video_omap: more docu fixes 2014-01-14 16:39:24 -06:00
README.md Reword README.md and rewrite 'game' strings 2013-11-26 23:09:12 +01:00
retroarch_logger.h Update years on all license headers 2014-01-01 01:50:59 +01:00
retroarch-mingw-build.sh Disable SSE in 32-bit Win32 Mingw build. 2013-09-27 00:11:32 +02:00
retroarch.c Check command interface in rarch_input_poll. 2014-03-17 11:34:25 +01:00
retroarch.cfg config skeleton: default value of config_save_on_exit changed 2014-03-06 17:46:32 +01:00
rewind.c Nit in comment. 2014-02-23 11:13:05 +01:00
rewind.h Declare this one constant. Altering it will make further pulls yield garbage. 2014-02-21 21:51:58 +01:00
screenshot.c Update years on all license headers 2014-01-01 01:50:59 +01:00
screenshot.h Update years on all license headers 2014-01-01 01:50:59 +01:00
settings.c (XDK) Look for driver 'd3d' instead of 'xdk_d3d' 2014-03-07 21:24:43 +01:00
thread.c (PSP) Compile in -lpthreads-psp 2014-02-17 19:30:21 +01:00
thread.h Update years on all license headers 2014-01-01 01:50:59 +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 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.