Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2018-05-18 00:24:19 +02:00
.github
.vscode overrides: improve 43220c088a79ca79980ff7bfcbf3f64bdb729921 a bit 2018-05-13 22:05:18 -05:00
audio Squashed 'libretro-common/' content from commit 377cef30fa 2018-05-12 17:56:33 +02:00
bootstrap
camera Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
cheevos move pause entry to achievements menu 2018-05-13 14:26:38 -05:00
cores Update libretro-mpv core - only use dlopen for HAVE_OPENGLES builds 2018-02-23 14:40:31 +01:00
ctr Fix pointer type 2018-05-16 16:28:32 -07:00
defines Get rid of d3d.h and xdk_defines.h 2018-05-14 03:57:27 +02:00
deps (PS3) Add HAVE_DR_FLAC 2018-05-07 17:52:53 +02:00
dist-scripts Implement UDP broadcast network logging on Wii U 2018-05-06 14:39:48 -07:00
docs
emscripten emscripten: Use argument list for Module.print 2018-01-15 10:06:06 -05:00
frontend Merge pull request #6782 from meepingsnesroms/master 2018-05-17 01:34:48 +02:00
gfx (D3D9 HLSL) Updates 2018-05-18 00:24:19 +02:00
griffin Integrate HLSL code into d3d9_hlsl_renderchain.c 2018-05-16 15:52:11 +02:00
input call input_remapping_set_defaults before loading a new remap 2018-05-16 13:30:57 +02:00
intl add saving, deletion options for per-dir remaps 2018-05-13 23:17:44 -05:00
led Add frontend, battery level and memory amount detection to 3ds port 2018-01-10 16:52:32 -08:00
libretro-common Merge commit '75aea8225637bb47e44543ed624f5861cb27c204' 2018-05-12 18:07:47 +02:00
libretro-db Cleanups - fix warnings 2018-05-07 15:05:59 +02:00
location Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
managers fix error 2018-05-12 22:19:42 -05:00
media Edit the Japanese resource file too 2018-05-09 21:10:11 -05:00
memory
menu Merge pull request #6775 from fr500/overrides 2018-05-14 06:23:10 +02:00
network Silence some Coverity warnings 2018-04-12 21:39:31 +02:00
pkg Make separate xcodeproj 2018-05-14 00:17:17 +02:00
qb qb: Fix checking the CXX compiler 2018-05-03 12:24:32 -07:00
record Revert "Turn scaler_ctx_scale_direct into inline function" 2018-03-14 23:48:47 +01:00
runahead Fix full-screen mode change breaking Secondary Core's environment variables 2018-05-12 22:11:49 -05:00
samples/tasks/database Squashed 'libretro-common/' content from commit 377cef30fa 2018-05-12 17:56:33 +02:00
tasks Add To Mixer and Add To Mixer And Play actions 2018-05-02 20:39:55 +02:00
tools (D3D10/11/12) cleanups / fixes. 2018-01-30 19:34:53 +01:00
translation Cleanups 2018-01-26 04:37:53 +01:00
ui wip: add Vulkan support to Apple platforms 2018-05-13 21:35:23 +02:00
wifi Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
wii
wiiu Implement UDP broadcast network logging on Wii U 2018-05-06 14:39:48 -07:00
.editorconfig
.gitignore Squashed 'libretro-common/' content from commit 377cef30fa 2018-05-12 17:56:33 +02:00
.project
.travis.yml Adjust travis build to only use libraries the build-server supports. 2018-04-27 12:48:58 -05:00
autosave.h
CHANGES.md Update CHANGES.md 2018-05-14 01:14:28 +02:00
command.c Fix the reset command not closing the menu 2018-05-17 09:49:45 -05:00
command.h add menu entries 2018-05-13 22:33:06 -05:00
config.def.h Merge pull request #6782 from meepingsnesroms/master 2018-05-17 01:34:48 +02:00
config.def.keybinds.h Qt WIMP GUI 2018-04-30 14:33:05 -04:00
config.features.h
configuration.c blacklist some settings from overrides 2018-05-13 23:58:55 -05:00
configuration.h add remap saving, add new variables 2018-05-13 22:05:19 -05:00
configure
content.h Change return type of content_get_subsystem_rom_id 2018-04-17 03:19:35 +02:00
CONTRIBUTING.md
COPYING
core_impl.c Forgot to initialize controller port map, this caused VBA-M to crash when creating the secondary core. Now fixed. 2018-03-31 12:15:14 -05:00
core_info.c Qt WIMP GUI 2018-04-30 14:33:05 -04:00
core_info.h Qt WIMP GUI 2018-04-30 14:33:05 -04:00
core_type.h
core.h Runahead system 2018-03-28 14:22:07 -05:00
database_info.c (database_info/task_database) Get rid of list_special dependencies 2018-04-10 04:13:45 +02:00
database_info.h (database_info/task_database) Get rid of list_special dependencies 2018-04-10 04:13:45 +02:00
defaults.h
dirs.c nitpicking fix: makes shader next start at the first shader 2018-02-19 20:01:23 -05:00
dirs.h
driver.c Reduce usage of string_is_not_equal_fast 2018-01-17 01:03:48 +01:00
driver.h
dynamic.c (WinRT) Add more __WINRT__ ifdefs 2018-05-12 19:14:49 +02:00
dynamic.h Runahead system 2018-03-28 14:22:07 -05:00
fetch-submodules.sh
file_path_special.c (WinRT) Add more WINRT ifdefs 2018-05-12 19:17:23 +02:00
file_path_special.h (Audio mixer) Add MP3 support as well 2018-04-28 14:18:04 +02:00
file_path_str.c (Audio mixer) Add MP3 support as well 2018-04-28 14:18:04 +02:00
lakka.h
list_special.c Conditionally build up shader list 2018-02-26 18:56:56 +01:00
list_special.h
Makefile Makefile: Try to fix logic. 2018-05-03 15:50:11 -07:00
Makefile.common Integrate HLSL code into d3d9_hlsl_renderchain.c 2018-05-16 15:52:11 +02:00
Makefile.ctr Start using proper 3ds executable formats (doesnt work properly yet) 2018-05-09 15:55:48 -07:00
Makefile.ctr.salamander Start using proper 3ds executable formats (doesnt work properly yet) 2018-05-09 15:55:48 -07:00
Makefile.emscripten Revert "(3DS/Emscripten/Vita/Wiiu) Add HAVE_CHD support" 2018-04-22 12:02:40 +02:00
Makefile.griffin (Wii/WiiU) Add HAVE_RUNAHEAD 2018-04-08 00:48:27 +02:00
Makefile.libogc
Makefile.msvc remap-redux part2: cleanup 2018-04-08 12:13:49 -05:00
Makefile.openpandora
Makefile.pandora
Makefile.ps3 (PS3) Add HAVE_DR_FLAC 2018-05-07 17:52:53 +02:00
Makefile.ps3.cobra Revert "Revert "(PS3) Set GCC for PS3"" 2018-04-12 23:46:41 +02:00
Makefile.ps3.salamander Revert "Revert "(PS3) Set GCC for PS3"" 2018-04-12 23:46:41 +02:00
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander
Makefile.switch (NSW) Add RARCH_INTERNAL 2018-05-07 17:41:53 +02:00
Makefile.vita Revert "(3DS/Emscripten/Vita/Wiiu) Add HAVE_CHD support" 2018-04-22 12:02:40 +02:00
Makefile.vita.salamander
Makefile.wii.salamander
Makefile.wiiu Implement UDP broadcast network logging on Wii U 2018-05-06 14:39:48 -07:00
Makefile.win
movie.c Get rid of a lot of implicit conversions 2018-04-09 15:56:45 +02:00
movie.h
msg_hash.c (samples) Gets close to linking now 2018-04-10 03:53:46 +02:00
msg_hash.h add saving, deletion options for per-dir remaps 2018-05-13 23:17:44 -05:00
no-xib.diff
paths.c subsystem part 4: set savestates properly 2018-03-04 12:34:51 -05:00
paths.h
performance_counters.c
performance_counters.h
playlist.c Create playlist_cached functions inside playlist.c 2018-04-10 17:40:29 +02:00
playlist.h Create playlist_cached functions inside playlist.c 2018-04-10 17:40:29 +02:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Update README.md 2018-05-03 20:02:22 -07:00
retroarch-android-debug.diff add patch to enable gdb/debugging on android 2018-03-01 16:01:04 -05:00
retroarch-mingw-build.sh
retroarch.c add saving, deletion options for per-dir remaps 2018-05-13 23:17:44 -05:00
retroarch.cfg Qt: add setting in User Interface to enable use of the desktop menu in general (disabling it may improve startup time if desktop menu is not being used) 2018-04-30 19:11:38 -04:00
retroarch.desktop
retroarch.h add saving, deletion options for per-dir remaps 2018-05-13 23:17:44 -05:00
setting_list.c Revert "(Menu) Update menu code" 2018-04-11 06:10:51 +02:00
setting_list.h (menu) Get rid of name_hash 2018-02-25 18:04:32 +01:00
verbosity.c Buildfix for MSVC 2003 2018-05-02 01:03:40 +02:00
verbosity.h More fixes, GC pad kinda sorta works 2018-03-29 23:37:11 -07:00
version_git.c
version_git.h
version.all Update to 1.7.3 2018-05-04 05:45:22 +02:00
version.dtd
version.h
wiiu-devel.properties.template Implement UDP broadcast network logging on Wii U 2018-05-06 14:39:48 -07:00

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 Windows binaries are currently hosted on the buildbot.

Support

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

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

Platforms

RetroArch has been ported to the following platforms:

  • DOS
  • Windows
  • Linux
  • Emscripten
  • FreeBSD
  • NetBSD
  • OpenBSD
  • Haiku
  • Solaris
  • MacOS X
  • PlayStation 3
  • PlayStation Portable
  • PlayStation Vita
  • Original Microsoft Xbox
  • Microsoft Xbox 360 (Libxenon/XeXDK)
  • Nintendo Wii, GameCube (Libogc)
  • Nintendo Wii U
  • Nintendo 3DS
  • Nintendo Switch
  • 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 Switch res 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 modelins 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 a lot different. 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 roted any games that may need it switch CRT SwitchRes on.