Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Diablodiab 77e479a8bc Adds two new parameters that can be passed to the Android version of Retroarch at launch:
QUITFOCUS
If enabled this will cause Retroarch to quit completely when it loses focus (eg. when the home button is pressed). This is useful when you are using an alternative launcher such as Kodi because it will make the home button function as an alternative quit key, return to the alternative launcher, and then allow for a different game to start instead of returning to the current session.

HIDEMOUSE
Normally it is not possible to hide the mouse cursor if you have attached an external mouse to your Android unit. This makes it difficult to implement mouse support in the Android version of Retroarch because you will end up having two mouse cursors on the screen. NVIDIA has implemented extensions on the SHIELD that allows for hiding the mouse cursor. If this parameter is provided when starting Retroarch it will check for these extensions and if available it will hide the mouse cursor.

(I am almost done with adding mouse support to the Android input driver and will be submitting a suggestion for this very soon)
2017-02-12 13:26:18 +01:00
.github add more fields 2017-01-14 15:16:59 -05:00
audio fix Dinothawr on xaudio/dsound 2017-02-01 21:36:10 +08:00
bootstrap Apply xerpi diff 2017-01-17 18:12:23 +01:00
camera Remove the few performance counters that depend on runloop_ctl 2017-01-25 18:15:58 +01:00
cheevos Merge pull request #4596 from leiradel/master 2017-02-08 21:43:53 +01:00
cores (ffmpeg) Better error handling 2017-01-24 16:28:07 +01:00
ctr (3DS) wrap texture coordinate swizzeling in a function. 2016-10-10 22:22:08 +01:00
defines Header update #1 2017-01-22 13:40:32 +01:00
deps (griffin) build fix. 2017-01-31 03:27:00 +01:00
dist-scripts Add Dot-Art theme 2017-01-30 21:13:44 -05:00
docs mark these as deprecated 2016-08-27 21:56:37 -05:00
emscripten move these files over to the package dir 2016-08-28 19:09:55 -05:00
frontend Silence implicit declaration warning 2017-01-30 17:35:00 +01:00
gfx sdl2 renderer: remove the random flashing black borders 2017-02-08 22:31:26 +01:00
griffin Moved cheevos files to their own folder in preparation for the changes to support leaderboards 2017-02-03 10:03:57 +00:00
input WiiU Fix Keyboard Input 2017-02-09 14:08:27 -05:00
intl Merge pull request #4618 from rootfather/intl-de 2017-02-12 11:34:13 +01:00
libretro-common Try to stay under max. 80-char width limit 2017-02-05 06:01:22 +01:00
libretro-db Header update #1 2017-01-22 13:40:32 +01:00
location Header update #1 2017-01-22 13:40:32 +01:00
managers Moved cheevos files to their own folder in preparation for the changes to support leaderboards 2017-02-03 10:03:57 +00:00
media disable shader dialog until video_threaded issues are fixed 2017-01-16 19:26:28 -05:00
memory (VITA) Add support for -mthumb 2016-11-14 19:13:07 +01:00
menu Revert "Allow normal Battery/Clock icon sizes [WIP]" 2017-02-08 20:02:26 +01:00
network Make announcing netplay on the public lobby optional. 2017-02-06 13:45:58 -05:00
pkg Adds two new parameters that can be passed to the Android version of Retroarch at launch: 2017-02-12 13:26:18 +01:00
qb Add HAVE_VIDEOPROCESSOR switch 2017-02-02 22:05:05 +01:00
record Create video_driver_get_record_status 2017-01-25 15:30:51 +01:00
tasks fix contentless netplay! thanks Gregor 2017-02-09 21:22:52 -05:00
tools chmod +x on pkg.py 2016-08-12 00:09:22 +02:00
ui Header update #1 2017-01-22 13:40:32 +01:00
wifi Header update #1 2017-01-22 13:40:32 +01:00
wii/app_booter
wiiu WiiU Initial Keyboard Support 2017-02-09 12:34:12 -05:00
.editorconfig Add EditorConfig support 2016-09-16 10:44:33 -04:00
.gitignore Add msvc-2015 solution courtesy of spec-chum 2017-01-26 01:56:51 +01:00
.project
.travis.yml (Travis CI) Use freeglut3-dev 2016-12-16 14:39:11 +01:00
autosave.h Cleanups 2016-09-01 04:57:04 +02:00
CHANGES.md update changelog 2017-02-11 14:45:11 -05:00
command.c fix contentless netplay! thanks Gregor 2017-02-09 21:22:52 -05:00
command.h can now connect when starting a game too 2017-01-20 16:04:10 -05:00
config.def.h Make announcing netplay on the public lobby optional. 2017-02-06 13:45:58 -05:00
config.def.keybinds.h Add QNX-specific settings to config.def.h, refactor default keybinds into a separate file for cleaner per-platform setup 2017-01-09 20:26:09 +00:00
config.features.h Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
configuration.c Make announcing netplay on the public lobby optional. 2017-02-06 13:45:58 -05:00
configuration.h Make announcing netplay on the public lobby optional. 2017-02-06 13:45:58 -05:00
configure
content.h Add another parameter to content_get_status 2017-01-25 15:51:57 +01:00
CONTRIBUTING.md
COPYING
core_impl.c Add another parameter to content_get_status 2017-01-25 15:51:57 +01:00
core_info.c add zip and 7z always to the list of supported extensions 2017-02-10 23:58:58 -05:00
core_info.h update copyright 2016-10-27 11:47:10 -04:00
core_type.h Add Start Video Processor menu entry 2016-07-28 20:35:05 +02:00
core.h core_impl.c - some cleanups 2017-01-23 14:50:00 +01:00
database_info.c Cleanups 2017-01-23 15:05:11 +01:00
database_info.h (database_info.c) Don't use non-enum function 2016-12-20 21:40:41 +01:00
defaults.h Remove hacky 'OSK Keyboard' overlay 2016-11-27 02:46:09 +01:00
diff.diff update diff.diff 2017-01-17 17:13:42 +01:00
dirs.c Revert "Rename runloop_msg_queue_push to video_driver_msg_queue_push" 2016-12-22 23:36:11 +01:00
dirs.h Remove hacky 'OSK Keyboard' overlay 2016-11-27 02:46:09 +01:00
driver.c (video driver) Minor cleanups 2017-01-25 15:22:12 +01:00
driver.h Make driver_set_nonblock_state a public function 2017-01-22 12:47:17 +01:00
dynamic.c Moved cheevos files to their own folder in preparation for the changes to support leaderboards 2017-02-03 10:03:57 +00:00
dynamic.h fall gracefully back to the menu if a dynamic core could not be loaded 2016-10-11 20:28:36 -04:00
fetch-submodules.sh Add --recursive in case submodules have third-party dependencies 2016-09-11 19:43:16 -04:00
file_path_special.c Win2000 buildfixes 2017-01-16 20:41:08 -05:00
file_path_special.h parsing now works 2017-01-19 00:52:53 -05:00
file_path_str.c parsing now works 2017-01-19 00:52:53 -05:00
lakka.h Add missing copyright mention on some files 2016-10-27 18:17:43 +02:00
list_special.c Move audio resampler drivers (Sinc/nearest) to libretro-common; maister gave permission to relicense to MIT 2016-12-12 13:02:29 +01:00
list_special.h update copyright 2016-10-27 11:47:10 -04:00
Makefile Thing 2017-02-05 14:13:30 +01:00
Makefile.common DOS: add keyboard driver to support non-joypad keys 2017-02-05 13:55:21 -05:00
Makefile.ctr Update Makefiles - audio_filters have been moved to libretro-common 2017-01-09 12:37:01 +01:00
Makefile.ctr.salamander Add compat_strcasestr to Salamander builds 2016-12-17 19:35:51 +01:00
Makefile.emscripten Update Makefiles - audio_filters have been moved to libretro-common 2017-01-09 12:37:01 +01:00
Makefile.griffin (Wii) buildfix for devkitPPC r29. 2017-01-23 16:01:53 +01:00
Makefile.openpandora Remove WANT_RPNG 2016-05-17 13:41:40 +02:00
Makefile.pandora
Makefile.ps3 Add HAVE_CC_RESAMPLER defines 2016-12-12 12:44:29 +01:00
Makefile.ps3.cobra Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
Makefile.ps3.salamander Add compat_strcasestr to Salamander builds 2016-12-17 19:35:51 +01:00
Makefile.psl1ght Add HAVE_CC_RESAMPLER defines 2016-12-12 12:44:29 +01:00
Makefile.psp1 Add HAVE_CC_RESAMPLER defines 2016-12-12 12:44:29 +01:00
Makefile.psp1.salamander Add compat_strcasestr to Salamander builds 2016-12-17 19:35:51 +01:00
Makefile.vita Get HAVE_XMB define out of HAVE_RGUI 2017-01-17 23:12:36 +01:00
Makefile.vita.salamander (VITA) Fix salamander 2017-01-17 13:52:29 +01:00
Makefile.wii.salamander Add compat_strcasestr to Salamander builds 2016-12-17 19:35:51 +01:00
Makefile.wiiu (WiiU) implement the missing requirement for core loading: exec, 2017-01-25 19:52:31 +01:00
Makefile.wiiu.salamander (WiiU) implement the missing requirement for core loading: exec, 2017-01-25 19:52:31 +01:00
Makefile.win Add HAVE_CC_RESAMPLER to more Makefiles 2016-12-12 12:48:04 +01:00
movie.c (movie.c) Try to be more safe in init_playback 2017-01-22 18:22:45 +01:00
movie.h Create bsv_movie_get_input 2017-01-22 17:03:42 +01:00
msg_hash.c Revert "allow serial scanner to match PBP" 2017-01-07 05:52:12 +01:00
msg_hash.h attempt autoconf fallback for android 2017-02-07 00:12:30 -05:00
no-xib.diff
paths.c fix saving for contentless cores 2017-01-28 22:48:51 -05:00
paths.h Get rid of path_get_core_size 2016-10-03 16:17:08 +02:00
performance_counters.c Rewrite performance counter stop/start/init into macros 2017-01-25 16:53:06 +01:00
performance_counters.h Remove the few performance counters that depend on runloop_ctl 2017-01-25 18:15:58 +01:00
playlist.c Cleanups; header includes 2017-01-09 02:00:27 +01:00
playlist.h (Menu) Get Remove from Playlist to work on history playlists 2016-08-29 02:22:05 +02:00
README-exynos.md
README-mali_fbdev_r4p0.md Fix some spelling errors (pendantic info lintian warnings). 2016-07-20 23:28:29 -03:00
README-OMAP.md
README.md README.md: Minor Markdown fixes 2016-12-11 17:55:36 -02:00
retroarch-mingw-build.sh
retroarch.c Add ifdef around this 2017-01-29 05:06:14 +01:00
retroarch.cfg revert retroarch.cfg overwrite 2017-02-04 14:01:57 -05:00
retroarch.desktop
retroarch.h Goodbye delay_frames! stateless_mode is the new delay_frames=0 2016-12-18 19:28:43 -05:00
runloop_defines.h Add runloop_defines.h 2017-01-31 05:14:49 +01:00
runloop.c Fix ./configure --disable-rgui 2017-02-04 09:20:41 +01:00
runloop.h Add runloop_defines.h 2017-01-31 05:14:49 +01:00
setting_list.c Fix ./configure --disable-rgui 2017-02-04 09:20:41 +01:00
setting_list.h Turn setting_get_type into a macro 2016-12-14 16:19:32 +01:00
verbosity.c (MSVC) Buildfix 2016-10-09 17:17:29 +02:00
verbosity.h Cleanups 2016-09-12 16:36:27 +02:00
version_git.c Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +02:00
version_git.h Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +02:00
version.h Update to version 1.4.1 2017-02-02 22:20:33 +01: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".

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 wiki. 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 outside PC:

  • PlayStation 3
  • Xbox 360 (Libxenon/XeXDK)
  • Xbox 1
  • Wii, Gamecube (Libogc)
  • Nintendo 3DS
  • 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

