Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Twinaphex f9d11eb343 Merge pull request #1772 from heuripedes/master
Stop reloading the playlist in action_ok_core_deferred_set()
2015-06-11 16:34:19 +02:00
android/phoenix Create new playlist format 2015-05-26 00:12:49 +02:00
apple (OSX) Rename RetroArch_OSX to RetroArch 2015-06-02 09:43:12 +02:00
audio Prevent warning 2015-06-02 17:34:20 +02:00
camera Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
decompress (zip_support.c) Simplify some more 2015-04-10 05:32:52 +02:00
deps Remove warnings during clang++ builds 2015-03-16 14:43:56 -03:00
dist-scripts Debian packaging update. 2015-05-30 20:41:29 -03: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 Expand playlist format - rename it to 'lpl' 2015-06-08 23:38:03 +02:00
gfx removed memory allocation in gl_raster_font_render_message 2015-06-05 18:14:05 -03:00
griffin (Menu) Rename files 2015-06-08 14:44:24 +02:00
gx/ld
input (linuxraw_input.c) Add unistd.h header 2015-06-08 11:57:07 +02:00
intl allow remapping of analog axis, only works axis to axis 2015-05-20 21:11:42 -05:00
libretro-common (file_list) Start adding entry_idx to file_list_* functions 2015-06-10 22:43:06 +02:00
libretro-db (libretro-db) Fix segfault 2015-06-10 16:16:00 -03:00
libretro-test (libretro-test) Update linux-portable 2015-03-05 23:51:14 +01:00
libretro-test-gl (Libretro test GL) Make max width/height 2048x2048 2015-05-23 17:23:24 +02:00
location Ifdef AVFoundation and CoreLocation specifically for HAVE_COCOA and/or 2015-04-20 14:14:45 +02:00
logger Split off logger code to separate file 2015-03-21 06:31:58 +01:00
media add retina-ready Info.plist to media 2015-06-09 08:55:52 -05:00
mem/neon
menu Stop reloading the playlist in action_ok_core_deferred_set() 2015-06-11 11:27:16 -03:00
msvc (MSVC) Define HAVE_RPNG 2015-04-23 02:21:48 +02:00
ngc
pandora
performance Use retro_inline throughout 2015-03-15 04:52:46 +01:00
ps3 (PS3) Move out gcmgl 2015-03-15 17:39:15 +01:00
psp1
qb (qb) Add --disable-libretrodb 2015-06-02 10:57:18 -03:00
qnx Create HAVE_MAIN define 2015-04-20 21:10:01 +02:00
record Move pix_fmt to video_state 2015-05-20 20:59:12 +02:00
tasks (task_database.c) Use a query for faster CRC scanning 2015-06-10 14:51:26 -03:00
tests Create new rarch_main signature 2015-04-20 21:31:25 +02:00
tools Create input_config_autoconfigure_disconnect 2015-06-03 18:55:04 +02:00
ui Fixes 2015-06-02 21:41:09 +02:00
wii (GX) Remove vi_encoder.h 2015-04-02 19:25:52 +02:00
xdk Get rid of now-empty file screenshot_xdk1.c 2015-03-30 02:24:52 +02:00
.empty
.gitignore (gitignore) Fix #1705 2015-05-18 20:30:49 -03:00
.project
AUTHORS
autosave.c Go through global_get_ptr 2015-03-21 04:43:18 +01:00
autosave.h
cheats.c cheats: null checks on functions 2015-04-03 13:53:22 -04:00
cheats.h
circle.yml Mac OS X / CircleCI fixes 2015-03-06 14:04:21 -08:00
command_event.c (history) Write playlist on deinit 2015-06-09 17:44:21 -03:00
command_event.h Change signature of event_command too 2015-04-20 18:40:46 +02:00
command.c (command.c) Add MENU_LEFT and MENU_RIGHT 2015-04-10 08:09:59 +02:00
command.h Style nits 2015-04-13 11:39:40 +02:00
config.def.h (Android/iOS) Make GLUI the new default UI on Android and iOS 2015-05-09 15:06:32 +02:00
config.features.h Add features 2015-04-19 20:42:54 +02:00
configuration.c Expand playlist format - rename it to 'lpl' 2015-06-08 23:38:03 +02:00
configuration.h (XMB) Dynamic wallpapers 2015-06-04 17:17:23 +07:00
configure
content.c (libretro-common) Move hash.c/hash.h to libretro-common 2015-06-04 21:13:13 +02:00
content.h Go through global_get_ptr 2015-03-21 04:43:18 +01:00
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 (database_info.c) Fix massive leak 2015-06-10 14:05:08 -03: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 (driver.c) Do away with series of strcmps 2015-06-04 22:37:00 +02:00
driver.h (libretro_version_1.c) Change current_msg to a char array 2015-06-09 17:02:28 -03:00
dynamic_dummy.c
dynamic_dummy.h
dynamic.c Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
dynamic.h Move dylib.c to libretro-common 2015-05-08 09:49:49 +02:00
fetch-submodules.sh Some improvements to fetch-submodules.sh I thought I committed weeks ago 2015-03-14 19:57:14 -07:00
file_ext.h
file_ops.c file_ops: Get rid of unnecessary if statement 2015-05-07 18:09:04 -04:00
file_ops.h Simplify file_read some more 2015-03-21 09:34:50 +01:00
file_path_special.c (file_path_special.c) Add missing CoreFoundation.h header include 2015-04-19 15:34:52 +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 (libretro_version_1.c) Change current_msg to a char array 2015-06-09 17:02:28 -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 removed unneeded -g flag in ld 2015-06-05 18:29:41 -03:00
Makefile.common (Menu) Rename files 2015-06-08 14:44:24 +02:00
Makefile.ctr Create HAVE_RPNG define 2015-04-19 16:55:03 +02:00
Makefile.emscripten Create HAVE_MAIN define 2015-04-20 21:10:01 +02:00
Makefile.griffin (Makefile.griffin) Add HAVE_LIBRETRODB rule 2015-06-08 00:48:21 +02:00
Makefile.openpandora Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.pandora
Makefile.ps3 (PS3) Compile with HAVE_LIBRETRODB support 2015-06-08 00:46:56 +02:00
Makefile.ps3.cobra Create HAVE_RPNG define 2015-04-19 16:55:03 +02:00
Makefile.ps3.salamander (PS3) Buildfixes 2015-03-21 06:57:13 +01:00
Makefile.psl1ght Create HAVE_RPNG define 2015-04-19 16:55:03 +02:00
Makefile.psp1 Create HAVE_RPNG define 2015-04-19 16:55:03 +02:00
Makefile.psp1.salamander (PSP) Implement get_powerstate 2015-04-18 15:28:06 +02:00
Makefile.wii.salamander (Wii Salamander) Buildfix 2015-03-21 06:53:37 +01:00
Makefile.win Change HAVE_WINXINPUT to HAVE_XINPUT 2015-04-05 20:54:46 +02:00
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 Move deinit_netplay to netplay.c 2015-04-11 13:31:33 +02:00
netplay.h Move deinit_netplay to netplay.c 2015-04-11 13:31:33 +02:00
patch.c Things that happen 98% of the time shouldn't be warnings. 2015-06-01 19:39:27 +02:00
patch.h Move patch code to patch.c 2015-02-19 04:30:53 +01:00
performance.c Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
performance.h Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
playlist.c (playlist) Add content_playlist_qsort() 2015-06-11 10:04:35 -03: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 (XDK1) Use logger overrides not only for RARCH_INTERNAL 2015-03-30 02:28:11 +02:00
retroarch-mingw-build.sh
retroarch.c Expand playlist format - rename it to 'lpl' 2015-06-08 23:38:03 +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 Rearrange header include dependencies 2015-06-02 17:17:46 +02:00
rewind.h Move init_rewind to rewind.c 2015-04-11 13:36:33 +02:00
runloop_data.c Cleanups 2015-06-02 18:28:51 +02:00
runloop_data.h Rearrange header include dependencies 2015-06-02 17:17:46 +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 (XDK1) Buildfixes 2015-03-30 02:18:58 +02:00
Vagrantfile added linux build instructions, Vagrantfile to prove it, and updated .gitignore 2015-02-13 14:43:07 -08:00

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.