Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2017-01-16 20:41:08 -05:00
.github add more fields 2017-01-14 15:16:59 -05:00
audio coreaudio: fix getting device name 2017-01-16 10:26:17 -06:00
bootstrap
camera
cores
ctr
defines
deps
dist-scripts (WiiU) disc script: no need to delete icons. 2017-01-16 18:53:35 +01:00
docs
emscripten
frontend (WiiU) add support for bluetooth controllers (Wiimote, nunchuk, classic 2017-01-16 18:52:39 +01:00
gfx GDI: MSVC2010 build fix 2017-01-16 20:41:08 -05:00
griffin MSVC GDI buildfix 2017-01-16 20:41:05 -05:00
input (input_config.c) Move variable 2017-01-16 21:36:04 +01:00
intl update JP translation 2017-01-16 16:42:48 -05:00
libretro-common (GLSM) Update 2017-01-10 22:53:22 +01:00
libretro-db
location
managers Add block_frames member to audio driver init function; 2017-01-11 07:25:42 +01:00
media disable shader dialog until video_threaded issues are fixed 2017-01-16 19:26:28 -05:00
memory
menu fix msys2 compilation when opengl, vulkan and d3d9 are disabled 2017-01-16 20:41:08 -05:00
network Use autosave_lock and autosave_unlock during SRAM negotiation 2017-01-15 18:10:24 -05:00
pkg Add cores folder to QNX .gitignore 2017-01-09 20:26:09 +00:00
qb fix msys2 compilation when opengl, vulkan and d3d9 are disabled 2017-01-16 20:41:08 -05:00
record
tasks Attempt to fix 'write to pointer after free' issues 2017-01-14 13:51:20 +01:00
tools
ui fix msys2 compilation when opengl, vulkan and d3d9 are disabled 2017-01-16 20:41:08 -05:00
wifi
wii/app_booter
wiiu (WiiU) add support for bluetooth controllers (Wiimote, nunchuk, classic 2017-01-16 18:52:39 +01:00
.editorconfig
.gitignore
.project
.travis.yml
autosave.h
cheevos.c
cheevos.h
command.c Create drivers_init 2017-01-16 22:04:57 +01:00
command.h
config.def.h initial GDI driver skeleton 2017-01-16 20:41:04 -05:00
config.def.keybinds.h
config.features.h
configuration.c initial GDI driver skeleton 2017-01-16 20:41:04 -05:00
configuration.h
configure
content.h
CONTRIBUTING.md
COPYING
core_impl.c
core_info.c Prevent another memory leak 2017-01-13 18:35:20 +01:00
core_info.h
core_type.h
core.h
database_info.c (database_info.c) Only do strdup if val_string is not empty 2017-01-10 23:15:26 +01:00
database_info.h
defaults.h
diff.diff Add diff.diff 2017-01-14 21:35:00 +01:00
dirs.c
dirs.h
driver.c Create drivers_init 2017-01-16 22:04:57 +01:00
driver.h Create drivers_init 2017-01-16 22:04:57 +01:00
dynamic.c Add block_frames member to audio driver init function; 2017-01-11 07:25:42 +01:00
dynamic.h
fetch-submodules.sh
file_path_special.c Small style nit 2017-01-09 22:48:13 +01:00
file_path_special.h
file_path_str.c
lakka.h
list_special.c
list_special.h
Makefile
Makefile.common initial GDI driver skeleton 2017-01-16 20:41:04 -05:00
Makefile.ctr
Makefile.ctr.salamander
Makefile.emscripten
Makefile.griffin
Makefile.openpandora
Makefile.pandora
Makefile.ps3
Makefile.ps3.cobra
Makefile.ps3.salamander
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander
Makefile.vita.salamander
Makefile.wii.salamander
Makefile.wiiu
Makefile.win
movie.c
movie.h
msg_hash.c
msg_hash.h
no-xib.diff
patch.c
patch.h
paths.c
paths.h
performance_counters.c
performance_counters.h
playlist.c
playlist.h
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md
retroarch-mingw-build.sh
retroarch.c Create drivers_init 2017-01-16 22:04:57 +01:00
retroarch.cfg
retroarch.desktop
retroarch.h
runloop.c Split up menu OSK code to separate file - menu/widgets/menu_osk.c 2017-01-12 11:31:24 +01:00
runloop.h Cleanups 2017-01-11 13:18:24 +01:00
setting_list.c
setting_list.h
verbosity.c
verbosity.h
version_git.c
version_git.h
version.h

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.

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.