** This is no longer upstream, see libretro organization. ** Simple Multi-emulator frontend based on libretro.
C C++ Objective-C Shell PHP JavaScript Other
Pull request Compare This branch is 1043 commits behind libretro:master.
Latest commit 4e9fe4b Dec 20, 2016 @Themaister Vulkan: Fix menu shader parameters for slangp.
video_shader_resolve_parameters did not take #includes into account
while the Vulkan implementation did. Added a helper function which
parses a shader file and figures out the shader parameters in the same
way.
Permalink
Failed to load latest commit information.
audio Fix unmute after starting muted. Dec 19, 2016
bootstrap (VITA) Allow cores to define heap size Oct 11, 2016
camera Prevent some implicit memsets and reduce the size of some Oct 27, 2016
cores More logging Nov 8, 2016
ctr (3DS) wrap texture coordinate swizzeling in a function. Oct 10, 2016
defines Merge pull request #3697 from d3m3vilurr/vita-extend-input Sep 30, 2016
deps unknown battery level on windows should not be displayed Dec 20, 2016
dist-scripts (WiiU) put current git hash in meta.xml Nov 30, 2016
docs mark these as deprecated Aug 28, 2016
emscripten move these files over to the package dir Aug 29, 2016
frontend Merge pull request #4279 from sethk/macos_cleanup Dec 19, 2016
gfx Vulkan: Fix menu shader parameters for slangp. Dec 20, 2016
griffin Refactoring: netplay_common.c -> netplay_handshake.c/netplay_delta.c Dec 19, 2016
input (input_config.c) Get rid of implicit memset Dec 19, 2016
intl add option to show battery level next to the datetime in the menu Dec 19, 2016
libretro-common (libretro-common) Cleanups Dec 19, 2016
libretro-db Revert "Use string_is_equal" Oct 4, 2016
location location_driver_ctl - return 'true' by default Sep 29, 2016
managers Translate "Applying cheat changes." to all languages Oct 31, 2016
media add ellipses to indicate a popup window Dec 17, 2016
memory (VITA) Add support for -mthumb Nov 14, 2016
menu unknown battery level on windows should not be displayed Dec 20, 2016
network Adding blocks in the empty-RECV case to (hopefully) suppress warnings Dec 19, 2016
pkg Use native getopt_long() on macOS Dec 18, 2016
qb No need to ugly hack in qb/conf.libs.sh. Dec 17, 2016
record Move audio resampler drivers (Sinc/nearest) to libretro-common; maist… Dec 12, 2016
tasks Get rid of some implicit memsets Dec 19, 2016
tools chmod +x on pkg.py Aug 11, 2016
ui do not zero entire string Dec 17, 2016
wifi Remove two runloop.h includes Dec 2, 2016
wii/app_booter (wii/app_booter) Style nits Sep 21, 2015
wiiu (WiiU) added basic libiosuhax support Dec 17, 2016
.editorconfig Add EditorConfig support Sep 16, 2016
.gitignore Those should be ignored Nov 14, 2016
.gitmodules Use libretro glslang Dec 4, 2016
.project Allow to load roms from external apps. Aug 19, 2013
.travis.yml (Travis CI) Use freeglut3-dev Dec 16, 2016
CONTRIBUTING.md Update CONTRIBUTING.md Dec 9, 2012
COPYING Add GPLv3 text I suppose. Jan 25, 2011
Makefile Add HAVE_CC_RESAMPLER to more Makefiles Dec 12, 2016
Makefile.common Vulkan: Fix menu shader parameters for slangp. Dec 20, 2016
Makefile.ctr Add HAVE_CC_RESAMPLER to more Makefiles Dec 12, 2016
Makefile.ctr.salamander Add compat_strcasestr to Salamander builds Dec 17, 2016
Makefile.emscripten Add HAVE_CC_RESAMPLER to more Makefiles Dec 12, 2016
Makefile.griffin (vita) Buildfix Dec 14, 2016
Makefile.openpandora Remove WANT_RPNG May 17, 2016
Makefile.pandora Move pandora files Sep 20, 2015
Makefile.ps3 Add HAVE_CC_RESAMPLER defines Dec 12, 2016
Makefile.ps3.cobra Don't use HAVE_NETPLAY any more Sep 29, 2016
Makefile.ps3.salamander Add compat_strcasestr to Salamander builds Dec 17, 2016
Makefile.psl1ght Add HAVE_CC_RESAMPLER defines Dec 12, 2016
Makefile.psp1 Add HAVE_CC_RESAMPLER defines Dec 12, 2016
Makefile.psp1.salamander Add compat_strcasestr to Salamander builds Dec 17, 2016
Makefile.vita.salamander Add compat_strcasestr to Salamander builds Dec 17, 2016
Makefile.wii.salamander Add compat_strcasestr to Salamander builds Dec 17, 2016
Makefile.wiiu (WiiU) added basic libiosuhax support Dec 17, 2016
Makefile.win Add HAVE_CC_RESAMPLER to more Makefiles Dec 12, 2016
README-OMAP.md video_omap: more docu fixes Jan 14, 2014
README-exynos.md exynos: update TODO list Aug 9, 2014
README-mali_fbdev_r4p0.md Fix some spelling errors (pendantic info lintian warnings). Jul 21, 2016
README.md README.md: Minor Markdown fixes Dec 11, 2016
autosave.h Cleanups Sep 1, 2016
cheevos.c Create runloop_check_cheevos Dec 6, 2016
cheevos.h Create runloop_check_cheevos Dec 6, 2016
command.c Added netplay spectator password separate from play password Dec 19, 2016
command.h Adding game/watch key Dec 19, 2016
config.def.h Be consistent about the type of check_frames. Fixes warnings. Dec 19, 2016
config.features.h Don't use HAVE_NETPLAY any more Sep 29, 2016
configuration.c merge battery branch into master Dec 19, 2016
configuration.h add option to show battery level next to the datetime in the menu Dec 19, 2016
configure (qb) Add qb.system.sh Jun 16, 2015
content.h update copyright Oct 27, 2016
core.h When we disconnect netplay, fully deinit it Dec 18, 2016
core_impl.c When we disconnect netplay, fully deinit it Dec 18, 2016
core_info.c Remove warning about unused variable Dec 15, 2016
core_info.h update copyright Oct 27, 2016
core_type.h Add Start Video Processor menu entry Jul 28, 2016
database_info.c file_archive_get_file_list - take out HAVE_COMPRESSION code Dec 17, 2016
database_info.h update copyright Oct 27, 2016
defaults.h Remove hacky 'OSK Keyboard' overlay Nov 27, 2016
dirs.c Remove hacky 'OSK Keyboard' overlay Nov 27, 2016
dirs.h Remove hacky 'OSK Keyboard' overlay Nov 27, 2016
driver.c Move audio resampler drivers (Sinc/nearest) to libretro-common; maist… Dec 12, 2016
driver.h Revert "Create drivers_data array and no longer use recording_data" Dec 5, 2016
dynamic.c Get rid of some implicit memsets Dec 19, 2016
dynamic.h fall gracefully back to the menu if a dynamic core could not be loaded Oct 12, 2016
fetch-submodules.sh Add --recursive in case submodules have third-party dependencies Sep 11, 2016
file_path_special.c Revert "Remove HAVE_COMPRESSION ifdefs in file_path.c" Dec 17, 2016
file_path_special.h Revert "Remove HAVE_COMPRESSION ifdefs in file_path.c" Dec 17, 2016
file_path_str.c add slang shader menu entry to online updater Oct 8, 2016
lakka.h Add missing copyright mention on some files Oct 27, 2016
list_special.c Move audio resampler drivers (Sinc/nearest) to libretro-common; maist… Dec 12, 2016
list_special.h update copyright Oct 27, 2016
movie.c Move code to movie.c Sep 16, 2016
movie.h Move code to movie.c Sep 16, 2016
msg_hash.c (XMB) Create icons for CFILE Dec 18, 2016
msg_hash.h remove unused msg_hash Dec 19, 2016
no-xib.diff Add no-xib.diff Oct 13, 2015
patch.c Revert "Move global->name to paths.c" Oct 1, 2016
patch.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files Jun 3, 2016
paths.c Move compression-related code outside of libretro-common file_path.c Dec 17, 2016
paths.h Get rid of path_get_core_size Oct 3, 2016
performance_counters.c Get rid of more general.h includes Sep 1, 2016
performance_counters.h Use retro_common_api.h Jun 3, 2016
playlist.c Get rid of playlist_entry_get_label Dec 15, 2016
playlist.h (Menu) Get Remove from Playlist to work on history playlists Aug 29, 2016
retroarch-mingw-build.sh Add support for different "make" binaries Jul 29, 2014
retroarch.c Merge pull request #4279 from sethk/macos_cleanup Dec 19, 2016
retroarch.cfg add option to show battery level next to the datetime in the menu Dec 19, 2016
retroarch.desktop (Linux) Add a GenericName to the desktop entry Jun 18, 2015
retroarch.h Goodbye delay_frames! stateless_mode is the new delay_frames=0 Dec 19, 2016
runloop.c New sync system Dec 19, 2016
runloop.h runloop.h header include cleanup - don't include retro_miscellaneous.h Dec 10, 2016
setting_list.c Turn setting_get_type into a macro Dec 14, 2016
setting_list.h Turn setting_get_type into a macro Dec 14, 2016
verbosity.c (MSVC) Buildfix Oct 9, 2016
verbosity.h Cleanups Sep 12, 2016
version.h Rename git_version.c to version_git.h, create separate Sep 1, 2016
version_git.c Rename git_version.c to version_git.h, create separate Sep 1, 2016
version_git.h Rename git_version.c to version_git.h, create separate Sep 1, 2016

README.md

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.

Related projects

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.