Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
IlDucci 76ef4bd44a Updating Spanish Translation
Adding changes to the Spanish translation
2016-02-28 22:30:31 +01:00
audio Before unloading game, make sure we stop the threaded audio driver. 2016-02-20 10:28:39 +01:00
bootstrap
camera Try to reduce dependence on general.h 2016-02-07 13:18:48 +01:00
cores Take out async job code from imageviewer core 2016-02-22 18:18:12 +01:00
ctr
defines (GX) Resolution Saving's Video Corruption Fix. 2016-02-12 16:58:59 -05:00
deps Merge pull request from fr500/master 2016-02-25 20:57:31 +01:00
dist-scripts dist-cores.sh : Add big stack rule for unix target 2016-02-05 17:38:09 +01:00
docs
emscripten
frontend Cleanups 2016-02-25 19:33:46 +01:00
gfx Add option for menu linear filter 2016-02-27 17:30:12 -06:00
griffin Change typo 2016-02-25 23:40:27 +01:00
input (Win32) Buildfix 2016-02-26 22:45:30 +01:00
intl Updating Spanish Translation 2016-02-28 22:30:31 +01:00
libretro-common (config_file.C) Fix segfaultthat happened at freeing of tmp->key 2016-02-28 18:44:07 +01:00
libretro-db Merge pull request from lakkatv/master 2016-02-04 15:24:34 +01:00
location
media
memory (GX) Resolution Saving's Video Corruption Fix. 2016-02-12 16:58:59 -05:00
menu Updating Spanish Translation 2016-02-28 22:30:31 +01:00
netplay
pkg allow a debuggable release build for the buildbot 2016-02-12 01:09:33 -05:00
qb Change typo 2016-02-25 23:40:27 +01:00
record Vulkan implementation. 2016-02-16 20:42:02 +01:00
tasks Add C89 workaround 2016-02-25 22:26:48 +01:00
tests
tools
ui (OSX) Fix build now for real 2016-02-26 13:39:32 +01:00
wii/app_booter
.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
autosave.h
cheats.c Cleanups 2016-02-13 06:24:49 +01:00
cheats.h
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 add boolean wrapper thanks to Alcaro 2016-02-24 16:08:36 -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 Add option for menu linear filter 2016-02-27 17:30:12 -06:00
configuration.h Add option for menu linear filter 2016-02-27 17:30:12 -06:00
configure
content.c 80-char width limit nits 2016-02-26 15:41:28 +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
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
git_version.h
libretro_version_1.c Always poll input even if core doesn't have any input. 2016-02-23 16:28:32 +01:00
libretro_version_1.h Header include changes 2016-02-05 14:00:27 +01:00
libretro_vulkan.h 80-char width limit nits 2016-02-26 15:41:28 +01:00
libretro.h 80-char width limit nits 2016-02-26 15:41:28 +01:00
Makefile Vulkan implementation. 2016-02-16 20:42:02 +01:00
Makefile.common Remove stub xshm video driver for now 2016-02-26 17:29:35 +01:00
Makefile.ctr
Makefile.emscripten
Makefile.griffin
Makefile.openpandora
Makefile.pandora
Makefile.ps3 (PS3) Take out LIBRETRODB and silence some warnings 2016-02-07 00:04:00 +01:00
Makefile.ps3.cobra
Makefile.ps3.salamander
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander
Makefile.wii.salamander
Makefile.win
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 Add preliminary russian translation - can't get it to compile yet 2016-02-24 19:19:24 +01:00
msg_hash.h Add preliminary russian translation - can't get it to compile yet 2016-02-24 19:19:24 +01:00
net_http_special.c
net_http_special.h Cleanup 2016-02-04 20:56:22 +01:00
netlogger.c
no-xib.diff
patch.c Cleanups 2016-02-25 19:33:46 +01:00
patch.h Cleanups 2016-02-25 19:33:46 +01:00
performance.c (C89_BUILD) Fix 2016-02-26 00:47:53 +01:00
performance.h
playlist.c
playlist.h
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Edit README.md 2016-02-24 18:52:44 +01:00
remote.c Try to reduce dependence on general.h 2016-02-07 13:18:48 +01:00
remote.h
retroarch-mingw-build.sh
retroarch.c remove saving remapping, use the automated method instead 2016-02-21 13:55:04 -05:00
retroarch.cfg Change extraction_directory to cache_directory 2016-02-27 03:22:32 +01:00
retroarch.desktop
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
runloop.c Start reimplementing Zarch joypad input 2016-02-26 22:29:10 +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
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
verbosity.c
verbosity.h

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

  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.