Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2018-01-20 13:01:48 -06:00
.github
.vscode
audio Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
bootstrap
camera Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
cheevos Try to prevent more null pointer dereferences; more general cleanups 2018-01-19 19:15:05 +01:00
cores Add libretro-mpv 2018-01-15 01:38:05 +01:00
ctr
defines (D3D8) can now render content frame, rgui and overlays. 2018-01-17 07:10:45 +01:00
deps Cleanups 2018-01-07 14:52:26 +01:00
dist-scripts (3DS) Try to silence warning/error 2018-01-18 04:54:21 +01:00
docs
emscripten emscripten: Use argument list for Module.print 2018-01-15 10:06:06 -05:00
frontend fix black frame insertion in emscripten 2018-01-20 13:01:48 -06:00
gfx fix black frame insertion in emscripten 2018-01-20 13:01:48 -06:00
griffin add joypad driver for emscripten 2018-01-14 00:15:30 -06:00
input xdk_joypad_axis - implement case 4/5 for Xbox 360 2018-01-20 19:57:14 +01:00
intl update JP translation 2018-01-19 21:04:11 -05:00
led Add frontend, battery level and memory amount detection to 3ds port 2018-01-10 16:52:32 -08:00
libretro-common Update Haiku port to allow it to build again 2018-01-20 00:19:01 -08:00
libretro-db
location Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
managers
media
memory
menu (XUI) Use new d3d format function too 2018-01-20 16:47:59 +01:00
network Start using string_is_equal predominantly 2018-01-16 22:53:38 +01:00
pkg (Xbox OG) Add HAVE_MATERIALUI / HAVE_XMB 2018-01-20 06:48:44 +01:00
qb Update Haiku port to allow it to build again 2018-01-20 00:19:01 -08:00
record Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
tasks fix display name for builtin autoconfs again 2018-01-16 22:18:28 -05:00
tools
translation Add 3DS threads 2018-01-17 14:00:57 -08:00
ui Start using string_is_equal predominantly 2018-01-16 22:53:38 +01:00
wifi Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
wii
wiiu Fix disabled HID code, add defensive programming 2018-01-18 19:57:19 -08:00
.editorconfig
.gitignore small gitignore change 2018-01-20 13:01:48 -06:00
.project
.travis.yml
autosave.h
CHANGES.md Update CHANGES.md 2018-01-20 09:32:55 +01:00
command.c fix warning. 2018-01-04 17:38:31 +01:00
command.h
config.def.h add mouse support to emscripten 2018-01-13 20:51:30 -06:00
config.def.keybinds.h
config.features.h
configuration.c Dont'default to XMB for now for Xbox 2018-01-20 06:47:46 +01:00
configuration.h Merge pull request #6027 from meepingsnesroms/master 2018-01-02 06:19:48 +01:00
configure
content.h
CONTRIBUTING.md
COPYING
core_impl.c
core_info.c
core_info.h
core_type.h
core.h
database_info.c
database_info.h
defaults.h
diff.diff
dirs.c
dirs.h
driver.c Reduce usage of string_is_not_equal_fast 2018-01-17 01:03:48 +01:00
driver.h
dynamic.c Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
dynamic.h
fetch-submodules.sh
file_path_special.c Update Haiku port to allow it to build again 2018-01-20 00:19:01 -08:00
file_path_special.h libretro-common: Clean up dependencies of file_path 2018-01-13 00:27:49 -05:00
file_path_str.c
lakka.h
list_special.c
list_special.h Fix more MSVC Griffin build errors 2017-12-30 13:35:47 +01:00
Makefile Update Haiku port to allow it to build again 2018-01-20 00:19:01 -08:00
Makefile.common Update Haiku port to allow it to build again 2018-01-20 00:19:01 -08:00
Makefile.ctr Add 3DS threads 2018-01-17 14:00:57 -08:00
Makefile.ctr.salamander Remove -a from uname 2018-01-05 09:58:10 -08:00
Makefile.emscripten no longer compile with SDL support by default 2018-01-18 22:57:46 -06:00
Makefile.griffin * Compile C code with MSVC Makefile as C instead of C++ 2018-01-01 17:38:04 +01:00
Makefile.libogc
Makefile.openpandora Start removing SINC ifdefs for individual Makefiles 2017-12-31 21:34:31 +01:00
Makefile.pandora
Makefile.ps3 Start removing SINC ifdefs for individual Makefiles 2017-12-31 21:34:31 +01:00
Makefile.ps3.cobra Start removing SINC ifdefs for individual Makefiles 2017-12-31 21:34:31 +01:00
Makefile.ps3.salamander
Makefile.psl1ght
Makefile.psp1 Start removing SINC ifdefs for individual Makefiles 2017-12-31 21:34:31 +01:00
Makefile.psp1.salamander
Makefile.switch (NSW) initial support for menu 2017-12-30 11:14:45 +01:00
Makefile.vita
Makefile.vita.salamander
Makefile.wii.salamander
Makefile.wiiu Turn off WIIU_HID on master 2018-01-19 21:58:22 -08:00
Makefile.win
movie.c
movie.h
msg_hash.c
msg_hash.h Merge pull request #6027 from meepingsnesroms/master 2018-01-02 06:19:48 +01:00
no-xib.diff
paths.c
paths.h
performance_counters.c
performance_counters.h
playlist.c
playlist.h
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md readme: Update supported platforms 2018-01-02 22:49:46 -05:00
retroarch-mingw-build.sh
retroarch.c Reduce usage of string_is_not_equal_fast 2018-01-17 01:03:48 +01:00
retroarch.cfg
retroarch.desktop
retroarch.h
setting_list.c Start using string_is_equal predominantly 2018-01-16 22:53:38 +01:00
setting_list.h
verbosity.c Update and fix API error 2018-01-17 19:30:20 +01:00
verbosity.h Remove retro_inline 2018-01-17 06:47:49 +01:00
version_git.c
version_git.h
version.all Polish up WiiU deploy scripts 2018-01-10 22:51:00 -08:00
version.dtd
version.h
wiiu-devel.properties.template Polish up WiiU deploy scripts 2018-01-10 22:51:00 -08:00

Build Status Coverity Scan Build Status

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".

XMB menu driver

rgui menu driver

glui menu driver

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.

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 Documentation Center. 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:

  • DOS
  • Windows
  • Linux
  • Emscripten
  • FreeBSD
  • NetBSD
  • OpenBSD
  • Haiku
  • MacOS X
  • PlayStation 3
  • PlayStation Portable
  • PlayStation Vita
  • Original Microsoft Xbox
  • Microsoft Xbox 360 (Libxenon/XeXDK)
  • Nintendo Wii, GameCube (Libogc)
  • Nintendo WiiU
  • Nintendo 3DS
  • Nintendo Switch
  • Raspberry Pi
  • Android
  • iOS
  • Blackberry

Dependencies (PC)

There are no true hard dependencies per se.

On Windows, RetroArch can run with only Win32 as dependency.

On Linux, there are no true dependencies. For optimal usage, the following dependencies come as recommended:

  • GL headers / Vulkan 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

Instructions for compiling and installing RetroArch can be found in the Libretro/RetroArch Documentation Center.