Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2016-10-21 04:45:40 +02:00
audio audio_driver_flush - prevent implicit memset 2016-10-19 03:48:34 +02:00
bootstrap (VITA) Allow cores to define heap size 2016-10-11 09:40:55 +02:00
camera (camera_driver.c) Prevent null pointer dereference 2016-09-28 08:18:28 +02:00
cores +1 is better than the alternative. 2016-10-01 19:48:28 +02:00
ctr (3DS) wrap texture coordinate swizzeling in a function. 2016-10-10 22:22:08 +01:00
defines Merge pull request #3697 from d3m3vilurr/vita-extend-input 2016-09-30 19:33:04 +02:00
deps (VITA) Try to use NEON 2016-10-17 18:39:53 +02:00
dist-scripts (VITA) Enable database support 2016-10-10 11:43:05 +02:00
docs mark these as deprecated 2016-08-27 21:56:37 -05:00
emscripten move these files over to the package dir 2016-08-28 19:09:55 -05:00
frontend Create runloop_poll 2016-10-20 02:17:17 +02:00
gfx Fix for zarch menu 2016-10-20 20:29:46 -06:00
griffin Create sublabel callbacks 2016-10-20 15:57:35 +02:00
input Cleanups 2016-10-20 03:42:57 +02:00
intl add missing strings to jp translation file 2016-10-20 21:16:23 -04:00
libretro-common fix asimd detection 2016-10-18 17:18:33 +02:00
libretro-db Revert "Use string_is_equal" 2016-10-04 10:29:32 +02:00
location location_driver_ctl - return 'true' by default 2016-09-29 12:13:46 +02:00
managers Prevent 'undefined allocation of 0 bytes' 2016-09-22 21:59:37 +02:00
media use invader instead 2016-09-09 22:03:50 -05:00
memory
menu Add sublabels 2016-10-21 01:29:54 +02:00
network netplay_common.c - Buildfix for MSVC 2016-10-19 18:09:59 +02:00
pkg Remove DONT_HAVE_STATE_TRACKER 2016-10-20 05:11:35 +02:00
qb Make thread local storage optional 2016-10-17 21:24:03 -03:00
record Merge fixes 2016-10-01 08:24:02 +02:00
tasks Prevent implicit memsets 2016-10-16 01:31:06 +02:00
tools chmod +x on pkg.py 2016-08-12 00:09:22 +02:00
ui Create runloop_poll 2016-10-20 02:17:17 +02:00
wifi Improve status reporting in the connman wifi driver 2016-09-27 16:45:37 +02:00
wii/app_booter
.editorconfig Add EditorConfig support 2016-09-16 10:44:33 -04:00
.gitignore Revert "Append _debug to debug builds and add file to .gitignore" 2016-09-08 18:23:26 +02:00
.gitmodules
.project
.travis.yml Update Scan Coverity key 2016-09-17 18:59:24 +02:00
autosave.h Cleanups 2016-09-01 04:57:04 +02:00
cheevos.c Add dots at the end of strings 2016-10-20 18:00:54 +02:00
cheevos.h added /info rest service to the embedded http server 2016-09-03 17:50:04 +01:00
command.c More translated strings 2016-10-20 18:23:34 +02:00
command.h Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
config_file_userdata.c
config_file_userdata.h
config.def.h (PS3) Set a more appropriated value to fix overscan on GLUI 2016-10-16 14:42:40 +02:00
config.features.h Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
configuration.c Prevent more implicit memsets 2016-10-20 18:36:01 +02:00
configuration.h Add possibility to switch touch surface on vita build 2016-10-15 13:28:35 +02:00
configure
content.h mute state-related OSD messages when auto-saving 2016-10-04 17:58:16 -04:00
CONTRIBUTING.md
COPYING
core_impl.c fall gracefully back to the menu if a dynamic core could not be loaded 2016-10-11 20:28:36 -04:00
core_info.c remove zip requirement for archives downloaded from network, same for detecting cores for files when loading archive with core 2016-10-13 15:04:26 -04:00
core_info.h only scan the content databases that support the file's extension 2016-10-03 16:09:10 -04:00
core_type.h
core.h Switching serialization quirks to uint64_t for consistency with other 2016-10-04 23:07:35 -04:00
database_info.c (database_info.c) Remove implicit memsets 2016-10-08 18:44:24 +02:00
database_info.h database_info.h - Add retro_miscellaneous.h 2016-09-29 11:04:24 +02:00
defaults.h add default menu content 2016-08-28 23:21:29 -05:00
dirs.c Cleanups - prevent implicit memsets 2016-10-16 02:00:59 +02:00
dirs.h Create dir_set function 2016-10-03 08:20:33 +02:00
driver.c Prevent implicit memsets 2016-10-09 09:05:41 +02:00
driver.h Start adding a WiFi driver 2016-09-22 02:02:43 +02:00
dynamic.c fall gracefully back to the menu if a dynamic core could not be loaded 2016-10-11 20:28:36 -04:00
dynamic.h fall gracefully back to the menu if a dynamic core could not be loaded 2016-10-11 20:28:36 -04:00
fetch-submodules.sh Add --recursive in case submodules have third-party dependencies 2016-09-11 19:43:16 -04:00
file_path_special.c Create path_is_empty 2016-09-30 04:43:16 +02:00
file_path_special.h fix a couple of nits 2016-09-05 22:49:31 -05:00
file_path_str.c add slang shader menu entry to online updater 2016-10-08 15:16:01 -05:00
lakka.h Connman driver: this should allow connecting protected networks 2016-09-23 19:50:18 +02:00
list_special.c Start adding a WiFi driver 2016-09-22 02:02:43 +02:00
list_special.h Start adding a WiFi driver 2016-09-22 02:02:43 +02:00
Makefile make the console toggleable at runtime instead of compilation time 2016-10-08 15:33:29 -05:00
Makefile.common Create sublabel callbacks 2016-10-20 15:57:35 +02:00
Makefile.ctr (3DS) enable database support. 2016-10-08 04:38:34 +01:00
Makefile.ctr.salamander (3DS) salamander build fix. 2016-10-08 02:35:54 +01:00
Makefile.emscripten Take out HAVE_BUILTIN_AUTOCONFIG - always include it 2016-10-04 07:33:57 +02:00
Makefile.griffin Attempt fix for Makefile.griffin 2016-10-17 23:53:06 +02:00
Makefile.openpandora
Makefile.pandora
Makefile.ps3 Take out HAVE_BUILTIN_AUTOCONFIG - always include it 2016-10-04 07:33:57 +02:00
Makefile.ps3.cobra Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
Makefile.ps3.salamander
Makefile.psl1ght Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
Makefile.psp1 Take out HAVE_BUILTIN_AUTOCONFIG - always include it 2016-10-04 07:33:57 +02:00
Makefile.psp1.salamander
Makefile.vita.salamander (VITA) Initial Salamander 2016-09-08 01:26:03 +02:00
Makefile.wii.salamander
Makefile.win Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
movie.c Move code to movie.c 2016-09-17 01:54:33 +02:00
movie.h Move code to movie.c 2016-09-17 01:54:33 +02:00
msg_hash.c create 7z archive backend, enables scanning of 7z content 2016-09-18 10:31:21 -04:00
msg_hash.h Add sublabels 2016-10-21 01:29:54 +02:00
no-xib.diff
patch.c Revert "Move global->name to paths.c" 2016-10-01 08:18:23 +02:00
patch.h
paths.c Cleanups - prevent implicit memsets 2016-10-16 02:00:59 +02:00
paths.h Get rid of path_get_core_size 2016-10-03 16:17:08 +02:00
performance_counters.c Get rid of more general.h includes 2016-09-01 18:01:41 +02:00
performance_counters.h
playlist.c playlist_read_file - prevent implicit slow memsets 2016-10-09 09:07:53 +02:00
playlist.h (Menu) Get Remove from Playlist to work on history playlists 2016-08-29 02:22:05 +02:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Add coverity badge 2016-09-05 22:43:42 -05:00
retroarch-mingw-build.sh
retroarch.c ASIMD also in retroarch.c 2016-10-18 17:39:02 +02:00
retroarch.cfg (OSX) Buildfix 2016-09-21 02:30:21 +02:00
retroarch.desktop
retroarch.h (retroarch.c) Add RARCH_CTL_IS_MAIN_THREAD 2016-10-17 20:50:19 -03:00
runloop.c Don't grab settings pointer 2016-10-21 04:42:57 +02:00
runloop.h Get rid of runloop_ctl actions 2016-10-21 03:46:17 +02:00
setting_list.c (Menu) Fix keyboard input 2016-09-22 18:29:40 +02:00
setting_list.h Compiles without HAVE_MENU defined again 2016-09-08 14:25:14 +02:00
verbosity.c (MSVC) Buildfix 2016-10-09 17:17:29 +02:00
verbosity.h Cleanups 2016-09-12 16:36:27 +02:00
version_git.c Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +02:00
version_git.h Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +02:00
version.h Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +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".

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.