Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Arzed Five 051cc3fe4d Undo Save State currently seems to be working almost as intended
(missing OSD messages). Undo Load State isn't working yet.
2016-06-08 20:27:54 +01:00
audio Merge pull request #3077 from aliaspider/master 2016-06-05 23:03:03 +02:00
bootstrap
camera use retro_common_api.h 2016-06-03 05:38:40 +02:00
cores Rename HAVE_NETWORK_GAMEPAD to HAVE_NETWORKGAMEPAD - and 2016-06-07 15:23:07 +02:00
ctr (3DS) the parallax layer register can be written to from userland with 2016-04-18 15:22:41 +01:00
defines (VITA) build fix for latest sdk. 2016-06-05 22:01:25 +01:00
deps Update the menu driver to work with the latest version 2016-05-24 21:41:51 -05:00
dist-scripts bump up version 2016-04-30 10:12:28 -05:00
docs Move man pages to man6 to satisfy man standard sections 2016-05-22 17:05:13 -07:00
emscripten
frontend Use retro_common_api.h 2016-06-03 06:02:49 +02:00
gfx Remove this header 2016-06-08 08:19:06 +02:00
griffin Add to Makefile files 2016-06-08 15:52:58 +02:00
input Rename HAVE_NETWORK_GAMEPAD to HAVE_NETWORKGAMEPAD - and 2016-06-07 15:23:07 +02:00
intl fix a few message issues with undo operations 2016-06-04 19:27:17 -05:00
libretro-common (Win32) Implement application process events 2016-06-07 17:28:51 +02:00
libretro-db (libretrodb) Prevent uninitialized scalar variable 2016-06-05 19:18:54 +02:00
location use retro_common_api.h 2016-06-03 05:38:40 +02:00
managers Use retro_common_api.h 2016-06-03 05:49:46 +02:00
media Updates to drag and drop: 2016-06-03 16:00:08 +10:00
memory (GX) Resolution Saving's Video Corruption Fix. 2016-02-12 16:58:59 -05:00
menu (nk_common.c) Add HAVE_GLSL ifdef 2016-06-08 05:32:45 +02:00
network Move netplay code to network/netplay dir 2016-05-19 11:46:54 +02:00
pkg (OSX) Fixes 2016-06-08 07:41:59 +02:00
qb Rename HAVE_NETWORK_GAMEPAD to HAVE_NETWORKGAMEPAD - and 2016-06-07 15:23:07 +02:00
record use retro_common_api.h 2016-06-03 05:38:40 +02:00
tasks Undo Save State currently seems to be working almost as intended 2016-06-08 20:27:54 +01:00
tests
tools (tools/cg2glsl.py) Write uniform declarations for fragment shaders. 2016-03-05 12:49:21 +01:00
ui Free heap variable 2016-06-08 17:56:09 +02:00
wii/app_booter
.empty
.gitignore Vulkan implementation. 2016-02-16 20:42:02 +01:00
.gitmodules Vulkan: Move to SPIRV-Cross. 2016-05-08 12:43:58 +02:00
.project
autosave.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
cheevos.c C89_BUILD fixes 2016-06-07 00:03:07 +02:00
cheevos.h Fix some silly copypasta. 2016-06-04 17:46:11 +02:00
command.c Undo Save State currently seems to be working almost as intended 2016-06-08 20:27:54 +01:00
command.h add menu entry for undo save state 2016-06-04 14:34:06 -05:00
config_file_userdata.c Resource leaks fixes (catched by Coverity) 2016-05-26 17:26:55 +02:00
config_file_userdata.h Move config_file_userdata outside libretro-common 2016-03-21 18:49:50 +01:00
config.def.h (GX) only apply better gamma setting to wii and use old setting on ngc 2016-06-05 18:57:29 +02:00
config.features.h Rename HAVE_NETWORK_GAMEPAD to HAVE_NETWORKGAMEPAD - and 2016-06-07 15:23:07 +02:00
configuration.c Rename HAVE_NETWORK_GAMEPAD to HAVE_NETWORKGAMEPAD - and 2016-06-07 15:23:07 +02:00
configuration.h Add HAVE_LANGEXTRA 2016-06-07 06:05:41 +02:00
configure
content.h Undo Save State currently seems to be working almost as intended 2016-06-08 20:27:54 +01:00
CONTRIBUTING.md
COPYING
core_impl.c Move netplay code to network/netplay dir 2016-05-19 11:46:54 +02:00
core_info.c Fix unchecked return value warnings 2016-06-02 23:00:11 +02:00
core_info.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
core_type.h Start adding internal network retropad core hooks 2016-05-26 19:43:15 +02:00
core.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
database_info.c Free info->genre 2016-05-24 00:33:12 +02:00
database_info.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
defaults.h Rename content_playlist_ to playlist_ 2016-05-16 09:07:44 +02:00
driver.c Cleanups 2016-06-03 04:37:10 +02:00
driver.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
dynamic.c Rename HAVE_NETWORK_GAMEPAD to HAVE_NETWORKGAMEPAD - and 2016-06-07 15:23:07 +02:00
dynamic.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS 2016-06-03 02:39:35 +02:00
fetch-submodules.sh
file_path_special.c Cleanups 2016-05-02 13:23:47 +02:00
file_path_special.h Buildfix for consoles 2016-05-01 15:59:55 +02:00
general.h bump up version 2016-04-30 10:12:28 -05:00
git_version.c Rename rarch_git_version to retroarch_git_version 2016-05-11 20:44:24 +02:00
git_version.h use retro_common_api.h 2016-06-03 05:38:40 +02:00
lakka.h (Menu) Unhardcode Lakka Update Dir 2016-03-23 21:40:41 +07:00
list_special.c Make HAVE_HID completely optional 2016-06-07 03:01:33 +02:00
list_special.h (input_autodetect.c) Use dir_list_new_special 2016-05-21 13:31:41 +02:00
Makefile fix mwindows flag on the makefile 2016-06-02 23:38:04 -05:00
Makefile.common Add to Makefile files 2016-06-08 15:52:58 +02:00
Makefile.ctr Add extra image format support to targets 2016-05-18 13:39:42 +02:00
Makefile.emscripten Remove WANT_RPNG 2016-05-17 13:41:40 +02:00
Makefile.griffin Add HAVE_LANGEXTRA 2016-06-07 06:05:41 +02:00
Makefile.openpandora Remove WANT_RPNG 2016-05-17 13:41:40 +02:00
Makefile.pandora
Makefile.ps3 Add HAVE_LANGEXTRA 2016-06-07 06:05:41 +02:00
Makefile.ps3.cobra Make HAVE_LIBRETRO_MANAGEMENT define obsolete 2016-02-03 12:31:29 +01:00
Makefile.ps3.salamander Move netplay code to network/netplay dir 2016-05-19 11:46:54 +02:00
Makefile.psl1ght Move netlogger.c to network/ 2016-05-09 17:45:21 +02:00
Makefile.psp1 Add HAVE_LANGEXTRA 2016-06-07 06:05:41 +02:00
Makefile.psp1.salamander Rename retro_file to file_stream 2016-03-20 16:29:14 +01:00
Makefile.wii.salamander Move netplay code to network/netplay dir 2016-05-19 11:46:54 +02:00
Makefile.win No need to remove function names, they don't slow anything down and they're invaluable for crash debugging. 2016-05-06 20:20:21 +02:00
movie.c Rename rarch_ functions 2016-05-09 07:09:26 +02:00
movie.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS 2016-06-03 02:39:35 +02:00
msg_hash.c Add HAVE_LANGEXTRA 2016-06-07 06:05:41 +02:00
msg_hash.h fix a few message issues with undo operations 2016-06-04 19:27:17 -05:00
no-xib.diff
patch.c Move struct to top 2016-05-27 17:29:12 +02:00
patch.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
performance_counters.c Rename more performance counter functions 2016-05-16 10:03:31 +02:00
performance_counters.h Use retro_common_api.h 2016-06-03 06:02:49 +02:00
playlist.c Create RFILE_MODE_READ_TEXT 2016-06-03 03:14:42 +02:00
playlist.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS 2016-06-03 02:39:35 +02:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Edit README.md 2016-02-24 18:52:44 +01:00
retroarch-mingw-build.sh
retroarch.c Cleanup 2016-06-05 19:39:57 +02:00
retroarch.cfg revert the default config 2016-04-30 14:34:48 -05:00
retroarch.desktop
retroarch.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS 2016-06-03 02:39:35 +02:00
runloop.c Cleanups 2016-06-03 04:37:10 +02:00
runloop.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
system.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
verbosity.c Reimplement verbosity 2016-05-31 04:42:04 +02:00
verbosity.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02: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)
  • 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.