Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2019-04-03 13:31:45 +02:00
.github Clean up white space. 2019-02-03 16:00:50 -08:00
.vscode ozone: use menu_thumbnail for thumbnails 2019-03-14 16:56:07 +01: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 C89 buildfixes 2019-03-24 18:15:26 +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 Remove the parallel compilation for PS2 in the dist-scripts 2019-03-20 22:32:12 +01:00
docs
emscripten Clean up white space. 2019-02-03 16:00:50 -08:00
frontend More 'Log to File' Additions: 2019-03-25 17:22:59 +00:00
gfx gfx video filters: blargg ntsc snes conflicts 2019-03-23 20:22:21 -05:00
griffin Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00:00
input use proper scaled radial deadzone calculation 2019-03-29 14:07:35 -04:00
intl (RGUI) Add optional shadow effects 2019-04-01 13:54:59 +01:00
led Clean up white space. 2019-02-03 16:00:50 -08:00
libretro-common (OSX) Silence warnings 2019-04-03 13:31:45 +02: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 (OSX) Silence warnings 2019-04-03 13:31:45 +02: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 Merge pull request #8486 from huwpascoe/rxml 2019-03-23 03:25:32 +01:00
ps2 fix issues executing makefile in a bash script 2019-03-17 13:36:40 +01:00
qb Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00:00
record Update record_ffmpeg.c 2019-04-02 08:47:35 -05:00
runahead Cleanups 2019-03-11 18:33:24 +01:00
samples/tasks/database Clean up white space. 2019-02-03 16:00:50 -08:00
tasks More 'Log to File' Additions: 2019-03-25 17:22:59 +00: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: fix shader file filter 2019-03-13 16:18:24 -04: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 Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00: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 Merge branch 'master' into orbis2 2019-01-08 20:18:08 +01:00
autosave.h
CHANGES.md update JP translation 2019-03-20 21:20:59 -04:00
command.c (command.c) Silence warning in C89 build 2019-03-14 16:12:56 +00:00
command.h add hotkey to toggle netplay hosting 2019-03-09 17:48:03 -05:00
config.def.h (RGUI) Add optional shadow effects 2019-04-01 13:54:59 +01:00
config.def.keybinds.h add hotkey to toggle netplay hosting 2019-03-09 17:48:03 -05:00
config.features.h Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00:00
configuration.c (RGUI) Add optional shadow effects 2019-04-01 13:54:59 +01:00
configuration.h (RGUI) Add optional shadow effects 2019-04-01 13:54:59 +01: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 easter egg 2019-01-05 18:33:29 -05:00
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 add log to file settings 2019-03-17 14:28:17 -05:00
dirs.c disable forced logging on android 2019-03-17 14:28:17 -05:00
dirs.h
Doxyfile
driver.h Merge driver.c and retroarch.c 2019-02-27 16:47:39 +01:00
dynamic.c Add a new "glcore" driver with slang support. 2019-03-09 12:30:49 +01: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 Log to file improvements 2019-03-21 16:57:54 +00:00
file_path_str.c Log to file improvements 2019-03-21 16:57:54 +00:00
github-contributors.py
lakka.h [LIBNX] Implement Over-/Downclocking and minor fixes 2018-11-29 18:42:44 +01:00
list_special.c fix camera and location dropdown lists 2019-04-01 02:07:08 +02: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 Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00: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 qb: Add '--disable-menu'. (#7910) 2019-01-06 17:30:50 -05:00
Makefile.griffin [VITA] Bluetooth mouse and keyboard support 2019-03-22 21:32:59 -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 Cleaning no needed functions and library 2019-03-15 20:19:14 +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 Squeeze extra blank lines with cat(1). 2019-01-08 11:04:58 -08:00
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 [VITA] Bluetooth mouse and keyboard support 2019-03-22 21:32:59 -05:00
Makefile.vita.salamander [VITA] Bluetooth mouse and keyboard support 2019-03-22 21:32:59 -05:00
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 Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00: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 (RGUI) Add optional shadow effects 2019-04-01 13:54:59 +01: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 easter egg 2019-01-05 18:33:29 -05:00
performance_counters.c
performance_counters.h Remove trailing blank lines. 2019-01-17 19:39:38 -08:00
playlist.c Cleanups 2019-03-11 18:33:24 +01:00
playlist.h Populate crc32 and db_name fields when adding history/favourites playlist entries 2019-03-09 13:58:53 +00:00
README-exynos.md
README-mali_fbdev_r4p0.md Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00:00
README-OMAP.md
README.md Re-enable RXML and purge libxml 2019-03-17 03:04:35 +00:00
retroarch-android-debug.diff
retroarch-mingw-build.sh Clean up white space. 2019-02-03 16:00:50 -08:00
retroarch.c (C89) Buildfixes 2019-03-29 12:39:03 +01:00
retroarch.cfg add analog deadzone and sensitivity options, rename axis threshold 2019-03-25 23:22:19 -04:00
retroarch.desktop
retroarch.h Log to file improvements 2019-03-21 16:57:54 +00:00
runtime_file.c add log to file settings 2019-03-17 14:28:17 -05: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 Fix c89 build with clang. 2018-12-16 07:02:14 -08:00
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 More 'Log to File' Additions: 2019-03-25 17:22:59 +00:00
verbosity.h Log to file improvements 2019-03-21 16:57:54 +00:00
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
  • 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.