Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2017-09-17 02:38:54 -07:00
.github
audio Reduce more stack usage for offending functions 2017-09-09 05:26:14 +02:00
bootstrap
camera FreeBSD buildfix 2017-08-17 20:28:47 -04:00
cheevos Cast ctype args to unsigned char 2017-08-08 12:21:48 +01:00
cores Add retro_timers.h/retro_math.h 2017-06-28 04:41:38 +02:00
ctr
defines Start going through compilation errors 2017-09-05 00:57:58 +02:00
deps clang supports GCC block expressions 2017-09-17 02:38:54 -07:00
dist-scripts Bump up version to 1.6.7 2017-08-17 21:09:42 +02:00
docs
emscripten
frontend (Xbox) Silence warning 2017-09-13 04:35:57 +02:00
gfx Fix some Xbox unresolved symbols 2017-09-14 22:24:04 +02:00
griffin Fix build 2017-09-14 22:56:31 +02:00
input Merge pull request #5438 from casdevel/fix5215 2017-09-12 21:14:56 +02:00
intl start implementing keymapper gui 2017-09-11 00:21:46 -05:00
libretro-common common: integrate chd into interface stream 2017-09-17 02:02:04 -07:00
libretro-db VC6 support (targets NT 3.51) 2017-09-06 23:03:02 -04:00
location
managers Cleanups 2017-05-21 16:43:40 +02:00
media update icons 2017-08-09 13:04:56 -05:00
memory
menu (360) Builds again(360) Builds again(360) Builds again(360) Builds 2017-09-13 04:33:43 +02:00
network VC6 support (targets NT 3.51) 2017-09-06 23:03:02 -04:00
pkg (360) Update 2017-09-14 22:50:36 +02:00
qb deps: import libFLAC 2017-09-17 02:02:04 -07:00
record Add retro_timers.h/retro_math.h 2017-06-28 04:41:38 +02:00
tasks task_database: rework cd scanning 2017-09-17 02:11:07 -07:00
tools ps3: use python2 for pkg.py script 2017-08-06 20:17:00 -04:00
ui (ui_win32.c) Style nits/cleanups 2017-09-07 16:42:34 +02:00
wifi
wii Update 2017-08-20 00:54:39 +02:00
wiiu [WiiU] DRC touch support as pointer device 2017-08-19 17:40:56 +10:00
.editorconfig
.gitignore Add Wii U files to .gitignore 2017-06-15 15:20:05 +10:00
.project
.travis.yml
autosave.h
CHANGES.md Update CHANGES.md 2017-09-11 06:20:04 +02:00
command.c reset controllers when the core has set controller info 2017-09-12 02:02:52 -05:00
command.h add input_mapper scafolding 2017-09-11 00:20:20 -05:00
config.def.h (MaterialUI) Add Menu Icons Enable setting 2017-08-17 21:05:38 +02:00
config.def.keybinds.h
config.features.h TinyALSA support 2017-06-23 20:44:00 -05:00
configuration.c input remapping cleanups 2017-09-11 22:49:39 -05:00
configuration.h fix defaults 2017-09-11 00:21:47 -05:00
configure
content.h
CONTRIBUTING.md
COPYING
core_impl.c (Menu) Menu driver no longer uses a duplicate system info 2017-05-28 17:21:57 +02:00
core_info.c Cleanups 2017-09-11 00:12:26 +02:00
core_info.h
core_type.h
core.h Revert "New attempt to fix memory leaks of struct retro_system_info" 2017-05-30 01:44:49 +02:00
database_info.c Reduce stack usage 2017-09-09 21:41:38 +02:00
database_info.h move content list builder into scanner task with progress, fixes menu freeze with large playlists 2017-07-09 00:44:02 -04:00
defaults.h (XMB) Display favorites tab, part 2 2017-08-12 17:10:14 +02:00
diff.diff
dirs.c (dirs.c/task_content.c) reduce stack usage 2017-09-10 21:42:24 +02:00
dirs.h
driver.c Revert "Reduce size of variables" 2017-09-09 00:20:39 +02:00
driver.h Fix driver menu left wrap 2017-07-11 21:00:44 -04:00
dynamic.c Reduce stack usage 2017-09-09 21:41:38 +02:00
dynamic.h Add RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT 2017-08-07 18:06:03 +02:00
fetch-submodules.sh
file_path_special.c (file_path_special.c) Reduce stack usage 2017-09-10 21:27:50 +02:00
file_path_special.h (XMB) Display favorites tab, part 2 2017-08-12 17:10:14 +02:00
file_path_str.c (XMB) Display favorites tab, part 2 2017-08-12 17:10:14 +02:00
lakka.h
list_special.c Merge input_hid_driver 2017-06-11 08:56:36 +02:00
list_special.h
Makefile
Makefile.common common: add chd_stream interface 2017-09-17 02:02:04 -07:00
Makefile.ctr
Makefile.ctr.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.emscripten
Makefile.griffin griffin msvc2012/2013: find Win8.1 SDK installation path if not using custom toolchain 2017-09-12 05:52:20 +00:00
Makefile.libogc Update 2017-08-20 00:54:39 +02:00
Makefile.openpandora Bump up version to 1.6.7 2017-08-17 21:09:42 +02:00
Makefile.pandora
Makefile.ps3 Bump up version to 1.6.7 2017-08-17 21:09:42 +02:00
Makefile.ps3.cobra Bump up version to 1.6.7 2017-08-17 21:09:42 +02:00
Makefile.ps3.salamander (PS3) Fix Salamander 2017-08-06 14:12:09 +02:00
Makefile.psl1ght Bump up version to 1.6.7 2017-08-17 21:09:42 +02:00
Makefile.psp1
Makefile.psp1.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.vita adding cheevos support to Vita port 2017-07-06 07:19:17 -03:00
Makefile.vita.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.wii.salamander Update 2017-08-19 09:03:10 +02:00
Makefile.wiiu Add missing_libc_functions.c (for DOSBox) 2017-06-15 15:21:38 +10:00
Makefile.wiiu.salamander Add encoding_utf to Salamander 2017-08-06 13:58:17 +02:00
Makefile.win
movie.c start fixing bsv recording 2017-05-29 22:49:12 -05:00
movie.h
msg_hash.c msg_hash: support chd files 2017-09-17 02:02:04 -07:00
msg_hash.h msg_hash: support chd files 2017-09-17 02:02:04 -07:00
no-xib.diff
paths.c paths.c - reduce stack size 2017-09-09 22:32:39 +02:00
paths.h
performance_counters.c VC6 support (targets NT 3.51) 2017-09-06 23:03:02 -04:00
performance_counters.h
playlist.c (playlist.c) Fix clear/free loop conditionals 2017-08-19 08:40:09 -03:00
playlist.h (playlist.c) Don't expose struct details to outside 2017-07-01 03:38:36 +02:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Update README.md 2017-08-26 10:26:18 +01:00
retroarch-mingw-build.sh
retroarch.c add input_mapper scafolding 2017-09-11 00:20:20 -05:00
retroarch.cfg Disable showing hidden files by default 2017-06-21 10:46:32 -04:00
retroarch.desktop
retroarch.h Reorder variables 2017-09-09 19:58:09 +02:00
setting_list.c Reduce stack usage for menu_setting_new_internal 2017-09-09 06:10:58 +02:00
setting_list.h Reduce stack usage for menu_setting_new_internal 2017-09-09 06:10:58 +02:00
verbosity.c Clean up the log output 2017-07-04 21:46:22 -04:00
verbosity.h Clean up the log output 2017-07-04 21:46:22 -04:00
version_git.c
version_git.h
version.h Bump up version to 1.6.7 2017-08-17 21:09:42 +02: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".

XMB menu driver

rgui menu driver

glui menu driver

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.