Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2014-04-19 19:32:49 -07:00
android Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
apple Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
audio Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
blackberry-qnx Move device enums outside of driver.h - and create new callback 2014-04-17 20:47:43 +02:00
camera [Android] Add support for GLES3 HW render. 2014-04-14 13:17:05 +02:00
compat
conf
console
deps/rzlib
dist-scripts (RARCH_CONSOLE) Fix whole archive linking for NXEngine cores 2014-04-17 18:10:04 +02:00
docs Allow toggling available device types in RGUI. 2014-04-12 14:12:06 +02:00
emscripten
frontend (PPC) Build fix 2014-04-19 21:40:42 +02:00
gfx (SoftFilter) Makefile - can compile filters now on OSX 2014-04-19 20:46:05 +02:00
griffin (SoftFilters) Port EPX to SoftFilter spec - RGB565 only for now 2014-04-17 17:21:35 +02:00
gx (GX) Fix warnings 2014-04-17 20:53:31 +02:00
input Move device enums outside of driver.h - and create new callback 2014-04-17 20:47:43 +02:00
libretro-test Allow toggling available device types in RGUI. 2014-04-12 14:12:06 +02:00
libretro-test-gl [Android] Add support for GLES3 HW render. 2014-04-14 13:17:05 +02:00
location
logger
media
msvc (MSVC) Add CC resampler to MSVC solution as well 2014-04-19 19:32:49 -07:00
ngc
pandora
performance
ps3 Move device enums outside of driver.h - and create new callback 2014-04-17 20:47:43 +02:00
psp Move device enums outside of driver.h - and create new callback 2014-04-17 20:47:43 +02:00
psp1 (PSP) some improvements to the video driver 2014-03-17 00:22:13 +01:00
qb Check presence of avutil/channel_layout.h. 2014-04-01 00:09:18 +02:00
record Check presence of avutil/channel_layout.h. 2014-04-01 00:09:18 +02:00
thread
tools Add gas-preprocessor.pl to tools/ 2014-04-17 21:15:05 +02:00
wii (Wii) Bump up version 2014-03-10 03:39:19 +01:00
xdk Add HW context support to X/EGL and KMS/EGL. 2014-04-19 16:06:25 +02:00
xenon
.empty
.gitignore
.project
AUTHORS
autosave.c Initial take on subsystems support. 2014-04-04 14:58:42 +02:00
autosave.h
boolean.h
cheats.c
cheats.h
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 Make video_shared_context an option. 2014-04-19 16:37:39 +02:00
config.features.h
configure
CONTRIBUTING.md
COPYING
core_options.c
core_options.h
driver_funcs.h
driver.c (Console) Bakes in filters now for ifndef HAVE_DYLIB targets 2014-04-16 03:33:10 +02:00
driver.h Move device enums outside of driver.h - and create new callback 2014-04-17 20:47:43 +02:00
dynamic_dummy.c
dynamic_dummy.h
dynamic.c Log appropriate controller index. 2014-04-12 19:06:37 +02:00
dynamic.h Begin implementing SET_CONTROLLER_INFO. 2014-04-12 13:22:24 +02:00
fifo_buffer.c
fifo_buffer.h
file_ext.h
file_extract.c Add support for ZIP extraction to temporary folders. 2014-04-04 17:33:19 +02:00
file_extract.h Add support for ZIP extraction to temporary folders. 2014-04-04 17:33:19 +02:00
file_path.c Small bugfix and docs fix. 2014-04-04 15:13:44 +02:00
file_path.h Small bugfix and docs fix. 2014-04-04 15:13:44 +02:00
file.c Warning fix. 2014-04-14 12:09:04 +02:00
file.h Initial take on subsystems support. 2014-04-04 14:58:42 +02:00
general.h Make video_shared_context an option. 2014-04-19 16:37:39 +02:00
git_version.c
git_version.h
hash.c
hash.h
libretro_private.h
libretro.h Add some testing of new controller info API to libretro-test. 2014-04-12 13:59:19 +02:00
Makefile Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
Makefile.emscripten Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
Makefile.griffin Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
Makefile.openpandora
Makefile.pandora
Makefile.ps3 Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
Makefile.ps3.cobra
Makefile.ps3.rgl
Makefile.ps3.salamander
Makefile.psl1ght
Makefile.psp1 Add resampler tests for CC resampler. 2014-03-23 14:27:31 +01:00
Makefile.wii.salamander
Makefile.win Add HAVE_CC_RESAMPLER to nearly all targets 2014-04-20 04:17:18 +02:00
Makefile.xenon
message_queue.c
message_queue.h
miscellaneous.h Also include msvc_compat.h in misc.h. 2014-03-27 21:47:19 +01:00
movie.c
movie.h
netplay_compat.h
netplay.c
netplay.h
patch.c
patch.h
performance.c (Apple) Style nits 2014-04-19 20:16:29 +02:00
performance.h Autodetect number of CPU cores for softfilter. 2014-04-15 17:55:40 +02:00
README-lima.md
README-OMAP.md
README.md
retroarch_logger.h
retroarch-mingw-build.sh
retroarch.c Compile in filters for console ports (HAVE_DYLIB not defined in 2014-04-16 02:09:09 +02:00
retroarch.cfg Make video_shared_context an option. 2014-04-19 16:37:39 +02:00
rewind.c
rewind.h
screenshot.c
screenshot.h
settings.c (HAVE_FILTERS_BUILTIN) Save filter_index to config file now 2014-04-20 03:34:26 +02:00
thread.c
thread.h

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.