Linux

  • Prerequisites:
sudo apt-get install -y make git-core curl g++ pkg-config libglu1-mesa-dev freeglut3-dev mesa-common-dev libsdl1.2-dev libsdl-image1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev
  • Compiling:
./configure
make

Mac

  • Prerequisites: XCode, Cg.
  • You can open the project (pkg/apple/RetroArch.xcodeproj) in the Xcode IDE and build (⌘-B) and run (⌘-R) it there. Or you can use the command line...
  • Debug:
# Build
xcodebuild -target RetroArch -configuration Debug -project pkg/apple/RetroArch.xcodeproj
# Run
open ./pkg/apple/build/Debug/RetroArch.app/
  • Release:
# Build
xcodebuild -target RetroArch -configuration Release -project pkg/apple/RetroArch.xcodeproj
# Run
open ./pkg/apple/build/Release/RetroArch.app/

PC

Instructions for compiling on PC can be found in the wiki.

PlayStation 3

RetroArch PS3 needs to be compiled in the following order:

  1. Compile RetroArch Salamander

    make -f Makefile.ps3.salamander

  2. Finally, compile RetroArch packed together with the GUI:

    make -f Makefile.ps3

PlayStation 3 - Creating a PKG installable file

You can add pkg as a parameter in order to make a PKG file - for example:

