Skip to content
Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Branch: master
Clone or download
Latest commit 5c7a5fd May 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Clean up white space. Feb 4, 2019
.vscode [Libnx] Toolchain related changes Apr 26, 2019
audio (audio_driver.c) Cleanups May 29, 2019
bootstrap Clean up white space. Feb 4, 2019
camera (Wifi/Location/Camera) Get rid of 'own driver' mechanism Feb 27, 2019
cheevos-new Cleanups - cut down on the rest of unnecessary filestream_exists calls May 31, 2019
cores gong: revert bad cleanup May 22, 2019
ctr Clean up white space. Feb 4, 2019
defines Get rid of d3d.h and xdk_defines.h May 14, 2018
deps Merge pull request #8877 from QuarkTheAwesome/build-fixes May 29, 2019
discord Cleanups - prefer path_is_valid over filestream_exists May 30, 2019
dist-scripts Remove the parallel compilation for PS2 in the dist-scripts Mar 20, 2019
docs mark these as deprecated Aug 28, 2016
emscripten Clean up white space. Feb 4, 2019
frontend (Unix/Linux) Correct parse_drive_list (potential fix) May 31, 2019
gfx Cleanups May 31, 2019
griffin do not use old cheevos implementation May 29, 2019
input wiiu/input: Uniquely name axis enum May 27, 2019
intl Add option to show/hide 'Restart RetroArch' May 30, 2019
led Clean up white space. Feb 4, 2019
libretro-common file_archive_get_file_list - file_archive_walk returns boolean type, May 31, 2019
libretro-db strlen optimizations : Apr 27, 2019
location (Wifi/Location/Camera) Get rid of 'own driver' mechanism Feb 27, 2019
managers Cleanups - cut down on the rest of unnecessary filestream_exists calls May 31, 2019
media Move `#pragma code_page(932)` into `rarch.rc`, as `#pragma code_page`… May 22, 2019
memory Clean up trailing whitespace Dec 12, 2017
menu Cleanups May 31, 2019
midi crash fix Feb 23, 2019
network do not use old cheevos implementation May 29, 2019
pkg Remove "-DHAVE_DYNAMIC" May 31, 2019
ps2 fix issues executing makefile in a bash script Mar 17, 2019
qb Disable Discord for C89 again May 28, 2019
record add apng May 28, 2019
runahead Cleanup May 29, 2019
samples/tasks/database use threads for command-line scanner if available May 22, 2019
tasks (task content) Cleanups May 31, 2019
tools Clean up white space. Feb 4, 2019
translation OCR Translation feature finaliziation. (#8738) May 11, 2019
ui (CocoaTouch Menu) Fix build May 31, 2019
uwp UWP: Improve IO performance by manually buffering short reads. Apr 27, 2019
wifi squelching benign error messages when invoking connman May 13, 2019
wii Clean up white space. Feb 4, 2019
wiiu wiiu: Make libfat/libiosuhax optional May 29, 2019
.editorconfig Add EditorConfig support Sep 16, 2016
.gitignore Add more Windows MINGW working directory stuff to gitignore Apr 8, 2019
.gitlab-ci.yml add restart menu option May 21, 2019
.project implement a way to set rewind_buffer_size via the UI Jul 13, 2018
.travis.yml Remove this Travis test for now May 31, 2019
10bpc-gl.diff Clean up white space. Feb 4, 2019
AUTHORS.h update AUTHORS.h with github-contributors script May 8, 2019
CHANGES.md Update CHANGES.md May 31, 2019
CONTRIBUTING.md Convert to linux line endings. Feb 3, 2019
COPYING Add GPLv3 text I suppose. Jan 25, 2011
Doxyfile doxygen: quiet output Oct 1, 2018
Makefile menu display: don't move scissoring rect May 27, 2019
Makefile.apple Clean up white space. Feb 4, 2019
Makefile.classic_armv7_a7 fixed A7A7 Feb 26, 2019
Makefile.common do not use old cheevos implementation May 29, 2019
Makefile.ctr We need to split up zlib headers in libretro-common to its own separate May 27, 2019
Makefile.ctr.salamander Clean up white space. Feb 4, 2019
Makefile.emscripten (Emscripten) Try to use builtin zlib May 28, 2019
Makefile.griffin (MSVC) Fix Griffin MSVC build May 27, 2019
Makefile.libnx We need to split up zlib headers in libretro-common to its own separate May 27, 2019
Makefile.libogc Clean up white space. Feb 4, 2019
Makefile.msvc UTF-8 Fix favoring MSVC 2010-2013. May 21, 2019
Makefile.openpandora video_layout build May 11, 2019
Makefile.orbis We need to split up zlib headers in libretro-common to its own separate May 27, 2019
Makefile.pandora Clean up white space. Feb 4, 2019
Makefile.ps2 (PS2) Try to use builtin zlib May 28, 2019
Makefile.ps3 We need to split up zlib headers in libretro-common to its own separate May 27, 2019
Makefile.ps3.cobra Undefine HAVE_VIDEO_LAYOUT for now instead of implicitly enabling May 12, 2019
Makefile.ps3.salamander Clean up white space. Feb 4, 2019
Makefile.psl1ght We need to split up zlib headers in libretro-common to its own separate May 27, 2019
Makefile.psp1 We need to split up zlib headers in libretro-common to its own separate May 27, 2019
Makefile.psp1.salamander Clean up white space. Feb 4, 2019
Makefile.switch We need to split up zlib headers in libretro-common to its own separate May 27, 2019
Makefile.vita (Vita) Use builtin zlib May 28, 2019
Makefile.vita.salamander [VITA] Bluetooth mouse and keyboard support Mar 23, 2019
Makefile.wii.salamander Clean up white space. Feb 4, 2019
Makefile.wiiu wiiu: Add libfat/iosuhax to Griffin, always use builtins May 29, 2019
Makefile.win We need to split up zlib headers in libretro-common to its own separate May 27, 2019
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 Re-enable RXML and purge libxml Mar 17, 2019
README.md Re-enable RXML and purge libxml Mar 17, 2019
autosave.h Clean up trailing whitespace Dec 12, 2017
command.c Cleanups - cut down on the rest of unnecessary filestream_exists calls May 31, 2019
command.h add hotkey to toggle netplay hosting Mar 9, 2019
config.def.h (config.def.h) WIP - most of these const variables should become May 31, 2019
config.def.keybinds.h add hotkey to toggle netplay hosting Mar 9, 2019
config.features.h Re-enable RXML and purge libxml Mar 17, 2019
configuration.c (configuration.c) Cleanups May 31, 2019
configuration.h Add option to show/hide 'Restart RetroArch' May 30, 2019
configure qb: Create qb.init.sh. Jan 26, 2019
content.h [subsystem] add a function to get the friendly name Apr 11, 2019
core.h (runahead) Cleanups - create core_free_game_info and move it to May 22, 2019
core_impl.c (runahead) Cleanups - create core_free_game_info and move it to May 22, 2019
core_info.c Quick buildfix May 10, 2019
core_info.h Revert "(MSVC 2003) core_info - remove all_ext from heap - fixes cras… May 10, 2019
core_type.h easter egg Jan 5, 2019
database_info.c Revert "Start using string_is_equal_memcmp and" Apr 29, 2019
database_info.h update copyright Feb 23, 2019
defaults.h video_layout config May 11, 2019
dirs.c Cleanups - prefer path_is_valid over filestream_exists May 30, 2019
dirs.h Clean up trailing whitespace Dec 12, 2017
driver.h Merge driver.c and retroarch.c Feb 27, 2019
dynamic.c do not use old cheevos implementation May 29, 2019
dynamic.h Header include cleanups Jan 20, 2019
fetch-submodules.sh Clean up white space. Feb 4, 2019
file_path_special.c Get rid of two retro_assert calls Apr 28, 2019
file_path_special.h Add playlist-based thumbnail downloader May 14, 2019
file_path_str.c Add playlist-based thumbnail downloader May 14, 2019
github-contributors.py update AUTHORS.h with github-contributors script May 8, 2019
lakka.h [LIBNX] Implement Over-/Downclocking and minor fixes Nov 29, 2018
list_special.c fix camera and location dropdown lists Apr 1, 2019
list_special.h update copyright Feb 23, 2019
movie.c First version of menu widgets (gl only) Feb 6, 2019
movie.h Simplify runloop Jan 14, 2019
msg_hash.c add initial Turkish translation from Ömercan Kömür (fpscan) Apr 17, 2019
msg_hash.h Add option to show/hide 'Restart RetroArch' May 30, 2019
no-xib.diff Clean up white space. Feb 4, 2019
paths.c (paths.c) Style nit Apr 22, 2019
paths.h easter egg Jan 5, 2019
performance_counters.c more accurate rarch_timer Jun 30, 2018
performance_counters.h Remove trailing blank lines. Jan 18, 2019
playlist.c (Samples) tasks/database - should work again May 21, 2019
playlist.h Load content runtime data 'on demand' (#8717) May 9, 2019
retroarch-android-debug.diff add patch to enable gdb/debugging on android Mar 1, 2018
retroarch-mingw-build.sh Clean up white space. Feb 4, 2019
retroarch.c (retroarch.c) Cleanups May 31, 2019
retroarch.cfg add analog deadzone and sensitivity options, rename axis threshold Mar 26, 2019
retroarch.desktop Making description more concrete and adding Russian translation Nov 22, 2017
retroarch.h Re-enable '--log-file' command line option May 17, 2019
runtime_file.c filestream_exists() -> path_is_valid() replacements May 30, 2019
runtime_file.h Load content runtime data 'on demand' (#8717) May 9, 2019
setting_list.h Remove setting_list.c and reintegrate it into menu_setting.c Apr 30, 2019
switch_performance_profiles.h lakka-switch: adding extra overclocks May 12, 2019
travis-deploy-key.enc travis: deploy OSX Metal build Sep 3, 2018
travis_metal_deploy.sh travis: Copy the app bundle from $TRAVIS_BUILD_DIR Feb 6, 2019
verbosity.c [LIBNX] Unconditional Mutex for logging Apr 29, 2019
verbosity.h Log to file improvements Mar 21, 2019
version.all Bump up version to 1.7.7 May 5, 2019
version.dtd Bump up version to 1.7.7 May 5, 2019
version.h Clean up trailing whitespace Dec 12, 2017
version_git.c Remove trailing blank lines. Jan 18, 2019
version_git.h Remove trailing blank lines. Jan 18, 2019
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
  • 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:

  • 256 x 240 @ 50.006977 SNESpal

  • 256 x 448 @ 50.006977 SNESpal

  • 512 x 224 @ 50.006977 SNESpal

  • 512 x 240 @ 50.006977 SNESpal

  • 512 x 448 @ 50.006977 SNESpal

  • 256 x 240 @ 60.098812 SNESntsc

  • 256 x 448 @ 60.098812 SNESntsc

  • 512 x 240 @ 60.098812 SNESntsc

  • 512 x 224 @ 60.098812 SNESntsc

  • 512 x 448 @ 60.098812 SNESntsc

  • 256 x 192 @ 59.922745 MDntsc

  • 256 x 224 @ 59.922745 MDntsc

  • 320 x 224 @ 59.922745 MDntsc

  • 320 x 240 @ 59.922745 MDntsc

  • 320 x 448 @ 59.922745 MDntsc

  • 320 x 480 @ 59.922745 MDntsc

  • 256 x 192 @ 49.701458 MDpal

  • 256 x 224 @ 49.701458 MDpal

  • 320 x 224 @ 49.701458 MDpal

  • 320 x 240 @ 49.701458 MDpal

  • 320 x 288 @ 49.701458 MDpal

  • 320 x 448 @ 49.701458 MDpal

  • 320 x 480 @ 49.701458 MDpal

  • 320 x 576 @ 49.701458 MDpal

  • 256 x 288 @ 49.701458 MSYSpal

  • 256 x 240 @ 60.098812 NESntsc

  • 256 x 240 @ 50.006977 NESpal

  • 640 x 237 @ 60.130001 N64ntsc

  • 640 x 240 @ 60.130001 N64ntsc

  • 640 x 480 @ 60.130001 N64ntsc

  • 640 x 288 @ 50.000000 N64pal

  • 640 x 480 @ 50.000000 N64pal

  • 640 x 576 @ 50.000000 N64pal

  • 256 x 252 @ 49.759998 PSXpal

  • 320 x 252 @ 49.759998 PSXpal

  • 384 x 252 @ 49.759998 PSXpal

  • 640 x 252 @ 49.759998 PSXpal

  • 640 x 540 @ 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.

You can’t perform that action at this time.