Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2015-09-26 13:32:13 +02:00
audio Add RARCH_MAIN_CTL_IS_PAUSED 2015-09-26 13:04:07 +02:00
bootstrap (psp1) move kernel_functions.prx to the root folder after build 2015-09-23 23:08:01 +01:00
camera (camera/drivers/video4linux2.c) Use path_is_character_special 2015-09-22 21:16:58 +02:00
cores Move stb_image.h around 2015-09-20 10:32:12 +02:00
ctr (ctr/3ds) update build. 2015-09-23 16:34:06 +01:00
defines (Vita) Cleanups 2015-09-05 16:22:25 +02:00
deps (stb_image.h) Convert more C++ comments 2015-09-22 17:33:54 +02:00
dist-scripts Revert "rename 3ds to ctr" 2015-09-20 19:12:11 +02: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 Possible ARM Linux buildfix 2015-09-24 23:11:24 +02:00
gfx Add RARCH_MAIN_CTL_IS_PAUSED 2015-09-26 13:04:07 +02:00
griffin Create retro_stat.c/retro_stat.h 2015-09-22 01:45:30 +02:00
input Update rarch_main_set_pause references 2015-09-26 13:22:36 +02:00
intl intl/ needs to be refactored - just exclude spanish.h for now 2015-09-15 04:52:18 +02:00
libretro-common [PSP] fix path_stat 2015-09-24 21:11:17 -05:00
libretro-db (libretro-db) Add leiradel's C version of the dat converter 2015-09-23 10:44:41 +02:00
location location_driver.c - cleanup 2015-09-06 04:08:29 +02:00
media add retina-ready Info.plist to media 2015-06-09 08:55:52 -05:00
memory (memory/wii/mem2_manager.c) Cleanups 2015-09-23 12:05:17 +02:00
menu Add another FIXME/UPDATE note 2015-09-26 13:32:13 +02:00
pkg (MSVC) Update more paths 2015-09-23 14:00:24 +02:00
qb Remove those C89 checks, they're done elsewhere now. 2015-09-22 16:53:30 +02:00
record (record_ffmpeg.c) Style nits 2015-09-16 10:50:53 +02:00
tasks (PS1) serial lookup: improve error detection. 2015-09-26 01:27:17 +01:00
tests Remove instances of 'RetroArch' name with 'program' 2015-06-30 15:26:14 +02:00
tools Rename rarch_sleep to retro_sleep 2015-09-22 18:55:14 +02:00
ui Update rarch_main_set_pause references 2015-09-26 13:22:36 +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 Update .gitignore 2015-09-20 16:26:43 +02:00
.project Allow to load roms from external apps. 2013-08-19 23:23:39 +02:00
autosave.c Cleanups 2015-09-05 19:51:55 +02:00
autosave.h Add documentation for autosave.c and turn some functions static 2015-01-09 02:53:08 +01:00
cheats.c refactor cheats.c 2015-09-06 03:51:08 +02:00
cheats.h refactor cheats.c 2015-09-06 03:51:08 +02:00
circle.yml Mac OS X / CircleCI fixes 2015-03-06 14:04:21 -08:00
command_event.c Refactor away rarch_main_set_frame_limit_last_time 2015-09-26 13:25:58 +02:00
command_event.h Craete EVENT_CMD_SAVE_STATE_INCREMENT/EVENT_CMD_SAVE_STATE_DECREMENT 2015-09-02 01:15:10 +02:00
command.c Get rid of more fcntl header includes 2015-09-18 04:03:11 +02:00
command.h Style nits 2015-04-13 11:39:40 +02:00
config.def.h (Gekko) Set audio output rate to 32KHz 2015-09-07 00:05:59 +02:00
config.features.h Refactors 2015-07-03 00:16:46 +02:00
configuration.c add a debug information panel, disabled by default 2015-09-23 20:51:31 -05:00
configuration.h add a debug information panel, disabled by default 2015-09-23 20:51:31 -05:00
configure (qb) Add qb.system.sh 2015-06-16 20:46:11 -03:00
content.c Create retro_stat.c/retro_stat.h 2015-09-22 01:45:30 +02: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 Simplify core_info_list_get_all_extensions 2015-09-14 23:33:50 +02:00
core_info.h Simplify core_info_list_get_all_extensions 2015-09-14 23:33:50 +02:00
core_options.c Cleanup headers 2015-09-05 19:24:21 +02:00
core_options.h More documentation for core options functions and change 2015-01-16 02:10:17 +01:00
database_info.c Make bin_to_hex_alloc public scope 2015-09-23 15:11:35 +02:00
database_info.h Make bin_to_hex_alloc public scope 2015-09-23 15:11:35 +02:00
dir_list_special.c Simplify core_info_list_get_all_extensions 2015-09-14 23:33:50 +02:00
dir_list_special.h (dir_list_special.h) C89 build fix 2015-06-26 16:09:11 +02:00
driver.c Cleanup headers 2015-09-05 19:24:21 +02:00
driver.h Make late binding possible for frontend drivers 2015-07-27 03:44:28 +02:00
dynamic.c Refactor perf counters 2015-09-20 10:02:59 +02:00
dynamic.h Start hooking up imageviewer, pt. 1 2015-06-28 17:02:01 +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 (Vita) Update Makefile.griffin, performance.c and file extensions 2015-08-30 16:12:45 +02:00
file_ops.c (file_ops.c) Cleanups 2015-09-19 12:48:53 +02: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 - cleanup 2015-09-22 21:49:03 +02:00
general.h Replace more usage of strcpy 2015-09-19 03:50:35 +02: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 Refactor frame_is_reversed - shader drivers should no longer 2015-09-16 11:14:43 +02: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 Remove those C89 checks, they're done elsewhere now. 2015-09-22 16:53:30 +02:00
Makefile.ctr (ctr/3ds) update build. 2015-09-23 16:34:06 +01:00
Makefile.emscripten (Emscripten) Another buildfix 2015-08-20 00:57:54 +02:00
Makefile.griffin (Vita) Add UVLoader_stub to LIBS 2015-09-20 23:56: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 Move files around 2015-09-20 15:26:10 +02:00
Makefile.ps3.cobra Move files around 2015-09-20 15:26:10 +02:00
Makefile.ps3.salamander Create retro_stat.c/retro_stat.h 2015-09-22 01:45:30 +02: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 Create retro_stat.c/retro_stat.h 2015-09-22 01:45:30 +02:00
Makefile.wii.salamander Create retro_stat.c/retro_stat.h 2015-09-22 01:45:30 +02: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 Take out retro_endianness.h include out of retro_miscellaneous.h 2015-09-14 03:34:05 +02: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 Add Polish (ISO-8859-2) 2015-07-07 02:56:27 +02:00
netlogger.c Rename rarch_sleep to retro_sleep 2015-09-22 18:55:14 +02:00
netplay.c (netplay.c) Add ANDROID ifdef 2015-09-15 05:48:05 +02:00
netplay.h Move deinit_netplay to netplay.c 2015-04-11 13:31: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 Refactor perf counters 2015-09-20 10:02:59 +02:00
performance.h Refactor perf counters 2015-09-20 10:02:59 +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 Move apple and android to pkg/ 2015-09-20 15:49:19 +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 Refactor away rarch_main_set_max_frames 2015-09-26 13:28:33 +02: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 make system directory restore correctly when closing content in case it was set to content dir 2015-07-12 02:35:27 -05:00
rewind.c Refactor perf counters 2015-09-20 10:02:59 +02:00
rewind.h Refactor frame_is_reversed - shader drivers should no longer 2015-09-16 11:14:43 +02:00
runloop_data.c Revert "Main menu loop now does rendering, data runloop does actual" 2015-09-25 00:20:53 +02:00
runloop_data.h g_data_runloop is now no longer a pointer 2015-07-27 14:52:21 +02:00
runloop_msg.c workaround to disable OSD fonts without restarting 2015-09-24 00:33:25 -05:00
runloop.c Refactor away rarch_main_set_max_frames 2015-09-26 13:28:33 +02:00
runloop.h Refactor away rarch_main_set_max_frames 2015-09-26 13:28:33 +02:00
screenshot.c Add RARCH_MAIN_CTL_IS_PAUSED 2015-09-26 13:04:07 +02:00
screenshot.h (XDK1) Buildfixes 2015-03-30 02:18:58 +02:00
system.c Refactors 2015-07-03 00:16:46 +02: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. 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:

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.