make -f Makefile.ps3 pkg

This creates an NPDRM package. This can be installed on debug PS3s.

To make a non-NPDRM package that can be installed on a jailbroken/CFW PS3 (such as PSGroove or PS3 CFWs and other 3.55 CFW derivatives), do:

make -f Makefile.ps3 pkg-signed

If you're using Kmeaw 3.55 firmware, the package needs to be signed:

make -f Makefile.ps3 pkg-signed-cfw

NOTE: A pre-existing libretro library needs to be present in the root directory in order to link RetroArch PS3. This file needs to be called libretro_ps3.a.

Xbox 360 (XeXDK)

You will need Microsoft Visual Studio 2010 installed (or higher) in order to compile RetroArch 360.

The solution file can be found at the following location:

pkg/msvc-360/RetroArch-360.sln

NOTE: A pre-existing libretro library needs to be present in the pkg/msvc-360/RetroArch-360/Release directory in order to link RetroArch 360. This file needs to be called libretro_xdk360.lib.

Xbox 360 (Libxenon)

You will need to have the libxenon libraries and a working Devkit Xenon toolchain installed in order to compile RetroArch 360 Libxenon.

make -f Makefile.xenon

NOTE: A pre-existing libretro library needs to be present in the root directory in order to link RetroArch 360 Libxenon. This file needs to be called libretro_xenon360.a.

Wii

You will need to have the libogc libraries and a working Devkit PPC toolchain installed in order to compile RetroArch Wii.

make -f Makefile.griffin platform=wii

NOTE: A pre-existing libretro library needs to be present in the root directory in order to link RetroArch Wii. This file needs to be called libretro_wii.a.