Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Hans-Kristian Arntzen 8cab56e806 Vulkan: Attempt workaround for Ivy Bridge.
Reset command buffer instead of pool.
2016-02-21 20:13:22 +01:00
audio Before unloading game, make sure we stop the threaded audio driver. 2016-02-20 10:28:39 +01:00
bootstrap (psp1) move kernel_functions.prx to the root folder after build 2015-09-23 23:08:01 +01:00
camera Try to reduce dependence on general.h 2016-02-07 13:18:48 +01:00
cores Vulkan: Attempt workaround for Ivy Bridge. 2016-02-21 20:13:22 +01:00
ctr (3DS) another build tools update. 2016-01-16 03:51:48 +01:00
defines (GX) Resolution Saving's Video Corruption Fix. 2016-02-12 16:58:59 -05:00
deps Vulkan implementation. 2016-02-16 20:42:02 +01:00
dist-scripts dist-cores.sh : Add big stack rule for unix target 2016-02-05 17:38:09 +01:00
docs
emscripten Backport this - 58748da89d 2015-07-27 00:08:25 +02:00
frontend Silence unused variable warning 2016-02-21 13:10:49 +01:00
gfx Vulkan: Add workaround for broken VkImageView swizzling. 2016-02-21 13:52:30 +01:00
griffin Rename glx context driver to x 2016-02-20 05:48:45 +01:00
input remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
intl (OSX) Silence warnings 2016-02-13 22:31:49 +01:00
libretro-common Updates to glsm 2016-02-12 01:42:33 +01:00
libretro-db Merge pull request #2693 from lakkatv/master 2016-02-04 15:24:34 +01:00
location Create RARCH_DRIVER_CTL_FIND_INDEX 2016-02-01 13:15:53 +01:00
media Move win32_resource.h 2015-11-19 07:59:10 +01:00
memory (GX) Resolution Saving's Video Corruption Fix. 2016-02-12 16:58:59 -05:00
menu remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
netplay (netplay) Style nits 2016-02-03 17:05:32 +01:00
pkg allow a debuggable release build for the buildbot 2016-02-12 01:09:33 -05:00
qb Start making GL optional (previously we assumed pretty much - hardware 2016-02-20 06:16:34 +01:00
record Vulkan implementation. 2016-02-16 20:42:02 +01:00
tasks Combine file_ops.c and content.c 2016-02-15 21:49:29 +01:00
tests Rename rarch_main_ctl to runloop_ctl 2015-11-30 21:42:59 +01:00
tools Kill off IS_JOYCONFIG 2015-11-11 20:15:27 +01:00
ui Add SHADER_CTL_GET_CURRENT_SHADER 2016-02-14 22:13:21 +01:00
wii/app_booter (wii/app_booter) Style nits 2015-09-21 19:28:20 +02:00
.empty
.gitignore Vulkan implementation. 2016-02-16 20:42:02 +01:00
.gitmodules Vulkan implementation. 2016-02-16 20:42:02 +01:00
.project
autosave.c Refactor autosave.c to use new callback 2016-01-28 03:10:47 +01:00
autosave.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00
cheats.c Cleanups 2016-02-13 06:24:49 +01:00
cheats.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00
cheevos.c Create CHEEVOS_CTL_GET_DESCRIPTION 2016-02-13 06:30:39 +01:00
cheevos.h Create CHEEVOS_CTL_GET_DESCRIPTION 2016-02-13 06:30:39 +01:00
command_event.c remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
command_event.h remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
command.c Vulkan implementation. 2016-02-16 20:42:02 +01:00
command.h Add rarch_cmd_ctl 2016-02-13 07:19:21 +01:00
config.def.h Vulkan implementation. 2016-02-16 20:42:02 +01:00
config.features.h Add feature to print_features 2016-02-17 01:55:35 +01:00
configuration.c remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
configuration.h remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
configure (qb) Add qb.system.sh 2015-06-16 20:46:11 -03:00
content.c Add log 2016-02-16 05:42:45 +01:00
content.h Add CONTENT_CT_LOAD 2016-02-16 05:34:33 +01:00
CONTRIBUTING.md
COPYING
core_info.c Revert "Remove core_info_list_num_info_files" 2016-02-11 07:20:04 +01:00
core_info.h Revert "Remove core_info_list_num_info_files" 2016-02-11 07:20:04 +01:00
core_options.c stdstring - create string_is_equal 2016-01-20 04:07:24 +01:00
core_options.h Nits 2016-02-04 20:58:53 +01:00
database_info.c Try to reduce dependence on general.h 2016-02-07 13:18:48 +01:00
database_info.h Header include changes 2016-02-05 13:57:08 +01:00
defaults.h Nits 2016-02-04 20:58:53 +01:00
dir_list_special.c Vulkan implementation. 2016-02-16 20:42:02 +01:00
dir_list_special.h Header include changes 2016-02-07 01:50:08 +01:00
driver.c Move comment to driver.c 2016-02-11 02:29:49 +01:00
driver.h Move comment to driver.c 2016-02-11 02:29:49 +01:00
dynamic.c Vulkan implementation. 2016-02-16 20:42:02 +01:00
dynamic.h Nits 2016-02-04 20:58:53 +01:00
fetch-submodules.sh
file_path_special.c (Linux) Restarting of core in non-HAVE_DYNAMIC mode now properly 2016-02-05 19:16:35 +01:00
general.h Cleanups 2016-02-05 13:51:30 +01:00
git_version.c Start updating headers for 2016 2016-01-10 04:06:50 +01:00
git_version.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00
libretro_version_1.c Before unloading game, make sure we stop the threaded audio driver. 2016-02-20 10:28:39 +01:00
libretro_version_1.h Header include changes 2016-02-05 14:00:27 +01:00
libretro_vulkan.h Vulkan implementation. 2016-02-16 20:42:02 +01:00
libretro.h Vulkan implementation. 2016-02-16 20:42:02 +01:00
Makefile Vulkan implementation. 2016-02-16 20:42:02 +01:00
Makefile.common Start making GL optional (previously we assumed pretty much - hardware 2016-02-20 06:16:34 +01:00
Makefile.ctr Make HAVE_LIBRETRO_MANAGEMENT define obsolete 2016-02-03 12:31:29 +01:00
Makefile.emscripten Makefile.emscripten - add HAVE_EGL 2015-11-20 17:41:50 +01:00
Makefile.griffin Make HAVE_LIBRETRO_MANAGEMENT define obsolete 2016-02-03 12:31:29 +01:00
Makefile.openpandora
Makefile.pandora Move pandora files 2015-09-20 15:41:28 +02:00
Makefile.ps3 (PS3) Take out LIBRETRODB and silence some warnings 2016-02-07 00:04:00 +01:00
Makefile.ps3.cobra Make HAVE_LIBRETRO_MANAGEMENT define obsolete 2016-02-03 12:31:29 +01:00
Makefile.ps3.salamander (frontend) Start using string_is_empty 2015-12-26 07:45:19 +01:00
Makefile.psl1ght Move files around 2015-09-20 15:26:10 +02:00
Makefile.psp1 Make HAVE_LIBRETRO_MANAGEMENT define obsolete 2016-02-03 12:31:29 +01:00
Makefile.psp1.salamander (frontend) Start using string_is_empty 2015-12-26 07:45:19 +01:00
Makefile.wii.salamander (frontend) Start using string_is_empty 2015-12-26 07:45:19 +01:00
Makefile.win Replace most instances of GLUI (except for ident string) with 2015-11-02 23:23:54 +01:00
movie.c Cleanups 2016-02-07 01:56:03 +01:00
movie.h Cleanups 2016-02-07 01:56:03 +01:00
msg_hash.c use more string_is_equal 2016-01-20 05:21:52 +01:00
msg_hash.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00
net_http_special.c Cleanup 2016-01-27 05:55:26 +01:00
net_http_special.h Cleanup 2016-02-04 20:56:22 +01:00
netlogger.c Start updating headers for 2016 2016-01-10 04:06:50 +01:00
no-xib.diff Add no-xib.diff 2015-10-13 23:23:33 +02:00
patch.c Combine file_ops.c and content.c 2016-02-15 21:49:29 +01:00
patch.h Move function prototype to patch.c 2016-02-07 01:46:20 +01:00
performance.c (GX) Resolution Saving's Video Corruption Fix. 2016-02-12 16:58:59 -05:00
performance.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00
playlist.c only check for identical paths, not CRC too 2016-01-26 22:10:42 -05:00
playlist.h Style nits 2016-02-03 17:20:36 +01:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Update README.md 2016-01-13 20:58:24 +01:00
remote.c Try to reduce dependence on general.h 2016-02-07 13:18:48 +01:00
remote.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00
retroarch-mingw-build.sh
retroarch.c remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
retroarch.cfg Improve explanation 2016-01-27 01:37:52 +01:00
retroarch.desktop (Linux) Add a GenericName to the desktop entry 2015-06-18 09:49:14 -07:00
retroarch.h Remove stdin stub paths 2016-02-17 07:15:51 +01:00
rewind.c Try to reduce dependence on general.h 2016-02-07 13:18:48 +01:00
rewind.h Turn some functions static 2016-02-01 12:46:46 +01:00
runloop.c Move this check - this should serve as a framerate limiter for the 2016-02-21 12:11:08 +01:00
runloop.h remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
screenshot.c Create RARCH_DISPLAY_CTL_VIEWPORT_INFO 2016-02-14 05:42:27 +01:00
screenshot.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00
string_list_special.c (GX) Resolution Saving's Video Corruption Fix. 2016-02-12 16:58:59 -05:00
string_list_special.h Remove unused STRING_LIST_CORES_NAMES 2016-02-07 15:54:37 +01:00
system.h write to game options files if created instead of the main options file 2016-01-31 01:54:57 -05:00
verbosity.c stdstring - create string_is_equal 2016-01-20 04:07:24 +01:00
verbosity.h Start updating headers for 2016 2016-01-10 04:06:50 +01:00

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.

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)
  • Raspberry Pi
  • Android
  • iOS
  • Blackberry

Dependencies (PC)

On Windows, RetroArch can run with only Win32 as dependency. On Linux, you need:

  • GL 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

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