Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Alcaro 223dcadaf3 Merge pull request #1818 from joolswills/patch-1
fix compilation with --disable-threads
2015-06-17 21:25:37 +02:00
android/phoenix Create new playlist format 2015-05-26 00:12:49 +02:00
apple fix ugly scaling on Retina Macs 2015-06-12 12:45:29 -05:00
audio (Audio/gfx) Cleanups 2015-06-13 01:18:13 +02:00
camera Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
decompress (decompress) Cleanups 2015-06-14 19:37:24 +02:00
deps
dist-scripts (PS3) Remove unused makefile from distscripts 2015-06-14 12:33:08 +02:00
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 (platform_win32.c) Add menu.h include 2015-06-17 10:40:23 -03:00
gfx Fix raw screenshots 2015-06-17 09:29:09 -03:00
griffin Start creating menu_hash.c 2015-06-15 06:25:41 +02:00
gx/ld
input Cleanups 2015-06-15 06:01:54 +02:00
intl allow remapping of analog axis, only works axis to axis 2015-05-20 21:11:42 -05:00
libretro-common (libretro-common) Cleanups 2015-06-15 05:00:39 +02:00
libretro-db Cleanup some strcmps 2015-06-14 19:42:25 +02:00
libretro-test
libretro-test-gl (Libretro test GL) Make max width/height 2048x2048 2015-05-23 17:23:24 +02:00
location
logger
media add retina-ready Info.plist to media 2015-06-09 08:55:52 -05:00
mem/neon
menu Create menu_hash_calculate 2015-06-17 19:55:35 +02:00
msvc
ngc
pandora
performance
ps3
psp1
qb (qb) Fix comparison operator 2015-06-17 14:31:20 -03:00
qnx
record (record_driver.c) Cleanup 2015-06-12 23:45:01 +02:00
tasks fix compilation with --disable-threads 2015-06-17 20:18:15 +01:00
tests
tools (config_file.c) Speed up setting lookup with hashes 2015-06-14 12:36:29 -03:00
ui Cleanups 2015-06-15 06:01:54 +02:00
wii
xdk
.empty
.gitignore (gitignore) Fix #1705 2015-05-18 20:30:49 -03:00
.project
AUTHORS
autosave.c
autosave.h
cheats.c (cheats.c) Cleanup 2015-06-12 23:14:55 +02:00
cheats.h
circle.yml
command_event.c Move some header includes around 2015-06-13 19:12:10 +02:00
command_event.h
command.c (command.c) Refactor 2015-06-14 17:19:32 +02:00
command.h
config.def.h Enable threaded_data_runloop_enable by default when HAVE_THREADS 2015-06-14 20:10:23 +02:00
config.features.h
configuration.c (General) Cleanup 2015-06-12 17:00:37 +02:00
configuration.h (XMB) Dynamic wallpapers 2015-06-04 17:17:23 +07:00
configure (qb) Add qb.system.sh 2015-06-16 20:46:11 -03:00
content.c (content.c) Allow empty files to be read 2015-06-14 21:00:32 -03:00
content.h
CONTRIBUTING.md
COPYING
core_info.c (General) Cleanups 2015-06-13 03:06:11 +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.c) Cleanups 2015-06-12 23:16:52 +02:00
core_options.h
database_info.c (database_info.c) Do glob query for developers 2015-06-12 18:26:39 +02:00
database_info.h (libretro-db) Store CRC32 as uint32_t 2015-06-09 20:21:14 -03: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 (decompress/7zip_support.c) Cleanups 2015-06-12 23:24:36 +02:00
driver.h Create menu_input_get_ptr 2015-06-13 22:57:55 +02:00
dynamic_dummy.c
dynamic_dummy.h
dynamic.c (General) Cleanup 2015-06-12 17:00:37 +02:00
dynamic.h
fetch-submodules.sh
file_ext.h
file_ops.c (General) Cleanup 2015-06-12 17:00:37 +02:00
file_ops.h
file_path_special.c (General) Cleanup 2015-06-12 17:00:37 +02:00
general.h Include retro_miscellaneous.h in general.h 2015-06-02 16:52:17 +02:00
git_version.c
git_version.h
libretro_private.h
libretro_version_1.c Fix incorrect screenshot colors 2015-06-17 11:32:08 -03:00
libretro_version_1.h
libretro.h (Libretro.h) Prevent mass amount of warnings due to 'attribute visibility' 2015-06-02 17:55:34 +02:00
Makefile (retroarch.c) Add --log-file and --version 2015-06-12 13:36:21 -03:00
Makefile.common Start creating menu_hash.c 2015-06-15 06:25:41 +02:00
Makefile.ctr
Makefile.emscripten
Makefile.griffin [GX] build with larger stack on all builds by default. Fixes #1757 2015-06-12 20:38:32 -05:00
Makefile.openpandora
Makefile.pandora
Makefile.ps3 (PS3) Compile with HAVE_LIBRETRODB support 2015-06-08 00:46:56 +02:00
Makefile.ps3.cobra
Makefile.ps3.salamander Add rhash.c to Salamander 2015-06-15 01:56:01 +02:00
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander Add rhash.c to Salamander 2015-06-15 01:56:01 +02:00
Makefile.wii.salamander Add rhash.c to Salamander 2015-06-15 01:56:01 +02:00
Makefile.win
Makefile.xenon
movie.c (libretro-common) Move hash.c/hash.h to libretro-common 2015-06-04 21:13:13 +02:00
movie.h
netplay.c (General) Cleanups 2015-06-13 03:06:11 +02:00
netplay.h
patch.c (General) Cleanups pt. 3 2015-06-12 17:10:16 +02:00
patch.h
performance.c (General) Cleanup 2015-06-12 17:00:37 +02:00
performance.h Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
playlist.c Fix -Wmissing-braces warnings 2015-06-12 19:25:08 +02:00
playlist.h (playlist) Add content_playlist_qsort() 2015-06-11 10:04:35 -03:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md Rename RetroArch_OSX 2015-06-02 09:48:02 +02:00
retroarch_info.c Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
retroarch_logger.h (retroarch_logger.c) Add extern "C" to forward declaration 2015-06-12 13:36:22 -03:00
retroarch-mingw-build.sh
retroarch.c Move '_refresh' functions to menu_entries.c 2015-06-16 03:03:20 +02:00
retroarch.cfg (XMB) Dynamic wallpapers 2015-06-04 17:17:23 +07:00
retroarch.h Cleanups 2015-06-02 18:28:51 +02:00
rewind.c (General) Cleanups pt. 3 2015-06-12 17:10:16 +02:00
rewind.h
runloop_data.c Move '_refresh' functions to menu_entries.c 2015-06-16 03:03:20 +02:00
runloop_data.h Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
runloop.c DOn't use strcmp in check_shader_dir 2015-06-14 18:46:00 +02:00
runloop.h Get rid of global dependency for video_viewport_get_custom 2015-05-20 23:13:39 +02:00
screenshot.c Fix raw screenshots 2015-06-17 09:29:09 -03:00
screenshot.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.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 apple/RetroArch.xcodeproj
# Run
open ./apple/build/Debug/RetroArch.app/
  • Release:
# Build
xcodebuild -target RetroArch -configuration Release -project apple/RetroArch.xcodeproj
# Run
open ./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. 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.