Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Twinaphex 549fa1d8e8 Merge pull request #2308 from lakkatv/material
(GLUI) Show appropriate tab names
2015-10-28 20:48:21 +01:00
audio Merge pull request #2293 from aliaspider/master 2015-10-27 01:38:38 +01:00
bootstrap (psp1) move kernel_functions.prx to the root folder after build 2015-09-23 23:08:01 +01:00
camera Create new char_list_new_special 2015-10-26 19:41:20 +01:00
cores (ffmpeg) Attempt to make ffmpeg recording driver forwards compatible 2015-10-26 00:47:45 +01:00
ctr (3DS) - add an audio driver using the DSP. 2015-10-27 01:06:34 +01:00
defines (Vita) Cleanups 2015-09-05 16:22:25 +02:00
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 Update docs/retroarch.1 2015-01-24 04:09:40 +01:00
emscripten Backport this - 58748da89d 2015-07-27 00:08:25 +02:00
frontend (3DS) auto-extract /3ds/dspfirm.cdc from /3ds/code.bin when needed/ 2015-10-27 19:50:39 +01:00
gfx Add non-HAVE_MENU ifdefs 2015-10-28 00:55:11 +01:00
griffin Move async_job to libretro-common 2015-10-28 07:47:57 +01:00
input Some more non-HAVE_MENU buildfixes 2015-10-28 08:02:39 +01:00
intl intl/ needs to be refactored - just exclude spanish.h for now 2015-09-15 04:52:18 +02:00
libretro-common Move async_job to libretro-common 2015-10-28 07:47:57 +01:00
libretro-db Add back lua_converter.c 2015-10-25 09:15:36 +01:00
location Create new char_list_new_special 2015-10-26 19:41:20 +01:00
media Update render-ios-icons.sh 2015-10-27 05:38:00 +01:00
memory (memory/wii/mem2_manager.c) Cleanups 2015-09-23 12:05:17 +02:00
menu (GLUI) Show appropriate tab names 2015-10-29 02:34:52 +07:00
pkg Added Android2.mk 2015-10-28 18:21:08 +01:00
qb make HAVE_CHEEVOS=1 by default 2015-10-18 22:30:21 -02:00
record Create new char_list_new_special 2015-10-26 19:41:20 +01:00
tasks Some more non-HAVE_MENU buildfixes 2015-10-28 08:02:39 +01:00
tests Refactor away rarch_main_clear_state 2015-09-26 13:35:04 +02:00
tools (PS3) ps3py/crypt.c - style nits 2015-10-27 02:02:15 +01:00
ui (OSX) Remove references to 'chooseCore' 2015-10-12 12:30:58 +02:00
vita (Vita) Vita2d font renderer 2015-10-01 01:10:26 +02:00
wii/app_booter (wii/app_booter) Style nits 2015-09-21 19:28:20 +02:00
.empty initial new branch 2011-11-30 01:07:38 +01:00
.gitignore Add weird 'menu/driverspzarch.c' to .gitignore 2015-10-10 08:16:06 +02:00
.project Allow to load roms from external apps. 2013-08-19 23:23:39 +02:00
autosave.c More static code analysis nits 2015-09-28 18:44:28 +02:00
autosave.h Add documentation for autosave.c and turn some functions static 2015-01-09 02:53:08 +01:00
cheats.c fixed wrong includes 2015-10-27 15:52:34 -02:00
cheats.h refactor cheats.c 2015-09-06 03:51:08 +02:00
cheevos.c Move async_job to libretro-common 2015-10-28 07:47:57 +01:00
cheevos.h sumbit achievements asynchronously to the server; download list of unlocked achievements to prevent earning the same achievement more than once; disabled achievements if the game was started with cheats enabled or after they were enabled during game play; fixed code style 2015-10-27 15:50:41 -02:00
circle.yml Mac OS X / CircleCI fixes 2015-03-06 14:04:21 -08:00
command_event.c Add non-HAVE_MENU ifdefs 2015-10-28 00:55:11 +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 Style nits 2015-04-13 11:39:40 +02:00
config.def.h Update config.def.h 2015-10-20 12:52:40 -05:00
config.features.h Refactors 2015-07-03 00:16:46 +02:00
configuration.c Add non-HAVE_MENU ifdefs 2015-10-28 00:55:11 +01:00
configuration.h Add non-HAVE_MENU ifdefs 2015-10-28 00:55:11 +01:00
configure (qb) Add qb.system.sh 2015-06-16 20:46:11 -03:00
content.c Merge pull request #2299 from leiradel/master 2015-10-27 21:44:27 +01:00
content.h Go through global_get_ptr 2015-03-21 04:43:18 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md 2012-12-09 10:16:35 +01:00
COPYING Add GPLv3 text I suppose. 2011-01-25 13:31:55 +01:00
core_info.c Add param to dir_list_new_special 2015-10-26 21:30:58 +01:00
core_info.h Simplify core_info_list_get_all_extensions 2015-09-14 23:33:50 +02:00
core_options.c Some more static code analysis nits when ran with enable=all 2015-09-28 18:12:02 +02:00
core_options.h More documentation for core options functions and change 2015-01-16 02:10:17 +01:00
database_info.c Add param to dir_list_new_special 2015-10-26 21:30:58 +01:00
database_info.h More static code analysis fixes 2015-09-28 17:18:48 +02:00
dir_list_special.c Add param to dir_list_new_special 2015-10-26 21:30:58 +01:00
dir_list_special.h Add param to dir_list_new_special 2015-10-26 21:30:58 +01:00
driver.c Add non-HAVE_MENU ifdefs 2015-10-28 00:55:11 +01:00
driver.h Create RARCH_DEVICE_MOUSE_SCREEN 2015-10-08 08:19:38 +02:00
dynamic.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
dynamic.h grouped core functions inside a retro_core_t structure; swapped core function globals by one retro_core_t variable 2015-10-06 14:34:09 -03: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 (Vita) Update Makefile.griffin, performance.c and file extensions 2015-08-30 16:12:45 +02:00
file_ops.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
file_ops.h Simplify file_read some more 2015-03-21 09:34:50 +01:00
file_path_special.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
general.h Rename extraction_directory to cache_directory 2015-10-27 00:48:35 +01:00
git_version.c Start updating headers 2015-01-07 17:46:50 +01:00
git_version.h Start updating headers 2015-01-07 17:46:50 +01:00
libretro_private.h Start updating headers 2015-01-07 17:46:50 +01:00
libretro_version_1.c grouped core functions inside a retro_core_t structure; swapped core function globals by one retro_core_t variable 2015-10-06 14:34:09 -03:00
libretro_version_1.h Cleanups in libretro_version_1.c 2015-01-13 02:33:29 +01:00
libretro.h C source isn't executable. Nor is that bitmap. 2015-07-12 12:51:52 +02:00
Makefile Assume long long is there for C89_BUILD 2015-09-22 13:32:56 +02:00
Makefile.common Move async_job to libretro-common 2015-10-28 07:47:57 +01:00
Makefile.ctr nit. 2015-10-27 19:54:00 +01:00
Makefile.emscripten (Emscripten) Another buildfix 2015-08-20 00:57:54 +02:00
Makefile.griffin (Vita) Add -lpng to Vita 2015-10-03 02:48:22 +02:00
Makefile.openpandora Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.pandora Move pandora files 2015-09-20 15:41:28 +02:00
Makefile.ps3 Update Makefile.ps3 2015-10-23 07:20:19 +02:00
Makefile.ps3.cobra Move files around 2015-09-20 15:26:10 +02:00
Makefile.ps3.salamander Update other Makefiles 2015-10-26 02:46:51 +01:00
Makefile.psl1ght Move files around 2015-09-20 15:26:10 +02:00
Makefile.psp1 (PSP) Move files around 2015-09-20 15:33:54 +02:00
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 Use C++98 for Windows too to shove compat/posix_string.h craziness under the rug. 2015-09-06 15:12:17 +02:00
movie.c grouped core functions inside a retro_core_t structure; swapped core function globals by one retro_core_t variable 2015-10-06 14:34:09 -03:00
movie.h Start updating headers 2015-01-07 17:46:50 +01:00
msg_hash.c Don't make asserts dependent on retro_log.h 2015-09-01 11:59:27 +02:00
msg_hash.h Create net_http_special 2015-10-20 04:40:25 +02:00
net_http_special.c added error messages to the log when net_http_get fails in cheevos.c 2015-10-27 21:54:51 -02:00
net_http_special.h added error messages to the log when net_http_get fails in cheevos.c 2015-10-27 21:54:51 -02:00
netlogger.c Rename rarch_sleep to retro_sleep 2015-09-22 18:55:14 +02:00
netplay.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
netplay.h Move deinit_netplay to netplay.c 2015-04-11 13:31:33 +02:00
no-xib.diff Add no-xib.diff 2015-10-13 23:23:33 +02:00
patch.c Rearrange structs 2015-07-27 17:18:10 +02:00
patch.h Move patch code to patch.c 2015-02-19 04:30:53 +01:00
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 Move retroarch_logger.h to libretro-common/include 2015-06-30 00:38:10 +02:00
playlist.h (playlist) Add content_playlist_qsort() 2015-06-11 10:04:35 -03:00
README-exynos.md exynos: update TODO list 2014-08-09 16:43:48 +02:00
README-mali_fbdev_r4p0.md Add README-mali_fbdev_r4p0.md 2014-11-18 16:07:08 +01:00
README-OMAP.md video_omap: more docu fixes 2014-01-14 16:39:24 -06:00
README.md Update README.md 2015-10-17 16:40:44 +02:00
retroarch_info.c Refactor perf counters 2015-09-20 10:02:59 +02:00
retroarch-mingw-build.sh Add support for different "make" binaries 2014-07-30 01:14:57 +02:00
retroarch.c Some more non-HAVE_MENU buildfixes 2015-10-28 08:02:39 +01:00
retroarch.cfg Refactor fastforward ratio 2015-08-27 14:39:42 +02:00
retroarch.desktop (Linux) Add a GenericName to the desktop entry 2015-06-18 09:49:14 -07:00
retroarch.h cleaner implementation of save file / save state sorting 2015-10-19 19:55:41 -05:00
rewind.c grouped core functions inside a retro_core_t structure; swapped core function globals by one retro_core_t variable 2015-10-06 14:34:09 -03:00
rewind.h Refactor frame_is_reversed - shader drivers should no longer 2015-09-16 11:14:43 +02:00
runloop_data.c Add non-HAVE_MENU ifdefs 2015-10-28 00:55:11 +01:00
runloop_data.h g_data_runloop is now no longer a pointer 2015-07-27 14:52:21 +02:00
runloop_msg.c Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
runloop.c Add non-HAVE_MENU ifdefs 2015-10-28 00:55:11 +01:00
runloop.h Change 'rarch' to 'retro' namespace in libretro-common 2015-10-26 03:18:13 +01:00
screenshot.c Some more static code analysis nits when ran with enable=all 2015-09-28 18:12:02 +02:00
screenshot.h (screenshot.c) Cleanups 2015-09-27 02:32:30 +02:00
string_list_special.c Refactor menu_displaylist.c's iteration of cores - use string_list_new_special 2015-10-26 21:03:28 +01:00
string_list_special.h Refactor menu_displaylist.c's iteration of cores - use string_list_new_special 2015-10-26 21:03:28 +01:00
system.c grouped core functions inside a retro_core_t structure; swapped core function globals by one retro_core_t variable 2015-10-06 14:34:09 -03:00
system.h Move title_buf to rarch_system_info_t 2015-06-25 14:30:32 +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 (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.