Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2019-09-29 09:07:16 -06:00
.github
.vscode
audio Should not use RARCH_LOG and friends on a thread 2019-08-20 16:15:30 +02:00
bootstrap
camera/drivers
cheevos-new support for Sega CD/Saturn; reduce hash calls to server 2019-09-29 09:07:16 -06:00
cores fix gong crash 2019-09-16 16:27:34 +02:00
ctr Enable svchax in Luma3DS 8.0+ 2019-09-20 08:27:41 -07:00
defines
deps Update discord_register_linux.c 2019-08-21 04:35:37 +02:00
discord (Discord) Call Discord_RunCallbacks directly 2019-08-20 20:24:41 +02:00
dist-scripts
docs
emscripten emscripten: add hack to prevent ERRNO_CODES from being optimized away 2019-08-07 22:07:09 -05:00
frontend (Android) get_mem_free - different implementation for Android 2019-09-26 20:07:39 +02:00
gfx metal: Improve shader debugging 2019-09-25 22:36:40 +02:00
griffin menu_content.c - This file is no longer necessary 2019-09-23 04:24:00 +02:00
input (GX) Silence more warnings 2019-09-22 11:35:09 +02:00
intl Move File Manager settings to Settings 2019-09-26 21:01:59 +02:00
led
libretro-common support for Sega CD/Saturn; reduce hash calls to server 2019-09-29 09:07:16 -06:00
libretro-db Update libretro-db/README.md 2019-07-18 14:02:17 -07:00
location/drivers
managers Turn cheat_manager_free into static function 2019-09-17 01:20:30 +02:00
media
memory
menu Move File Manager settings to Settings 2019-09-26 21:01:59 +02:00
midi Midi: correct pitch bend in ALSA driver 2019-08-14 21:47:54 +02:00
network Should fix netplay for cores that use the new bitmask code 2019-08-16 16:29:18 +02:00
pkg Bump up to 1.7.9 2019-09-26 19:57:20 +02:00
ps2 Apply some improvement preparing for new toolchain (#9330) 2019-08-19 20:36:15 +02:00
qb initial network video driver, sends raw frames over TCP 2019-09-17 04:18:44 +02:00
record/drivers Use config_file_new_from_path_to_string entirely 2019-07-18 16:15:02 +02:00
reference
runahead Combine copy_load_info.c into retroarch.c 2019-07-16 01:56:09 +02:00
samples/tasks/database
shaders
shaders-hlsl
shaders-hlsl-no-opt/asm/frag
shaders-msl
shaders-no-opt/asm/frag
tasks Go back to plain strlcpy/strlcat - probably best to look at 2019-09-23 00:19:01 +02:00
tests-other
tools
ui (OSX) Simplify 2019-09-22 22:53:57 +02:00
uwp Cleanup runloop_iterate 2019-08-11 19:39:48 +02:00
wifi Cut down on some menu_widgets_ready calls 2019-08-15 13:12:15 +02:00
wii Wii: Add wiimote lightgun support 2019-09-15 00:46:02 +02:00
wiiu Fixed WiiU compilation randomly failing 2019-09-21 21:31:34 +02:00
.editorconfig
.gitignore (iOS/tvOS): IOS/tvOS build fixes: 2019-09-14 12:59:22 -07:00
.gitlab-ci.yml
.project
.travis.yml travis: Try assembleNormalRelease. 2019-07-26 13:33:11 -07:00
10bpc-gl.diff
AUTHORS.h
autosave.h
CHANGES.md Update CHANGES.md 2019-09-26 19:53:46 +02:00
command.h All these functions can be made static 2019-08-10 04:52:33 +02:00
config.def.h Switch/Vita: Set default aspect to core provided instead of 4:3 2019-09-25 13:59:35 -05:00
config.def.keybinds.h Silence -Wmissing-field-initializers warnings with clang. 2019-07-22 11:03:24 -07:00
config.features.h
configuration.c Cleanups 2019-09-24 16:22:20 +02:00
configuration.h (Ozone) Add option to toggle between static and scrolling content metadata 2019-09-23 15:33:20 +01:00
configure qb: Don't create config.log with ./configure --help. 2019-07-28 22:12:26 -07:00
content.h
CONTRIBUTING.md
COPYING
core_info.c Go back to plain strlcpy/strlcat - probably best to look at 2019-09-23 00:19:01 +02:00
core_info.h add "required hw api" to core info files, block content loading if core is incompatible with current graphics API/version 2019-07-23 22:44:45 -04:00
core_type.h
core.h Cleanups 2019-07-22 19:58:48 +02:00
database_info.c Fix database query regression 2019-09-26 13:37:58 +02:00
database_info.h
defaults.h
Doxyfile
driver.h Cleanups 2019-07-22 20:31:53 +02:00
dynamic.h Turn rarch_environment_cb into static function 2019-07-22 19:44:42 +02:00
fetch-submodules.sh
file_path_special.c Try to get rid of file_path_str 2019-09-18 18:12:57 +02:00
file_path_special.h verbosity.c - cleanups - no longer need file_path_str 2019-08-20 05:25:22 +02:00
file_path_str.c verbosity.c - cleanups - no longer need file_path_str 2019-08-20 05:25:22 +02:00
github-contributors.py
lakka.h
list_special.c Fix --disable-overlay. 2019-07-21 10:26:42 -07:00
list_special.h
Makefile Backport and rebase initial FPGA port that was done in 2017 (port 2019-09-17 08:16:50 +02:00
Makefile.apple
Makefile.classic_armv7_a7 Cleanup 2019-07-24 20:06:29 +02:00
Makefile.common menu_content.c - This file is no longer necessary 2019-09-23 04:24:00 +02:00
Makefile.ctr Update the zlib include directory paths. 2019-07-25 11:18:33 -07:00
Makefile.ctr.salamander Revert " add hashing support for PSX cheevos (bin/cue, chd, or real CD)" 2019-08-30 15:55:07 +02:00
Makefile.emscripten emscripten: add hack to prevent ERRNO_CODES from being optimized away 2019-08-07 22:07:09 -05:00
Makefile.griffin Update the zlib include directory paths. 2019-07-25 11:18:33 -07:00
Makefile.libnx (libnx/switch) Add HAVE_TRANSLATE 2019-09-12 17:59:06 +02:00
Makefile.libogc
Makefile.msvc Remove WANT_ZLIB. 2019-07-25 11:18:33 -07:00
Makefile.openpandora Remove WANT_ZLIB. 2019-07-25 11:18:33 -07:00
Makefile.orbis Update the zlib include directory paths. 2019-07-25 11:18:33 -07:00
Makefile.pandora
Makefile.ps2 Try to fix the ps2 zlib build. 2019-07-26 17:30:54 -07:00
Makefile.ps3 Get rid of unused code libdbgfont 2019-08-13 11:42:46 +02:00
Makefile.ps3.cobra Get rid of unused code libdbgfont 2019-08-13 11:42:46 +02:00
Makefile.ps3.salamander Update the zlib include directory paths. 2019-07-25 11:18:33 -07:00
Makefile.psl1ght Update the zlib include directory paths. 2019-07-25 11:18:33 -07:00
Makefile.psp1 Update the zlib include directory paths. 2019-07-25 11:18:33 -07:00
Makefile.psp1.salamander Revert " add hashing support for PSX cheevos (bin/cue, chd, or real CD)" 2019-08-30 15:55:07 +02:00
Makefile.switch Update the zlib include directory paths. 2019-07-25 11:18:33 -07:00
Makefile.vita Makefile.vita: Try to fix the build. 2019-07-26 08:49:24 -07:00
Makefile.vita.salamander Revert " add hashing support for PSX cheevos (bin/cue, chd, or real CD)" 2019-08-30 15:55:07 +02:00
Makefile.wii.salamander Revert " add hashing support for PSX cheevos (bin/cue, chd, or real CD)" 2019-08-30 15:55:07 +02:00
Makefile.wiiu Revert " add hashing support for PSX cheevos (bin/cue, chd, or real CD)" 2019-08-30 15:55:07 +02:00
Makefile.win Remove WANT_ZLIB. 2019-07-25 11:18:33 -07:00
msg_hash.c
msg_hash.h (Ozone) Add option to toggle between static and scrolling content metadata 2019-09-23 15:33:20 +01:00
no-xib.diff
paths.c Turn function static 2019-09-23 02:23:20 +02:00
paths.h Turn function static 2019-09-23 02:23:20 +02:00
performance_counters.c implement video_shader_delay setting (in ms), which delays auto-shaders 2019-08-27 16:01:48 +02:00
performance_counters.h implement video_shader_delay setting (in ms), which delays auto-shaders 2019-08-27 16:01:48 +02:00
playlist.c Start using return values of fill_pathname_ functions 2019-09-21 00:22:40 +02:00
playlist.h Enable customisation of runtime 'last played' display format 2019-09-10 16:14:38 +01:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md
retroarch-android-debug.diff
retroarch-mingw-build.sh
retroarch.c Combine RARCH_LOG/RARCH_ERR messages 2019-09-24 08:24:19 +02:00
retroarch.cfg
retroarch.desktop
retroarch.h Create video_driver_display_userdata_{set/get} 2019-09-22 07:35:05 +02:00
runtime_file.c Go back to plain strlcpy/strlcat - probably best to look at 2019-09-23 00:19:01 +02:00
runtime_file.h Enable customisation of runtime 'last played' display format 2019-09-10 16:14:38 +01:00
setting_list.h (Menu settings) Turn function static and some style nits 2019-08-20 03:44:17 +02:00
switch_performance_profiles.h
translation_defines.h Remove unfinished translation files 2019-09-08 20:14:23 -07:00
travis_metal_deploy.sh Update travis_metal_deploy.sh 2019-08-27 16:31:23 +02:00
travis-deploy-key.enc
verbosity.c Buffer more before we send text to be logged to stderr/stdout 2019-09-19 05:50:26 +02:00
verbosity.h Buffer more before we send text to be logged to stderr/stdout 2019-09-19 05:50:26 +02:00
version_git.c
version_git.h
version.all Bump up to 1.7.9 2019-09-26 19:57:20 +02:00
version.dtd
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.