Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
C C++ Objective-C Assembly PHP Shell Other
Permalink
Failed to load latest commit information.
.github Rename PULL_REQUEST_TEMPLATE to PULL_REQUEST_TEMPLATE.md Nov 29, 2017
.vscode Add mouse wheel support Jun 30, 2018
audio Don't adjust audio for VRR. Silence log message about it. Aug 9, 2018
bootstrap Merge pull request #5941 from frangarcj/vita-adrenaline Dec 21, 2017
camera Refactor verbosity code - try to avoid log calls if verbosity is not Jan 17, 2018
cheevos We should use strlcpy instead of strncpy Aug 13, 2018
cores Create internal_cores.h Jul 1, 2018
ctr Fix pointer type May 16, 2018
defines Get rid of d3d.h and xdk_defines.h May 14, 2018
deps Relative path include bugfix Aug 8, 2018
discord Fix relative path includes Aug 12, 2018
dist-scripts Finish buildbot fixes May 19, 2018
docs mark these as deprecated Aug 28, 2016
emscripten emscripten: Use argument list for Module.print Jan 15, 2018
frontend Set max bus & gpu clock rates Aug 2, 2018
gfx Initial work done on VS2017 solution for Android Aug 14, 2018
griffin (Griffin) Cleanup Aug 14, 2018
hakchi Add Hakchi files Jul 27, 2018
input Initial work done on VS2017 solution for Android Aug 14, 2018
intl update Japanese translation Aug 13, 2018
led Add frontend, battery level and memory amount detection to 3ds port Jan 11, 2018
libretro-common Initial work done on VS2017 solution for Android Aug 14, 2018
libretro-db Cleanups - fix warnings May 7, 2018
location Refactor verbosity code - try to avoid log calls if verbosity is not Jan 17, 2018
managers Add HAVE_MENU ifdefs Aug 14, 2018
media restore this file May 29, 2018
memory Clean up trailing whitespace Dec 12, 2017
menu bugfix: code and state not swapped Aug 14, 2018
midi Silence more warnings Jun 21, 2018
network Silence bunch of warnings Jun 21, 2018
pkg (MSVC 2017 Android) Update library name Aug 15, 2018
qb mbedtls does not support C89 so don't use HAVE_SSL for C89_BUILD Aug 13, 2018
record Revert "Turn scaler_ctx_scale_direct into inline function" Mar 14, 2018
runahead Runahead: ensure prefixed second-instance temp directory on linux Jul 18, 2018
samples/tasks/database (samples/tasks/database) Define -DHAVE_COMPRESSION Apr 10, 2018
tasks allow 7z archives to have multiple files extracted at once Aug 7, 2018
tools (D3D10/11/12) cleanups / fixes. Jan 30, 2018
translation Cleanups Jan 26, 2018
ui Qt: fix core loading after 73f2710 Aug 14, 2018
wifi Silence bunch of warnings Jun 21, 2018
wii Clean up trailing whitespace Dec 12, 2017
wiiu Updates from PR feedback (ty @aliaspider) Jun 8, 2018
.editorconfig Add EditorConfig support Sep 16, 2016
.gitignore fix bug when accessing memory address cheat setting before cheat syst… Jul 28, 2018
.project implement a way to set rewind_buffer_size via the UI Jul 13, 2018
.travis.yml Adjust travis build to only use libraries the build-server supports. Apr 27, 2018
AUTHORS.h Qt: make contributor list static Aug 10, 2018
CHANGES.md Qt: add option to update RetroArch (Windows only for now) Aug 7, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Dec 9, 2012
COPYING Add GPLv3 text I suppose. Jan 25, 2011
Makefile WIIU: cleanup and build-out of wiiu bootstrap code Jun 5, 2018
Makefile.common Qt: add option to update RetroArch (Windows only for now) Aug 7, 2018
Makefile.ctr Make build system match core format May 19, 2018
Makefile.ctr.salamander Change Retroarch to RetroArch once again for the 3ds May 27, 2018
Makefile.emscripten Revert "(3DS/Emscripten/Vita/Wiiu) Add HAVE_CHD support" Apr 22, 2018
Makefile.griffin (Wii/WiiU) Add HAVE_RUNAHEAD Apr 7, 2018
Makefile.libogc Update Aug 19, 2017
Makefile.msvc Add MIDI support Jun 16, 2018
Makefile.nintendoc Add Hakchi files Jul 27, 2018
Makefile.openpandora Start removing SINC ifdefs for individual Makefiles Dec 31, 2017
Makefile.pandora Move pandora files Sep 20, 2015
Makefile.ps3 (PS3) Add HAVE_DR_FLAC May 7, 2018
Makefile.ps3.cobra Revert "Revert "(PS3) Set GCC for PS3"" Apr 12, 2018
Makefile.ps3.salamander Revert "Revert "(PS3) Set GCC for PS3"" Apr 12, 2018
Makefile.psl1ght Remove remaining references to HAVE_FBO Nov 13, 2017
Makefile.psp1 Start removing SINC ifdefs for individual Makefiles Dec 31, 2017
Makefile.psp1.salamander Add vfs_implementation to Salamander builds Dec 14, 2017
Makefile.switch NSW: wip dynamic support May 31, 2018
Makefile.vita Revert "(3DS/Emscripten/Vita/Wiiu) Add HAVE_CHD support" Apr 22, 2018
Makefile.vita.salamander Add vfs_implementation to Salamander builds Dec 14, 2017
Makefile.wii.salamander Add vfs_implementation to Salamander builds Dec 14, 2017
Makefile.wiiu Revert "Revert "(wiiu) Use portlibs zlib and libpng"" Jun 25, 2018
Makefile.win Add MIDI support Jun 16, 2018
README-OMAP.md video_omap: more docu fixes Jan 14, 2014
README-exynos.md exynos: update TODO list Aug 9, 2014
README-mali_fbdev_r4p0.md Fix some spelling errors (pendantic info lintian warnings). Jul 21, 2016
README.md Update README.MD(Fixed) May 31, 2018
autosave.h Clean up trailing whitespace Dec 12, 2017
command.c Add resource files Aug 14, 2018
command.h Add Discord Enable option to Settings -> Privacy May 29, 2018
config.def.h Merge pull request #7042 from Tatsuya79/master Aug 10, 2018
config.def.keybinds.h Qt WIMP GUI Apr 30, 2018
config.features.h feat(apple): Metal support for macOS Jun 21, 2018
configuration.c Merge pull request #7042 from Tatsuya79/master Aug 10, 2018
configuration.h Merge pull request #7042 from Tatsuya79/master Aug 10, 2018
configure (qb) Add qb.system.sh Jun 16, 2015
content.h Change return type of content_get_subsystem_rom_id Apr 17, 2018
core.h Runahead system Mar 28, 2018
core_impl.c Close the audio driver after unloading the game to avoid blocking thr… Aug 13, 2018
core_info.c Qt WIMP GUI Apr 30, 2018
core_info.h Qt WIMP GUI Apr 30, 2018
core_type.h Start adding HAVE_MPV ifdefs Jun 20, 2018
database_info.c (database_info/task_database) Get rid of list_special dependencies Apr 10, 2018
database_info.h (database_info/task_database) Get rid of list_special dependencies Apr 10, 2018
defaults.h Add more HAVE_MPV ifdefs Jun 20, 2018
dirs.c nitpicking fix: makes shader next start at the first shader Feb 20, 2018
dirs.h Clean up trailing whitespace Dec 12, 2017
driver.c Add MIDI support Jun 16, 2018
driver.h Add MIDI support Jun 16, 2018
dynamic.c Start adding HAVE_MPV ifdefs Jun 20, 2018
dynamic.h Runahead system Mar 28, 2018
fetch-submodules.sh Add --recursive in case submodules have third-party dependencies Sep 11, 2016
file_path_special.c Merge branch 'master' into stripes Jul 22, 2018
file_path_special.h (Audio mixer) Add MP3 support as well Apr 28, 2018
file_path_str.c (Audio mixer) Add MP3 support as well Apr 28, 2018
github-contributors.py add script to fetch list of github contributors Aug 10, 2018
lakka.h Clean up trailing whitespace Dec 12, 2017
list_special.c Add MIDI support Jun 16, 2018
list_special.h Add MIDI support Jun 16, 2018
movie.c Get rid of a lot of implicit conversions Apr 9, 2018
movie.h Clean up trailing whitespace Dec 12, 2017
msg_hash.c Add more HAVE_MPV ifdefs Jun 20, 2018
msg_hash.h Merge pull request #7065 from bparker06/contrib Aug 10, 2018
no-xib.diff Add no-xib.diff Oct 13, 2015
paths.c Add more HAVE_MPV ifdefs Jun 20, 2018
paths.h Clean up trailing whitespace Dec 12, 2017
performance_counters.c more accurate rarch_timer Jun 30, 2018
performance_counters.h more accurate rarch_timer Jun 30, 2018
playlist.c Create playlist_cached functions inside playlist.c Apr 10, 2018
playlist.h Qt: add right-click option to edit playlist entries, fix bug with ext… Jul 30, 2018
retroarch-android-debug.diff add patch to enable gdb/debugging on android Mar 1, 2018
retroarch-mingw-build.sh Add support for different "make" binaries Jul 29, 2014
retroarch.c C89 buildfix Aug 10, 2018
retroarch.cfg android: add configurable setting for Sustained Performance Mode Jun 19, 2018
retroarch.desktop Making description more concrete and adding Russian translation Nov 22, 2017
retroarch.h Add HAVE_MENU ifdefs Aug 14, 2018
setting_list.c Add HAVE_MENU ifdefs Aug 14, 2018
setting_list.h Implement robust cheat searching interface with rumble features Jul 25, 2018
verbosity.c Buildfix for MSVC 2003 May 1, 2018
verbosity.h More fixes, GC pad kinda sorta works Mar 30, 2018
version.all Update to 1.7.3 May 4, 2018
version.dtd Bump to version 1.7.0 Dec 25, 2017
version.h Clean up trailing whitespace Dec 12, 2017
version_git.c Clean up trailing whitespace Dec 12, 2017
version_git.h Clean up trailing whitespace Dec 12, 2017
wiiu-devel.properties.template Implement UDP broadcast network logging on Wii U May 6, 2018

