Cross-platform, sophisticated frontend for the libretro API.
C C++ Objective-C Shell JavaScript Makefile Other
Latest commit d9aaef4 Sep 25, 2016 @twinaphex twinaphex committed on GitHub Merge pull request #3656 from loganmc10/patch-6
These are (pretty much) alphabetical
Permalink
Failed to load latest commit information.
audio (JACK) Try to prevent memory leak Sep 22, 2016
bootstrap (psp1) move kernel_functions.prx to the root folder after build Sep 23, 2015
camera Cleanups Sep 8, 2016
cores Don't define/undefine GL_DEBUG at all Sep 22, 2016
ctr (ctr) style nits Sep 20, 2016
defines (VITA) Remove Warnings Sep 19, 2016
deps (Vita) Get rid of matrix helper functions - not needed Sep 21, 2016
dist-scripts glupen64 no longer depends on asyncify Sep 24, 2016
docs mark these as deprecated Aug 28, 2016
emscripten move these files over to the package dir Aug 29, 2016
frontend Attempt to fix issue #3605 Sep 24, 2016
gfx (shader_glsl.c) Continue with iteration if pass is NULL Sep 24, 2016
griffin (Griffin) Buildfix Sep 22, 2016
input Prevent divide by zero Sep 24, 2016
intl little fix for Spanish translation Sep 23, 2016
libretro-common Go through opaque pointer for glDeleteSync - GLsync as a type Sep 23, 2016
libretro-db (libretro-db/query.c) Cleanup Sep 22, 2016
location Revert "Refactor core_system_info_* functions" Sep 6, 2016
managers Prevent 'undefined allocation of 0 bytes' Sep 22, 2016
media use invader instead Sep 10, 2016
memory (GX) Resolution Saving's Video Corruption Fix. Feb 12, 2016
menu Prevent explicit NULL pointer dereference Sep 24, 2016
network Checks for some netplay syscall errors and NULL deref errors Sep 24, 2016
pkg These are (pretty much) alphabetical Sep 24, 2016
qb Rename GLES_LIBS/GLES_CFLAGS to OPENGLES_LIBS/OPENGLES_CFLAGS Sep 21, 2016
record Cleanups Sep 13, 2016
tasks Prevent null pointer dereference / logically dead code / other misc. … Sep 23, 2016
tools chmod +x on pkg.py Aug 11, 2016
ui Silence implicit declarations warnings Sep 23, 2016
wifi Connman: enable wifi before scanning, and restart connman after gener… Sep 23, 2016
wii/app_booter (wii/app_booter) Style nits Sep 21, 2015
.editorconfig Add EditorConfig support Sep 16, 2016
.gitignore Revert "Append _debug to debug builds and add file to .gitignore" Sep 8, 2016
.gitmodules Vulkan: Move to SPIRV-Cross. May 8, 2016
.project Allow to load roms from external apps. Aug 19, 2013
.travis.yml Update Scan Coverity key Sep 17, 2016
CONTRIBUTING.md Update CONTRIBUTING.md Dec 9, 2012
COPYING Add GPLv3 text I suppose. Jan 25, 2011
Makefile (ems) change some makefile flags Sep 24, 2016
Makefile.common Start adding a WiFi driver Sep 22, 2016
Makefile.ctr create 7z archive backend, enables scanning of 7z content Sep 18, 2016
Makefile.emscripten (ems) use imfs in this template for testing purposes Sep 24, 2016
Makefile.griffin (VITA) USE STB FONT Sep 19, 2016
Makefile.openpandora Remove WANT_RPNG May 17, 2016
Makefile.pandora Move pandora files Sep 20, 2015
Makefile.ps3 (PS3) Take out imageviewer for now Aug 3, 2016
Makefile.ps3.cobra Make HAVE_LIBRETRO_MANAGEMENT define obsolete Feb 3, 2016
Makefile.ps3.salamander Create file_path_str.c Jun 20, 2016
Makefile.psl1ght Move netlogger.c to network/ May 9, 2016
Makefile.psp1 Add HAVE_LANGEXTRA Jun 7, 2016
Makefile.psp1.salamander Add file_path_str.c to PSP Salamander Jun 20, 2016
Makefile.vita.salamander (VITA) Initial Salamander Sep 7, 2016
Makefile.wii.salamander Add file_path_str for Salamander Jun 28, 2016
Makefile.win Get rid of HAVE_ZLIB_DEFLATE - implicitly enable it Aug 2, 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 Add coverity badge Sep 6, 2016
autosave.h Cleanups Sep 1, 2016
cheevos.c (cheevos.c) Prevent memory leak Sep 22, 2016
cheevos.h added /info rest service to the embedded http server Sep 3, 2016
command.c Turn command_event_save_current_config into static function Sep 24, 2016
command.h Move more global->savefiles usage to task_save.c Sep 19, 2016
config.def.h Start adding a WiFi driver Sep 22, 2016
config.features.h config.features.h - add HAVE_OPENGLES_3_1 / HAVE_OPENGLES_3_2 Jul 1, 2016
config_file_userdata.c Resource leaks fixes (catched by Coverity) May 26, 2016
config_file_userdata.h Move config_file_userdata outside libretro-common Mar 21, 2016
configuration.c configuration.c - prevent dereference after null warning from Coverity Sep 24, 2016
configuration.h Correctly save and load WiFi driver from the config file Sep 22, 2016
configure (qb) Add qb.system.sh Jun 16, 2015
content.h Cleanups Sep 1, 2016
core.h Revert "Refactor core_system_info_* functions" Sep 6, 2016
core_impl.c Get rid of unused variable Sep 16, 2016
core_info.c Remove some HAVE_ZLIB ifdefs Sep 19, 2016
core_info.h Update core_info_find Jul 9, 2016
core_type.h Add Start Video Processor menu entry Jul 28, 2016
database_info.c Add HAVE_CONFIG_H ifdefs Sep 6, 2016
database_info.h Cleanups Sep 18, 2016
defaults.h add default menu content Aug 29, 2016
dirs.c Prevent null pointer dereference / logically dead code / other misc. … Sep 23, 2016
dirs.h Move code from runloop.c to dirs.c Sep 23, 2016
driver.c Start adding a WiFi driver Sep 22, 2016
driver.h Start adding a WiFi driver Sep 22, 2016
dynamic.c Move runloop_fullpath to paths.c Sep 23, 2016
dynamic.h Cleanups Sep 12, 2016
fetch-submodules.sh Add --recursive in case submodules have third-party dependencies Sep 11, 2016
file_path_special.c Start using path_ functions for accessing and modifying global->path.… Sep 17, 2016
file_path_special.h fix a couple of nits Sep 6, 2016
file_path_str.c Add HAVE_CONFIG_H ifdefs Sep 6, 2016
lakka.h Connman driver: this should allow connecting protected networks Sep 23, 2016
list_special.c Start adding a WiFi driver Sep 22, 2016
list_special.h Start adding a WiFi driver Sep 22, 2016
movie.c Move code to movie.c Sep 16, 2016
movie.h Move code to movie.c Sep 16, 2016
msg_hash.c create 7z archive backend, enables scanning of 7z content Sep 18, 2016
msg_hash.h Display WiFi menu title and perform a scan before calling the services Sep 22, 2016
no-xib.diff Add no-xib.diff Oct 13, 2015
patch.c Fix logically dead code warning Sep 23, 2016
patch.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files Jun 3, 2016
paths.c Move runloop_fullpath to paths.c Sep 23, 2016
paths.h Move runloop_fullpath to paths.c Sep 23, 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 (Menu) Get Remove from Playlist to work on history playlists Aug 29, 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 Move runloop_fullpath to paths.c Sep 23, 2016
retroarch.cfg (OSX) Buildfix Sep 21, 2016
retroarch.desktop (Linux) Add a GenericName to the desktop entry Jun 18, 2015
retroarch.h Getr id of unused function prototype Sep 22, 2016
runloop.c Move runloop_fullpath to paths.c Sep 23, 2016
runloop.h Move runloop_fullpath to paths.c Sep 23, 2016
setting_list.c (Menu) Fix keyboard input Sep 22, 2016
setting_list.h Compiles without HAVE_MENU defined again Sep 8, 2016
verbosity.c Buildfix Sep 19, 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 -(http://buildbot.libretro.com/).

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:

  • PlayStation3
  • 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.

PlayStation3

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

PlayStation3 - 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.