Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Twinaphex b4c6715eb0 Merge pull request #1172 from lakkatv/xmb
(XMB) Horizontal animations using file_list cache
2014-10-20 20:06:17 +02:00
android/phoenix (Android) Add HAVE_LAKKA, HAVE_GLUI and HAVE_XMB 2014-10-09 05:24:22 +02:00
apple (ObjC) Avoid local variables named index 2014-10-20 19:33:50 +02:00
audio Don't include stdio.h where not needed 2014-10-16 07:27:42 +02:00
blackberry-qnx
camera
compat (rxml.c) Silence warnings 2014-10-14 22:21:58 +02:00
conf
debian
decompress (7z) Use stdint types - Types.h was conflicting with OSX 10.6 2014-10-20 04:28:20 +02:00
deps Fix prototype SeqInstream_Readuint8_t 2014-10-20 04:41:49 +02:00
dist-scripts
docs Move Retrolaunch to separate repo 2014-10-16 07:34:59 +02:00
emscripten
frontend Merge pull request #1172 from lakkatv/xmb 2014-10-20 20:06:17 +02:00
gfx (CoreText) Add to AUTHORS 2014-10-20 19:41:39 +02:00
griffin Adding CoreText font driver for iOS and OS X 2014-10-18 20:20:55 -04:00
gx/ld
input (OSX) Change 'index' to 'idx' to avoid declaration of index shadows a global 2014-10-20 03:56:31 +02:00
intl fix disk_next, add option for disk_prev 2014-10-07 20:19:12 -05:00
libretro-test
libretro-test-gl
location
logger
media
mem/neon
msvc
ngc
pandora
performance
ps3 (GCM GL) Cleanups 2014-10-17 06:47:31 +02:00
psp1
qb (XMB) Initial commit 2014-10-09 01:21:22 +02:00
record
tests
thread
tools Move Retrolaunch to separate repo 2014-10-16 07:34:59 +02:00
wii
xdk
.empty
.gitignore Ignore build folder, never going to commit it 2014-10-15 18:53:47 +03:00
.project
AUTHORS (CoreText) Add to AUTHORS 2014-10-20 19:41:39 +02:00
autosave.c
autosave.h
boolean.h
cheats.c
cheats.h
command.c Add support for more Network Commands. 2014-10-07 23:04:46 -05:00
command.h
config.def.h Add History List Enable option 2014-10-17 04:17:28 +02:00
config.features.h
configure
CONTRIBUTING.md
COPYING
core_info.c Reimplement core_info_get_first_custom_config 2014-10-18 07:47:51 +02:00
core_info.h Reimplement core_info_get_first_custom_config 2014-10-18 07:47:51 +02:00
core_options.c Don't name local variables by 'index' to prevent 'declaration shadows global' warnings 2014-10-20 19:13:54 +02:00
core_options.h
dir_list.c
dir_list.h
driver.c Fix buffer overflow in dummy_pixels 2014-10-18 18:29:37 +01:00
driver.h driver.h - Indenting nits 2014-10-15 06:23:04 +02:00
dynamic_dummy.c
dynamic_dummy.h
dynamic.c dynamic.c - Silence 'declaration shadows global variable' 2014-10-14 22:14:14 +02:00
dynamic.h
endianness.h
fifo_buffer.c Put fifo_buffer struct definition in fifo_buffer.h - don't include stdio.h 2014-10-15 06:58:54 +02:00
fifo_buffer.h Put fifo_buffer struct definition in fifo_buffer.h - don't include stdio.h 2014-10-15 06:58:54 +02:00
file_ext.h
file_extract.c Turn zlib_get_default_file_backend into static function 2014-10-14 19:05:59 +02:00
file_extract.h
file_list.c Add file_list_copy function 2014-10-20 19:51:00 +02:00
file_list.h Add file_list_copy function 2014-10-20 19:51:00 +02:00
file_path.c
file_path.h
file.c file.c - fix warnings 2014-10-15 03:13:27 +02:00
file.h
general.c Rename local variables named 'index' elsewhere 2014-10-20 19:22:33 +02:00
general.h Change joypad_map to unsigned and change default value 2014-10-19 16:22:51 +02:00
git_version.c
git_version.h
hash.c
hash.h
libretro_private.h
libretro_version_1.c
libretro.h
Makefile More updates removing retrolaunch and moving it to separate repo 2014-10-16 07:36:06 +02:00
Makefile.common Create menu_list.c 2014-10-17 20:36:02 +02:00
Makefile.emscripten
Makefile.griffin
Makefile.openpandora
Makefile.pandora
Makefile.ps3
Makefile.ps3.cobra
Makefile.ps3.rgl
Makefile.ps3.salamander
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander
Makefile.wii.salamander
Makefile.win
Makefile.xenon
message_queue.c Simplify msg_queue_pull 2014-10-14 20:38:57 +02:00
message_queue.h
miscellaneous.h Refactor buttons variable in udev joypad driver 2014-10-16 22:25:09 +02:00
movie.c
movie.h
netplay_compat.h
netplay.c Avoid index local variables 2014-10-20 19:29:49 +02:00
netplay.h Avoid index local variables 2014-10-20 19:29:49 +02:00
patch.c
patch.h
performance.c (PS3) performance.c - buildfix 2014-10-10 19:02:44 +02:00
performance.h
playlist.c Rename local variables named 'index' elsewhere 2014-10-20 19:22:33 +02:00
playlist.h
README-exynos.md
README-OMAP.md
README.md
retro.h
retroarch_logger.h
retroarch-mingw-build.sh
retroarch.c Add content_loaded callback function invocation when content 2014-10-17 04:49:25 +02:00
retroarch.cfg Add History List Enable option 2014-10-17 04:17:28 +02:00
rewind.c
rewind.h
runloop.c Use PATH_MAX size for string variable 2014-10-16 18:31:05 +02:00
screenshot.c
screenshot.h
settings_data.c Rename local variables named 'index' elsewhere 2014-10-20 19:22:33 +02:00
settings_data.h Rename local variables named 'index' elsewhere 2014-10-20 19:22:33 +02:00
settings_list.c Rename local variables named 'index' elsewhere 2014-10-20 19:22:33 +02:00
settings_list.h Add action start callback to ST_BIND settings too 2014-10-17 08:14:17 +02:00
settings.c Add History List Enable option 2014-10-17 04:17:28 +02:00
string_list.c Cleanups 2014-10-16 08:20:09 +02:00
string_list.h Rename local variables named 'index' elsewhere 2014-10-20 19:22:33 +02:00
thread.c
thread.h

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 Themaister's homepage. Builds can also be found on the forum.

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

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.