Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2015-05-26 09:06:02 +02:00
android/phoenix Create new playlist format 2015-05-26 00:12:49 +02:00
apple
audio (Audio drivers) Get rid of global state dependencies 2015-05-20 23:01:03 +02:00
camera
debian
decompress
deps
dist-scripts
docs
emscripten allow upload of SRM files, also allow upload of savestates but it seems saves are not compatible from PC 2015-05-12 00:41:40 -04:00
frontend make sure to reset paths when exiting too 2015-05-25 20:54:51 -05:00
gfx (DRM EGL) Don't do useless cast 2015-05-24 05:07:01 +02:00
griffin Move code to database_info.c 2015-05-25 04:50:07 +02:00
gx/ld
input allow remapping of analog axis, only works axis to axis 2015-05-20 21:11:42 -05:00
intl allow remapping of analog axis, only works axis to axis 2015-05-20 21:11:42 -05:00
libretro-common Create rarch_strcasestr 2015-05-26 02:31:29 +02:00
libretro-db
libretro-test
libretro-test-gl (Libretro test GL) Make max width/height 2048x2048 2015-05-23 17:23:24 +02:00
location
logger
media
mem/neon
menu 'Start Content' option in 'database entry' view fixed 2015-05-26 08:48:03 +02:00
msvc
ngc
pandora
performance
ps3
psp1
qb Configure checks for libusb 1.0.16 2015-05-17 15:30:16 -07:00
qnx
record Move pix_fmt to video_state 2015-05-20 20:59:12 +02:00
tasks (task_database.c) Update TODO notes 2015-05-26 09:04:57 +02:00
tests
tools
ui use a timer in the run loop if there is data work to be done in ra 2015-05-17 06:22:51 -04:00
wii
xdk
.empty
.gitignore (gitignore) Fix 2015-05-18 20:30:49 -03:00
.project
AUTHORS
autosave.c
autosave.h
cheats.c
cheats.h
circle.yml
command_event.c try to fix per-core savedirs for content that needs_fullpath 2015-05-25 19:03:39 -05:00
command_event.h
command.c
command.h
config.def.h
config.features.h
configuration.c Create new playlist format 2015-05-26 00:12:49 +02:00
configuration.h
configure
content.c
content.h
CONTRIBUTING.md
COPYING
core_info.c (core_info.c) Buildfix 2015-05-26 09:06:02 +02:00
core_info.h core_info_get_name and content_playlist_update 2015-05-26 06:28:16 +02:00
core_options.c
core_options.h
database_info.c Remove database_playlist_free 2015-05-26 02:08:18 +02:00
database_info.h Remove database_playlist_free 2015-05-26 02:08:18 +02:00
dir_list_special.c Add DATABASE_STATUS_ITERATE_BEGIN 2015-05-24 06:14:44 +02:00
dir_list_special.h Add DATABASE_STATUS_ITERATE_BEGIN 2015-05-24 06:14:44 +02:00
driver.c Move hw_render_callbakc to video driver state and take it out 2015-05-20 19:56:12 +02:00
driver.h Add grab_stdin function pointer to input driver - avoids threading 2015-05-19 19:33:58 +02:00
dynamic_dummy.c
dynamic_dummy.h
dynamic.c Move pix_fmt to video_state 2015-05-20 20:59:12 +02:00
dynamic.h
fetch-submodules.sh
file_ext.h
file_ops.c
file_ops.h
file_path_special.c
general.h Bump version up to 1.2 2015-05-21 00:36:26 +02:00
git_version.c
git_version.h
hash.c
hash.h
libretro_private.h
libretro_version_1.c Create video_driver_cached_frame_set 2015-05-20 21:13:25 +02:00
libretro_version_1.h
libretro.h Fix missing NUL terminator. 2015-05-19 22:00:17 +02:00
Makefile (Makefile) Add SANITIZER variable 2015-05-19 15:11:34 -03:00
Makefile.common Move code to database_info.c 2015-05-25 04:50:07 +02:00
Makefile.ctr
Makefile.emscripten
Makefile.griffin
Makefile.openpandora
Makefile.pandora
Makefile.ps3
Makefile.ps3.cobra
Makefile.ps3.salamander
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander
Makefile.wii.salamander
Makefile.win
Makefile.xenon
movie.c
movie.h
netplay.c
netplay.h
patch.c
patch.h
performance.c
performance.h
playlist.c Content Collection core selection should now work 2015-05-26 08:38:38 +02:00
playlist.h core_info_get_name and content_playlist_update 2015-05-26 06:28:16 +02:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md
retroarch_info.c Start creating retroarch_info.c 2015-05-13 13:21:43 +02:00
retroarch_logger.h
retroarch-mingw-build.sh
retroarch.c try to fix per-core savedirs for content that needs_fullpath 2015-05-25 19:03:39 -05:00
retroarch.cfg Create new playlist format 2015-05-26 00:12:49 +02:00
retroarch.h Rename rarch_render_cached_frame to video_driver_cached_frame 2015-05-20 21:06:44 +02:00
rewind.c Move audio callback to audio_driver.c 2015-05-19 21:35:40 +02:00
rewind.h
runloop_data.c Move db.handle to runloop_data.h 2015-05-23 18:13:23 +02:00
runloop_data.h (Task database) Experimental database scanning 2015-05-25 07:05:00 +02:00
runloop.c (runloop.c) Add some locks around message queue calls 2015-05-20 20:50:51 -03:00
runloop.h Get rid of global dependency for video_viewport_get_custom 2015-05-20 23:13:39 +02:00
screenshot.c Create video_driver_cached_frame_has_valid_fb 2015-05-20 21:29:23 +02:00
screenshot.h
settings_list.c
settings_list.h Rename Path Settings to Directory Settings 2015-05-17 17:09:07 +02:00
settings.c Create new playlist format 2015-05-26 00:12:49 +02:00
settings.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 (apple/RetroArch_OSX.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_OSX -configuration Debug -project apple/RetroArch_OSX.xcodeproj
# Run
open ./apple/build/Debug/RetroArch_OSX.app/
  • Release:
# Build
xcodebuild -target RetroArch_OSX -configuration Release -project apple/RetroArch_OSX.xcodeproj
# Run
open ./apple/build/Release/RetroArch_OSX.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. Compile the RGL video driver

make -f Makefile.ps3.rgl

  1. Compile RetroArch as a library

make -f Makefile.ps3.retroarch

  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:

msvc-360/RetroArch-360.sln

NOTE: A pre-existing libretro library needs to be present in the 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.