README.md

Build Status Coverity Scan Build Status

RetroArch

RetroArch is the reference frontend for the libretro API. Popular examples of implementations for this API includes video game system emulators and game engines as well as 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 to 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 binaries are currently hosted on the buildbot.

Support

To reach developers, either make an issue here on GitHub, make a thread on the forum, chat on Discord, 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.

Related projects

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 and touchscreen 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), run-ahead input latency removal, etc.

RetroArch also emphasizes being easy to integrate into various launcher frontends.

Platforms

RetroArch has been ported to the following platforms:

  • DOS
  • Windows
  • Linux
  • Emscripten (WebAssembly and JavaScript)
  • FreeBSD
  • NetBSD
  • OpenBSD
  • Haiku
  • Solaris
  • macOS (PPC, x86-32 and x86-64)
  • PlayStation 3
  • PlayStation Portable
  • PlayStation Vita
  • Original Microsoft Xbox
  • Microsoft Xbox 360 (Libxenon/XeXDK)
  • Nintendo GameCube
  • Nintendo Wii
  • Nintendo Wii U
  • Nintendo 3DS
  • Nintendo Switch
  • Nintendo NES/SNES Classic Edition
  • 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 it does not 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.

CRT 15Khz Resolution Switching

CRT SwitchRes will turn on, on the fly. However, you will need to restart RetroArch to disable it. With CRT SwitchRes enable RetroArch will start in 2560 x 480 @ 60.

