Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Twinaphex 62d2b9a54e
Merge pull request #6417 from Tatsuya79/patch-1
xmb_scale_factor min limit to 20
2018-03-19 03:46:50 +01:00
.github Rename PULL_REQUEST_TEMPLATE to PULL_REQUEST_TEMPLATE.md 2017-11-29 12:03:42 -05:00
.vscode subsystem part 2: add LABELS 2018-02-12 02:39:24 -05:00
audio NSW(audio): use alloc_pages to acquire buffers instead of using ones in bss 2018-03-06 21:18:42 -08:00
bootstrap Merge pull request #5941 from frangarcj/vita-adrenaline 2017-12-21 01:05:28 +01:00
camera Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
cheevos remove task_push_http_transfer_raw, encode before sending data to the task 2018-03-16 22:38:21 -05:00
cores Update libretro-mpv core - only use dlopen for HAVE_OPENGLES builds 2018-02-23 14:40:31 +01:00
ctr (CTR) build fix. 2017-12-25 08:51:50 +01:00
defines Cleanups 2018-01-25 15:30:48 +01:00
deps try to fix android compilation issues 2018-03-18 11:55:54 -05:00
dist-scripts Update 2018-02-18 02:08:18 +01:00
docs
emscripten emscripten: Use argument list for Module.print 2018-01-15 10:06:06 -05:00
frontend Fix UNIX build 2018-02-25 20:49:44 +01:00
gfx With X context set vk.swapchain to VK_NULL_HANDLE when failing to create swapchain so Vulkan common functions don't try and use it and crash. 2018-03-18 19:31:25 -05:00
griffin Fix Griffin build 2018-03-03 15:30:35 +01:00
input [WiiU] Fix OOB read/write in keyboard driver 2018-03-17 13:00:47 +11:00
intl fix potential crash on task_push_http_transfer 2018-03-18 12:52:04 -05:00
led Add frontend, battery level and memory amount detection to 3ds port 2018-01-10 16:52:32 -08:00
libretro-common remove task_push_http_transfer_raw, encode before sending data to the task 2018-03-16 22:38:21 -05:00
libretro-db Don't use mmap for libretrodb - using mmap seems 2018-02-13 07:34:19 +01:00
location Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
managers Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
media explicitly set codepage for Japanese menubar translation, fixes #4536 and #4761 2017-09-22 09:40:22 -07:00
memory Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
menu xmb_scale_factor min limit to 20 2018-03-18 23:05:57 +01:00
network remove task_push_http_transfer_raw, encode before sending data to the task 2018-03-16 22:38:21 -05:00
pkg Fix MSVC 2013 build 2018-03-16 22:04:34 +01:00
qb Disable D3D10 for now by default until it gets menu display driver 2018-02-15 12:46:37 +01:00
record Revert "Turn scaler_ctx_scale_direct into inline function" 2018-03-14 23:48:47 +01:00
tasks fix potential crash on task_push_http_transfer 2018-03-18 12:52:04 -05: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 (msvc) CXX_BUILD + griffin fixes. 2018-02-05 00:25:03 +01:00
wifi Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
wii Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
wiiu Update imports.h 2018-02-25 13:53:57 +00:00
.editorconfig
.gitignore Add missing slash 2018-02-17 15:59:04 -08:00
.project
.travis.yml Squashed 'deps/SPIRV-Cross/' changes from 33c5cd9..c9516fa 2018-03-06 04:10:13 +01:00
autosave.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
CHANGES.md update CHANGES.md 2018-03-17 15:04:55 -05:00
command.c Implement Slow motion toggle 2018-03-10 18:42:45 +01:00
command.h subsystem part 3: remove more globals 2018-02-12 02:39:25 -05:00
config.def.h make sure to always encode urls, also change the PS3 default urls 2018-03-14 23:04:50 -05:00
config.def.keybinds.h Implement Slow motion toggle 2018-03-10 18:42:45 +01:00
config.features.h Remove remaining references to HAVE_FBO 2017-11-13 08:55:41 +01:00
configuration.c added cheevos_auto_screenshot 2018-03-14 22:41:51 -03:00
configuration.h added cheevos_auto_screenshot 2018-03-14 22:41:51 -03:00
configure
content.h subsystem part 3: fix saves 2018-02-12 02:39:26 -05:00
CONTRIBUTING.md
COPYING
core_impl.c
core_info.c (core_info.c) cleanup memory allocations 2018-02-04 23:07:24 +01:00
core_info.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
core_type.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
core.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
database_info.c (database_info.c) Cleanups 2018-02-25 21:58:52 +01:00
database_info.h Cleanups 2017-09-28 09:32:23 +02:00
defaults.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
dirs.c nitpicking fix: makes shader next start at the first shader 2018-02-19 20:01:23 -05:00
dirs.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
driver.c Reduce usage of string_is_not_equal_fast 2018-01-17 01:03:48 +01:00
driver.h Added an LED interface and a Raspberry Pi GPIO implementation 2017-12-27 11:11:08 -05:00
dynamic.c Refactor verbosity code - try to avoid log calls if verbosity is not 2018-01-17 06:28:26 +01:00
dynamic.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
fetch-submodules.sh
file_path_special.c Simplify fill_pathname_representation_wrapper 2018-02-04 23:40:27 +01:00
file_path_special.h libretro-common: Clean up dependencies of file_path 2018-01-13 00:27:49 -05:00
file_path_str.c Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
lakka.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
list_special.c Conditionally build up shader list 2018-02-26 18:56:56 +01:00
list_special.h Fix more MSVC Griffin build errors 2017-12-30 13:35:47 +01:00
Makefile use 64-bit file offsets/seeking on windows 2018-02-14 06:16:12 +00:00
Makefile.common Split up menu display drivers for D3D8/D3D9 into separate drivers; 2018-03-03 15:28:58 +01:00
Makefile.ctr Add 3DS threads 2018-01-17 14:00:57 -08:00
Makefile.ctr.salamander Remove -a from uname 2018-01-05 09:58:10 -08:00
Makefile.emscripten no longer compile with SDL support by default 2018-01-18 22:57:46 -06:00
Makefile.griffin griffin: add vc2015 Makefile target 2018-03-16 21:03:58 +00:00
Makefile.libogc
Makefile.msvc (D3D12) add menu display driver. 2018-02-08 00:18:05 +01:00
Makefile.openpandora Start removing SINC ifdefs for individual Makefiles 2017-12-31 21:34:31 +01:00
Makefile.pandora
Makefile.ps3 (PS3) Change back to SNC 2018-03-06 19:03:51 +01:00
Makefile.ps3.cobra (PS3) Change back to SNC 2018-03-06 19:03:51 +01:00
Makefile.ps3.salamander (PS3) Change back to SNC 2018-03-06 19:03:51 +01:00
Makefile.psl1ght Remove remaining references to HAVE_FBO 2017-11-13 08:55:41 +01:00
Makefile.psp1 Start removing SINC ifdefs for individual Makefiles 2017-12-31 21:34:31 +01:00
Makefile.psp1.salamander Add vfs_implementation to Salamander builds 2017-12-14 15:18:48 +01:00
Makefile.switch (NSW) initial support for menu 2017-12-30 11:14:45 +01:00
Makefile.vita Reduce size of Makefiles 2017-12-07 05:54:54 +01:00
Makefile.vita.salamander Add vfs_implementation to Salamander builds 2017-12-14 15:18:48 +01:00
Makefile.wii.salamander Add vfs_implementation to Salamander builds 2017-12-14 15:18:48 +01:00
Makefile.wiiu Turn off WIIU_HID on master 2018-01-19 21:58:22 -08:00
Makefile.win Remove remaining references to HAVE_FBO 2017-11-13 08:55:41 +01:00
movie.c Update libretro-common 2017-12-15 00:31:37 +01:00
movie.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
msg_hash.c add basic support for arabic. 2018-02-05 20:54:55 +01:00
msg_hash.h remove task_push_http_transfer_raw, encode before sending data to the task 2018-03-16 22:38:21 -05:00
no-xib.diff
paths.c subsystem part 4: set savestates properly 2018-03-04 12:34:51 -05:00
paths.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
performance_counters.c VC6 support (targets NT 3.51) 2017-09-06 23:03:02 -04:00
performance_counters.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
playlist.c Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
playlist.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Squashed 'deps/SPIRV-Cross/' changes from 33c5cd9..c9516fa 2018-03-06 04:10:13 +01: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 Merge pull request #6375 from GregorR/override-load-order 2018-03-11 01:32:14 +01:00
retroarch.cfg reset retroarch.cfg 2018-03-18 19:06:07 -05:00
retroarch.desktop Making description more concrete and adding Russian translation 2017-11-22 19:04:59 +03:00
retroarch.h fix SHADER_NEXT/SHADER_PREV 2018-02-07 21:26:00 -05:00
setting_list.c (menu) Get rid of name_hash 2018-02-25 18:04:32 +01:00
setting_list.h (menu) Get rid of name_hash 2018-02-25 18:04:32 +01:00
verbosity.c Update and fix API error 2018-01-17 19:30:20 +01:00
verbosity.h Remove retro_inline 2018-01-17 06:47:49 +01:00
version_git.c Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
version_git.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
version.all Set 1.7.1 2018-02-17 16:43:51 +01:00
version.dtd Bump to version 1.7.0 2017-12-25 18:17:57 +01:00
version.h Clean up trailing whitespace 2017-12-12 00:24:18 -08:00
wiiu-devel.properties.template Polish up WiiU deploy scripts 2018-01-10 22:51:00 -08: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 videogame system emulators and game engines, but also 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/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 WiiU
  • 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 doesn't 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.