Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2019-03-08 12:52:23 +00:00
.github Clean up white space. 2019-02-03 16:00:50 -08:00
.vscode [discord] party & ask to join refinements 2019-02-06 22:45:05 -05:00
audio Merge branch 'master' into send_debug 2019-03-07 19:23:41 -05:00
bootstrap Clean up white space. 2019-02-03 16:00:50 -08:00
camera (Wifi/Location/Camera) Get rid of 'own driver' mechanism 2019-02-27 17:02:33 +01:00
cheevos cheevos: cancel lboards on reset 2019-02-09 23:12:06 -02:00
cheevos-new (cheevos.c) silence warnings 2019-02-23 11:36:40 +00:00
cores * The menu is now able to run at higher refresh rates than 60Hz 2019-02-27 04:44:04 +01:00
ctr Clean up white space. 2019-02-03 16:00:50 -08:00
defines
deps update copyright 2019-02-22 19:13:36 -05:00
discord fix discord launch arguments not working if RA was started from CWD or similar scenarios 2019-03-03 13:09:21 -05:00
dist-scripts Clean up white space. 2019-02-03 16:00:50 -08:00
docs
emscripten Clean up white space. 2019-02-03 16:00:50 -08:00
frontend [PS2] Some audio improvements 2019-03-06 20:11:15 +01:00
gfx Merge branch 'master' into send_debug 2019-03-07 19:23:41 -05:00
griffin griffin: fix inconsistent dll linkage warning 2019-03-01 09:09:37 -05:00
input add "Send Debug Info" option under Help 2019-03-07 19:17:54 -05:00
intl Allow core name to be hidden on history/favorites playlists (without enabling playlist sublabels) 2019-03-08 12:52:23 +00:00
led Clean up white space. 2019-02-03 16:00:50 -08:00
libretro-common [PS2] Some audio improvements 2019-03-06 20:11:15 +01:00
libretro-db Clean up white space. 2019-02-03 16:00:50 -08:00
location (Wifi/Location/Camera) Get rid of 'own driver' mechanism 2019-02-27 17:02:33 +01:00
managers First version of menu widgets (gl only) 2019-02-06 20:48:24 +01:00
media Clean up white space. 2019-02-03 16:00:50 -08:00
memory
menu Allow core name to be hidden on history/favorites playlists (without enabling playlist sublabels) 2019-03-08 12:52:23 +00:00
midi crash fix 2019-02-23 11:17:00 -05:00
network Merge pull request #7883 from GregorR/netplay-share-policy 2019-03-02 18:54:19 +01:00
pkg (OSX) Enable CoreAudio v3 driver but do not make it the default 2019-02-28 14:49:38 -05:00
ps2 [PS2] Some audio improvements 2019-03-06 20:11:15 +01:00
qb qb: Fix the HAVE_OPENGLES check. 2019-02-13 09:51:49 -08:00
record fix streaming 2019-03-05 14:34:03 -05:00
runahead Fix warning with CXX_BUILD. 2019-02-08 09:57:26 -08:00
samples/tasks/database Clean up white space. 2019-02-03 16:00:50 -08:00
tasks Merge branch 'master' into send_debug 2019-03-07 19:23:41 -05:00
tools Clean up white space. 2019-02-03 16:00:50 -08:00
translation Clean up white space. 2019-02-03 16:00:50 -08:00
ui Qt: use native separators when loading content from file browser. 2019-03-04 17:27:58 +01:00
uwp (UWP) Buildfix 2019-02-11 23:15:11 +01:00
wifi (Wifi/Location/Camera) Get rid of 'own driver' mechanism 2019-02-27 17:02:33 +01:00
wii Clean up white space. 2019-02-03 16:00:50 -08:00
wiiu Clean up white space. 2019-02-03 16:00:50 -08:00
.editorconfig
.gitignore Add core info to gitignore 2019-02-06 00:54:01 +01:00
.project
.travis.yml travis: Update to xcode10.1. 2019-01-21 23:39:05 -08:00
10bpc-gl.diff Clean up white space. 2019-02-03 16:00:50 -08:00
AUTHORS.h
autosave.h
CHANGES.md Invert colors in the driver and add automatic-inverted theme 2019-02-01 15:06:33 -03:00
command.c C89_BUILD buildfix 2019-03-07 06:46:39 +01:00
command.h update copyright 2019-02-22 19:13:36 -05:00
config.def.h Allow core name to be hidden on history/favorites playlists (without enabling playlist sublabels) 2019-03-08 12:52:23 +00:00
config.def.keybinds.h update copyright 2019-02-22 19:13:36 -05:00
config.features.h (Apple) Get rid of HAVE_CORELOCATION/HAVE_AVFOUNDATION - was mostly dormant 2019-02-07 04:03:52 +01:00
configuration.c Allow core name to be hidden on history/favorites playlists (without enabling playlist sublabels) 2019-03-08 12:52:23 +00:00
configuration.h Allow core name to be hidden on history/favorites playlists (without enabling playlist sublabels) 2019-03-08 12:52:23 +00:00
configure qb: Create qb.init.sh. 2019-01-26 14:41:37 -08:00
content.h update copyright 2019-02-22 19:13:36 -05:00
CONTRIBUTING.md Convert to linux line endings. 2019-02-03 15:43:42 -08:00
COPYING
core_impl.c update copyright 2019-02-22 19:13:36 -05:00
core_info.c Always use core display name when populating playlists 2019-03-07 16:54:46 +00:00
core_info.h Always use core display name when populating playlists 2019-03-07 16:54:46 +00:00
core_type.h
core.h (UWP) Error if trying to use VFS on cores that don't support it 2019-01-17 11:08:05 +01:00
database_info.c null check 2019-02-28 16:56:41 -05:00
database_info.h update copyright 2019-02-22 19:13:36 -05:00
defaults.h Finalise integration of per-content runtime logs (runtime sublabels on all playlists, 'last played' timestamp added to playlist sublablels, 2019-03-01 14:06:40 +00:00
dirs.c (MSVC) Some more static code analysis warning fixes 2019-01-10 22:49:23 +01:00
dirs.h
Doxyfile
driver.h Merge driver.c and retroarch.c 2019-02-27 16:47:39 +01:00
dynamic.c Runtime logging fixes: ensure log is generated when runahead is enabled, and when closing cores 'internally' (RETRO_ENVIRONMENT_SHUTDOWN) 2019-03-04 11:33:19 +00:00
dynamic.h Header include cleanups 2019-01-20 02:26:33 +01:00
fetch-submodules.sh Clean up white space. 2019-02-03 16:00:50 -08:00
file_path_special.c Remove the zarch menu driver. 2019-02-02 22:15:10 -08:00
file_path_special.h Finalise integration of per-content runtime logs (runtime sublabels on all playlists, 'last played' timestamp added to playlist sublablels, 2019-03-01 14:06:40 +00:00
file_path_str.c Finalise integration of per-content runtime logs (runtime sublabels on all playlists, 'last played' timestamp added to playlist sublablels, 2019-03-01 14:06:40 +00:00
github-contributors.py
lakka.h
list_special.c update copyright 2019-02-22 19:13:36 -05:00
list_special.h update copyright 2019-02-22 19:13:36 -05:00
Makefile there is no need for these to be so big 2019-02-07 17:53:03 -05:00
Makefile.apple Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.classic_armv7_a7 fixed A7A7 2019-02-26 14:30:35 +00:00
Makefile.common Move runtime_file to RetroArch 2019-03-01 01:22:35 +01:00
Makefile.ctr Remove the zarch menu driver. 2019-02-02 22:15:10 -08:00
Makefile.ctr.salamander Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.emscripten
Makefile.griffin Makefile.griffin: add MMX where SSE is already defined 2019-02-18 15:29:11 -05:00
Makefile.libnx Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.libogc Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.msvc Makefile.msvc - add HAVE_OPENGL1 2019-02-16 21:39:12 +01:00
Makefile.openpandora
Makefile.orbis Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.pandora Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.ps2 [PS2] Implement Pitch support in the ps2_gfx 2019-03-03 14:08:12 +01:00
Makefile.ps3 Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.ps3.cobra Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.ps3.salamander Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.psl1ght Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.psp1
Makefile.psp1.salamander Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.switch Remove the zarch menu driver. 2019-02-02 22:15:10 -08:00
Makefile.vita
Makefile.vita.salamander
Makefile.wii.salamander Clean up white space. 2019-02-03 16:00:50 -08:00
Makefile.wiiu Remove the zarch menu driver. 2019-02-02 22:15:10 -08:00
Makefile.win Remove trailing blank lines. 2019-01-17 19:39:38 -08:00
movie.c First version of menu widgets (gl only) 2019-02-06 20:48:24 +01:00
movie.h Simplify runloop 2019-01-14 04:39:58 +01:00
msg_hash.c update copyright 2019-02-22 19:13:36 -05:00
msg_hash.h Allow core name to be hidden on history/favorites playlists (without enabling playlist sublabels) 2019-03-08 12:52:23 +00:00
no-xib.diff Clean up white space. 2019-02-03 16:00:50 -08:00
paths.c prevent null pointer deref in save/state/cheat paths 2019-01-13 12:10:47 -05:00
paths.h
performance_counters.c
performance_counters.h Remove trailing blank lines. 2019-01-17 19:39:38 -08:00
playlist.c Fix sorting of playlists with blank labels 2019-03-05 15:37:50 +00:00
playlist.h Finalise integration of per-content runtime logs (runtime sublabels on all playlists, 'last played' timestamp added to playlist sublablels, 2019-03-01 14:06:40 +00:00
README-exynos.md
README-mali_fbdev_r4p0.md Clean up white space. 2019-02-03 16:00:50 -08:00
README-OMAP.md
README.md [discord] update log messages 2019-02-07 17:58:21 -05:00
retroarch-android-debug.diff
retroarch-mingw-build.sh Clean up white space. 2019-02-03 16:00:50 -08:00
retroarch.c Merge branch 'master' into send_debug 2019-03-07 19:23:41 -05:00
retroarch.cfg add setting for screen orientation, with initial android implementation 2019-02-21 00:31:55 -05:00
retroarch.desktop
retroarch.h add "Send Debug Info" option under Help 2019-03-07 19:17:54 -05:00
runtime_file.c Add optional 'aggregate' runtime logging 2019-03-07 12:28:21 +00:00
runtime_file.h Add optional 'aggregate' runtime logging 2019-03-07 12:28:21 +00:00
setting_list.c (MSVC) Some more static code analysis warning fixes 2019-01-10 22:49:23 +01:00
setting_list.h
switch_performance_profiles.h
travis_metal_deploy.sh travis: Copy the app bundle from $TRAVIS_BUILD_DIR 2019-02-05 23:47:17 -05:00
travis-deploy-key.enc
verbosity.c (Xbox OG) Buildfixes 2019-02-07 05:42:23 +01:00
verbosity.h
version_git.c Remove trailing blank lines. 2019-01-17 19:39:38 -08:00
version_git.h Remove trailing blank lines. 2019-01-17 19:39:38 -08:00
version.all Bump to version 1.7.6 2019-01-31 23:38:10 +01:00
version.dtd Convert to linux line endings. 2019-02-03 15:43:42 -08:00
version.h
wiiu-devel.properties.template

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.

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:

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