If you are running Windows, before enabling the CRT SwitchRes options please make sure you have installed CRTEmudriver and installed some modelines. The minimum modelines for all games to switch correctly are:

  • 2560 x 192 @ 60.000000
  • 2560 x 200 @ 60.000000
  • 2560 x 240 @ 60.000000
  • 2560 x 224 @ 60.000000
  • 2560 x 237 @ 60.000000
  • 2560 x 256 @ 50.000000
  • 2560 x 254 @ 55.000000
  • 2560 x 448 @ 60.000000
  • 2560 x 480 @ 60.000000

Install these modelines replacing 2560 with your desired super resolution. The above resolutions are NTSC only so if you would be playing any PAL content please add PAL modelines:

  • 2560 x 192 @ 50.000000
  • 2560 x 200 @ 50.000000
  • 2560 x 240 @ 50.000000
  • 2560 x 224 @ 50.000000
  • 2560 x 288 @ 50.000000
  • 2560 x 237 @ 50.000000
  • 2560 x 254 @ 55.000000
  • 2560 x 448 @ 50.000000
  • 2560 x 480 @ 50.000000

Some games will require higher PAL resolutions which should also be installed:

  • 2560 x 512 @ 50.000000
  • 2560 x 576 @ 50.000000

Ideally install all these modelines and everything will work great.

