Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Twinaphex 4a7595c7d2 Merge pull request #2291 from lakkatv/xmb
(Menu) prevent incrementing and decrementing animations when not need…
2015-10-26 17:39:38 +01:00
audio (string_list_special.c) Code de-duplication 2015-10-26 08:52:25 +01:00
bootstrap
camera Rfactor camera_driver.c to use string_list_special 2015-10-26 08:42:34 +01:00
cores (ffmpeg) Attempt to make ffmpeg recording driver forwards compatible 2015-10-26 00:47:45 +01:00
ctr (CTR/3DS) improve memory management. 2015-10-22 20:35:22 +01:00
defines
deps Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
dist-scripts (CTR/3DS) Changed pkg directory names. 2015-10-17 16:04:44 +08:00
docs
emscripten
frontend (CTR/3DS) fix for hbl 2.5 2015-10-26 04:58:39 +01:00
gfx Code deduplication 2015-10-26 08:55:59 +01:00
griffin Create string_list_special.c 2015-10-26 08:39:35 +01:00
input More code de-duplication 2015-10-26 09:06:11 +01:00
intl
libretro-common Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
libretro-db Add back lua_converter.c 2015-10-25 09:15:36 +01:00
location Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
media Rename retroarch icons 2015-10-23 07:46:20 +02:00
memory
menu (Menu) prevent incrementing and decrementing animations when not needed, fixes an animation bug in XMB 2015-10-26 16:19:11 +07:00
pkg Update other Makefiles 2015-10-26 02:46:51 +01:00
qb make HAVE_CHEEVOS=1 by default 2015-10-18 22:30:21 -02:00
record Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
tasks Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
tests
tools More code de-duplication 2015-10-26 09:06:11 +01:00
ui (OSX) Remove references to 'chooseCore' 2015-10-12 12:30:58 +02:00
vita
wii/app_booter
.empty
.gitignore Add weird 'menu/driverspzarch.c' to .gitignore 2015-10-10 08:16:06 +02:00
.project
autosave.c
autosave.h
cheats.c
cheats.h
cheevos.c removed http_get.[ch], using net_http_special now 2015-10-24 12:00:52 -02:00
cheevos.h move http_get to its own file; fix copyright 2015-10-23 23:25:27 -02:00
circle.yml
command_event.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
command_event.h Add a HAVE_LAKKA define, and enable a shutdown menu entry 2015-10-23 15:24:47 +07:00
command.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
command.h
config.def.h Update config.def.h 2015-10-20 12:52:40 -05:00
config.features.h
configuration.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
configuration.h Have only one Menu Navigation Wraparound setting 2015-10-25 02:59:38 +01:00
configure
content.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
content.h
CONTRIBUTING.md
COPYING
core_info.c
core_info.h
core_options.c
core_options.h
database_info.c
database_info.h
dir_list_special.c Add DIR_LIST_COLLECTIONS to dir_list_new_special 2015-10-26 06:41:22 +01:00
dir_list_special.h Add DIR_LIST_COLLECTIONS to dir_list_new_special 2015-10-26 06:41:22 +01:00
driver.c
driver.h
dynamic.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
dynamic.h
fetch-submodules.sh
file_ext.h
file_ops.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
file_ops.h
file_path_special.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
general.h Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
git_version.c
git_version.h
libretro_private.h
libretro_version_1.c
libretro_version_1.h
libretro.h
Makefile
Makefile.common Create string_list_special.c 2015-10-26 08:39:35 +01:00
Makefile.ctr Update other Makefiles 2015-10-26 02:46:51 +01:00
Makefile.emscripten
Makefile.griffin
Makefile.openpandora
Makefile.pandora
Makefile.ps3 Update Makefile.ps3 2015-10-23 07:20:19 +02:00
Makefile.ps3.cobra
Makefile.ps3.salamander Update other Makefiles 2015-10-26 02:46:51 +01:00
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander Update other Makefiles 2015-10-26 02:46:51 +01:00
Makefile.wii.salamander Update other Makefiles 2015-10-26 02:46:51 +01:00
Makefile.win
movie.c
movie.h
msg_hash.c
msg_hash.h Create net_http_special 2015-10-20 04:40:25 +02:00
net_http_special.c (net_http_special.c) Get rid of warning 2015-10-20 04:41:28 +02:00
net_http_special.h Fix CXX_BUILD 2015-10-25 20:40:47 +01:00
netlogger.c
netplay.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
netplay.h
no-xib.diff Add no-xib.diff 2015-10-13 23:23:33 +02:00
patch.c
patch.h
performance.c (performance.c) Refactor performance counter code 2015-10-11 18:21:07 +02:00
performance.h (performance.c) Refactor performance counter code 2015-10-11 18:21:07 +02:00
playlist.c
playlist.h
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Update README.md 2015-10-17 16:40:44 +02:00
retroarch_info.c
retroarch-mingw-build.sh
retroarch.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
retroarch.cfg
retroarch.desktop
retroarch.h cleaner implementation of save file / save state sorting 2015-10-19 19:55:41 -05:00
rewind.c
rewind.h
runloop_data.c
runloop_data.h
runloop_msg.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
runloop.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
runloop.h Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
screenshot.c
screenshot.h
string_list_special.c More code de-duplication 2015-10-26 09:06:11 +01:00
string_list_special.h More code de-duplication 2015-10-26 09:06:11 +01:00
system.c
system.h
Vagrantfile

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)
  • Raspberry Pi
  • Android
  • iOS
  • Blackberry

Dependencies (PC)

On Windows, RetroArch can run with only Win32 as dependency. On Linux, you need:

  • GL 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.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.