Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Themaister 08ba1ad14e Use GL_RGB565 internal format when available.
This is a feature from ES2_compat extension.
It fixes the speed issue associated with using 16-bit textures on
desktop GL. Improves performance a bit as well as there's less bandwidth
usage during shading.

On my HD3000 laptop, performance improved with ~10%.
2014-01-01 21:58:02 +01:00
android Update years on all license headers 2014-01-01 01:50:59 +01:00
apple Update years on all license headers 2014-01-01 01:50:59 +01:00
audio Update years on all license headers 2014-01-01 01:50:59 +01:00
blackberry-qnx Update years on all license headers 2014-01-01 01:50:59 +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 (Xbox 1) Build fixes 2013-11-11 03:36:30 +01:00
dist-scripts (RARCH_CONSOLE) Append _libretro_{platform} to static core executables 2013-11-02 04:36:30 +01:00
docs Use skeleton config as basis for new configs. 2013-10-04 15:38:57 +02:00
emscripten Update years on all license headers 2014-01-01 01:50:59 +01:00
frontend Update years on all license headers 2014-01-01 01:50:59 +01:00
gfx Use GL_RGB565 internal format when available. 2014-01-01 21:58:02 +01:00
griffin Update years on all license headers 2014-01-01 01:50:59 +01:00
gx Update years on all license headers 2014-01-01 01:50:59 +01:00
input Update years on all license headers 2014-01-01 01:50:59 +01:00
libretro-test Use logging interface in libretro-test. 2013-12-09 10:59:17 +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 Update years on all license headers 2014-01-01 01:50:59 +01:00
media Merge pull request #456 from hizzlekizzle/master 2014-01-01 09:49:05 -08:00
msvc (D3D) Shouldn't need ifdef __cplusplus - extern "C" anymore 2014-01-01 02:58:19 +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 Revert "More scrubbing (pt. 2)" 2013-04-06 03:52:58 +02:00
performance (Logger) Some changes 2013-11-27 23:36:46 +01:00
ps3 Update years on all license headers 2014-01-01 01:50:59 +01:00
psp Update years on all license headers 2014-01-01 01:50:59 +01:00
psp1 Update years on all license headers 2014-01-01 01:50:59 +01:00
qb Make GLES3 optional in ./configure. 2013-12-13 21:37:22 +01:00
record Update years on all license headers 2014-01-01 01:50:59 +01:00
thread Update years on all license headers 2014-01-01 01:50:59 +01:00
tools Update years on all license headers 2014-01-01 01:50:59 +01:00
wii Bump up version to 0.9.9.7 2013-12-13 01:14:08 +01:00
xdk Update years on all license headers 2014-01-01 01:50:59 +01:00
xenon Update years on all license headers 2014-01-01 01:50:59 +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 OMAP graphics driver (Tobias Jakobi) 2013-07-28 18:37:31 +02: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 Update years on all license headers 2014-01-01 01:50:59 +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 Update years on all license headers 2014-01-01 01:50:59 +01:00
command.h Update years on all license headers 2014-01-01 01:50:59 +01:00
config.def.h Update years on all license headers 2014-01-01 01:50:59 +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_info.c Update years on all license headers 2014-01-01 01:50:59 +01:00
core_info.h Update years on all license headers 2014-01-01 01:50:59 +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 Update years on all license headers 2014-01-01 01:50:59 +01:00
driver.c Update years on all license headers 2014-01-01 01:50:59 +01:00
driver.h Update years on all license headers 2014-01-01 01:50:59 +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 Update years on all license headers 2014-01-01 01:50:59 +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 Update years on all license headers 2014-01-01 01:50:59 +01:00
file_extract.c Update years on all license headers 2014-01-01 01:50:59 +01:00
file_extract.h Update years on all license headers 2014-01-01 01:50:59 +01:00
file_list.c Update years on all license headers 2014-01-01 01:50:59 +01:00
file_list.h Update years on all license headers 2014-01-01 01:50:59 +01:00
file_path.c Update years on all license headers 2014-01-01 01:50:59 +01:00
file_path.h Update years on all license headers 2014-01-01 01:50:59 +01:00
file.c Update years on all license headers 2014-01-01 01:50:59 +01:00
file.h Update years on all license headers 2014-01-01 01:50:59 +01:00
general.h Bump up version number 2014-01-01 01:52:07 +01:00
hash.c Update years on all license headers 2014-01-01 01:50:59 +01:00
hash.h Update years on all license headers 2014-01-01 01:50:59 +01:00
libretro_private.h Update years on all license headers 2014-01-01 01:50:59 +01:00
libretro.h Update years on all license headers 2014-01-01 01:50:59 +01:00
Makefile (MSVC) Builds again 2013-12-31 22:10:58 +01:00
Makefile.emscripten [EMSCRIPTEN] build fix 2013-12-29 16:19:15 -05:00
Makefile.ngc Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +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 Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
Makefile.ps3.rgl Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
Makefile.ps3.salamander Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
Makefile.psl1ght Remove HAVE_FILEBROWSER/remove file_browser.c 2013-11-11 04:12:30 +01:00
Makefile.psp1 Add RETRO_ENVIRONMENT_GET_PERF_INTERFACE to libretro.h 2013-12-17 19:10:40 +01:00
Makefile.shaders Makefile.shaders - now checks out shaders on OSX 2013-05-29 12:57:20 +02:00
Makefile.wii fix logging on consoles 2013-12-22 16:42:03 -05:00
Makefile.wii.salamander (Salamander) GX build fix 2013-07-27 21:50:20 +02:00
Makefile.win (D3D) Rename video_d3d9 to video_d3d 2014-01-01 01:09:31 +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 Update years on all license headers 2014-01-01 01:50:59 +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 Update years on all license headers 2014-01-01 01:50:59 +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 Update years on all license headers 2014-01-01 01:50:59 +01:00
performance.h Update years on all license headers 2014-01-01 01:50:59 +01:00
README-OMAP.md video_omap: add some documentation on how to use the driver 2013-12-07 23:56:04 +01: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 Update years on all license headers 2014-01-01 01:50:59 +01:00
retroarch.cfg Refactor content_directory. 2013-12-26 02:03:11 +01:00
rewind.c Update years on all license headers 2014-01-01 01:50:59 +01:00
rewind.h Update years on all license headers 2014-01-01 01:50:59 +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 Update years on all license headers 2014-01-01 01:50:59 +01:00
thread.c Update years on all license headers 2014-01-01 01:50:59 +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.