Super Resolutions

The default super resolution is 2560. It is displayed just under the CRT switch option, which can be found in video settings. This can be changed within the retroarch.cfg. The only compatible resolutions are 1920, 2560 and 3840. Any other resolutions will be ignored and native switching will be activated.

Native Resolutions

If native resolutions are activated you will need a whole new set of modelines:

  • 512 x 240 @ 50.006977 SNESpal

  • 512 x 224 @ 50.006977 SNESpal

  • 512 x 448 @ 50.006977 SNESpal

  • 512 x 240 @ 60.098812 SNESntsc

  • 512 x 224 @ 60.098812 SNESntsc

  • 512 x 448 @ 60.098812 SNESntsc

  • 256 x 240 @ 50.006977 SNESpal

  • 256 x 448 @ 50.006977 SNESpal

  • 256 x 240 @ 60.098812 SNESntsc

  • 256 x 448 @ 60.098812 SNESntsc

  • 320 x 240 @ 59.922745 MDntsc

  • 320 x 448 @ 59.922745 MDntp

  • 320 x 480 @ 59.922745 MDntsc

  • 256 x 192 @ 59.922745 MDntsc

  • 320 x 224 @ 59.922745 MDntsc

  • 256 x 224 @ 59.922745 MDntsc

  • 320 x 288 @ 49.701458 MDpal

  • 320 x 576 @ 49.701458 MDpal

  • 256 x 192 @ 49.701458 MDpal

  • 320 x 224 @ 49.701458 MDpal

  • 320 x 240 @ 49.701458 MDpal

  • 320 x 448 @ 49.701458 MDpal

  • 320 x 480 @ 49.701458 MDpal

  • 256 x 224 @ 49.701458 MDpal

  • 256 x 288 @ 49.701458 MSYSpal

  • 256 x 240 @ 60.098812 NESntsc

  • 256 x 240 @ 50.006977 NESpal

  • 640 x 480 @ 60.130001 N64ntsc

  • 640 x 237 @ 60.130001 N64ntsc

  • 640 x 240 @ 60.130001 N64ntsc

  • 640 x 480 @ 50.000000 N64pal

  • 640 x 576 @ 50.000000 n64pal

  • 640 x 288 @ 50.000000 n64pal

  • 256 x 252 @ 49.759998 PSXpal

  • 384 x 252 @ 49.759998 PSXpal

  • 640 x 540 @ 49.759998 PSXpal

  • 320 x 252 @ 49.759998 PSXpal

  • 640 x 252 @ 49.759998 PSXpal

  • 384 x 240 @ 59.941002 PSXntsc

  • 256 x 480 @ 59.941002 PSXntsc

  • 352 x 240 @ 59.820000 Saturn/SGFX_NTSCp

  • 704 x 240 @ 59.820000 SaturnNTSCp

  • 352 x 480 @ 59.820000 SaturnNTSCi

  • 704 x 480 @ 59.820000 SaturnNTSCi

  • 352 x 288 @ 49.701458 SaturnPALp

  • 704 x 288 @ 49.701458 SaturnPALp

  • 352 x 576 @ 49.701458 SaturnPALi

  • 704 x 576 @ 49.701458 SaturnPALi

  • 240 x 160 @ 59.730000 GBA

  • 320 x 200 @ 60.000000 Doom

// Arcade

  • 400 x 254 @ 54.706841 MK
  • 384 x 224 @ 59.637405 CPS1

These modelines are more accurate giving exact hz. However, some games may have unwanted results. This is due to mid-scanline resolution changes on the original hardware. For the best results super resolutions are the way to go.

CRT resolution switching & MAME

Some arcade resolutions can be very different from consumer CRTs. There is resolution detection to ensure MAME games will be displayed in the closest available resolution but drawn at their native resolution within this resolution. Meaning that the MAME game will look just like the original hardware.

MAME ROMs that run in a vertical aspect like DoDonPachi need to be rotated within MAME before resolution switching and aspect correction will work. Do this before enabling CRT SwitchRes so that RetroArch will run in your desktop resolution. Once you have rotated any games that may need it turn CRT SwitchRes on.