Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2015-03-15 05:10:13 +01:00
android/phoenix Take out limited shader stuff from Android launcher menu - shaders should be 2015-03-04 21:04:24 +01:00
apple Update more old code to go through the new wrapper function 2015-03-15 02:59:38 +01:00
audio (JACK) Use rthreads 2015-03-15 05:10:13 +01:00
blackberry-qnx Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
camera Update more old code to go through the new wrapper function 2015-03-15 02:59:38 +01:00
debian
decompress Rename deps/rzlib to deps/zlib 2015-03-06 01:47:09 +01:00
deps Update deps/zlib 2015-03-10 18:29:43 +01:00
dist-scripts Use Shader Options from now on 2015-03-04 20:22:07 +01:00
docs Update docs/retroarch.1 2015-01-24 04:09:40 +01:00
emscripten
frontend Use retro_inline throughout 2015-03-15 04:52:46 +01:00
gfx Use retro_inline throughout 2015-03-15 04:52:46 +01:00
griffin Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
gx/ld
input Use retro_inline throughout 2015-03-15 04:52:46 +01:00
intl
libretro-common (Menu) Add font color settings 2015-03-14 19:22:06 -03:00
libretro-db Rename libretrodb to libretro-db 2015-02-19 00:47:19 +01:00
libretro-test (libretro-test) Update linux-portable 2015-03-05 23:51:14 +01:00
libretro-test-gl (Libretro TestGL) Updates 2015-02-22 05:26:57 +01:00
location Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
logger Use retro_inline throughout 2015-03-15 04:52:46 +01:00
media (Win32 UI) Add Audio Mute Toggle 2015-01-15 23:55:49 +01:00
mem/neon
menu Use retro_inline throughout 2015-03-15 04:52:46 +01:00
msvc Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
ngc
pandora
performance Use retro_inline throughout 2015-03-15 04:52:46 +01:00
ps3 Double semicolons aren't useful. 2015-02-10 22:29:26 +01:00
psp1
qb Added native Raspebbry Pi Dispmanx API backend 2015-03-13 05:59:52 +01:00
record Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
tests
tools Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
wii Use retro_inline throughout 2015-03-15 04:52:46 +01:00
win32 (Win32 UI) Add Audio Mute Toggle 2015-01-15 23:55:49 +01:00
xdk Use retro_inline throughout 2015-03-15 04:52:46 +01:00
.empty
.gitignore added linux build instructions, Vagrantfile to prove it, and updated .gitignore 2015-02-13 14:43:07 -08:00
.project
AUTHORS
autosave.c
autosave.h
cheats.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
cheats.h Add Cheat File Save As 2015-01-19 19:00:26 +01:00
circle.yml Mac OS X / CircleCI fixes 2015-03-06 14:04:21 -08:00
command.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
command.h
config.def.h (Menu) Add font color settings 2015-03-14 19:22:06 -03:00
config.features.h
configure
content.c Move patch code to patch.c 2015-02-19 04:30:53 +01:00
content.h
CONTRIBUTING.md
COPYING
core_info.c (PSP) fix build. 2015-02-25 13:30:46 +01:00
core_info.h Add database info to core_info.c 2015-01-25 08:21:02 +01:00
core_options.c More documentation for core options functions and change 2015-01-16 02:10:17 +01:00
core_options.h More documentation for core options functions and change 2015-01-16 02:10:17 +01:00
database_info.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
database_info.h (OSX PPC) Build fixes 2015-02-23 01:32:50 +01:00
driver.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
driver.h Start implementing wraparound for changing drivers 2015-03-09 14:32:58 +01:00
dynamic_dummy.c (dynamic_dummy.c) Declare variables at top 2015-01-17 03:21:37 +01:00
dynamic_dummy.h
dynamic.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
dynamic.h Add documentation to dynamic.c 2015-01-15 02:48:40 +01:00
fetch-submodules.sh Don't use git -C and get rid of echo_cmd (doesn't do what it should) 2015-02-16 20:47:54 -08:00
file_ext.h
file_extract.c Change returntype of file_cb for zlib_parse_file 2015-02-23 01:23:21 +01:00
file_extract.h Change returntype of file_cb for zlib_parse_file 2015-02-23 01:23:21 +01:00
file_ops.c Cleanup in read_generic_file 2015-03-03 09:51:06 +01:00
file_ops.h Change returntype of read_file 2015-02-23 01:27:39 +01:00
file_path_special.c Take RARCH_INTERNAL code from file_path.c out of libretro-common 2015-03-13 05:03:50 +01:00
general.h Use INLINE in general.h and include retro_inline.h 2015-03-15 04:25:49 +01:00
git_version.c
git_version.h
hash.c (hash.c) Use C-style comments 2015-01-15 02:06:01 +01:00
hash.h Use retro_inline throughout 2015-03-15 04:52:46 +01:00
libretro_private.h
libretro_version_1.c Start going through INLINE 2015-03-15 04:30:46 +01:00
libretro_version_1.h Cleanups in libretro_version_1.c 2015-01-13 02:33:29 +01:00
libretro.h (Mouse) Start adding preliminary horizontal mouse wheel up/down 2015-03-12 05:38:37 +01:00
Makefile Fix make install 2015-03-06 10:58:30 +01:00
Makefile.common Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.emscripten Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.griffin Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.openpandora Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.pandora Build fixes 2015-01-12 23:38:21 +01:00
Makefile.ps3 Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.ps3.cobra Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.ps3.rgl Renamed libretro-sdk to libretro-common 2015-02-19 00:04:03 +01:00
Makefile.ps3.salamander Renamed libretro-sdk to libretro-common 2015-02-19 00:04:03 +01:00
Makefile.psl1ght Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.psp1 Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.psp1.salamander Renamed libretro-sdk to libretro-common 2015-02-19 00:04:03 +01:00
Makefile.wii.salamander Renamed libretro-sdk to libretro-common 2015-02-19 00:04:03 +01:00
Makefile.win Turn WANT_MINIZ into WANT_ZLIB 2015-03-14 05:24:57 +01:00
Makefile.xenon
movie.c
movie.h
net_compat.c (net_compat.c) Cleanups 2015-02-02 19:15:59 +01:00
net_compat.h Core Update Manager works again when HAVE_NETWORKING is defined - 2015-01-28 08:55:02 +01:00
net_http_test.c (net_http_test.c) Cleanups 2015-01-26 20:48:40 +01:00
net_http.c Make HTTP connection info code non-blocking 2015-02-26 05:35:58 +01:00
net_http.h Make HTTP connection info code non-blocking 2015-02-26 05:35:58 +01:00
netplay.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
netplay.h Core Update Manager works again when HAVE_NETWORKING is defined - 2015-01-28 08:55:02 +01:00
patch.c Should fix UPS/IPS/BPS patching 2015-03-12 21:56:13 +01:00
patch.h Move patch code to patch.c 2015-02-19 04:30:53 +01:00
performance.c (OSX/iOS) Implement clock_gettime for OSX/iOS 2015-02-28 18:51:07 +01:00
performance.h Use retro_inline.h 2015-03-15 04:41:11 +01:00
playlist.c Create content_playlist_get_index_by_path -make pointers 2015-02-03 04:12:32 +01:00
playlist.h Create content_playlist_get_index_by_path -make pointers 2015-02-03 04:12:32 +01:00
README-exynos.md
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md added linux build instructions, Vagrantfile to prove it, and updated .gitignore 2015-02-13 14:43:07 -08:00
retroarch_logger.h
retroarch-mingw-build.sh
retroarch.c Get rid of LOG_FILE_DEINIT in rarch_main_state_free - already 2015-03-15 04:21:26 +01:00
retroarch.cfg g_settings.menu.throttle is no longer used and is enabled by 2015-03-09 19:20:15 +01:00
retroarch.h Create RARCH_CMD_LOAD_CORE_DEINIT 2015-03-07 14:54:04 +01:00
rewind.c Start using retro_inline.h for rewind.c 2015-03-15 04:28:53 +01:00
rewind.h
runloop_data.c Move definition of globals for g_data_runloop and g_runloop 2015-03-15 03:21:58 +01:00
runloop.c Start going through INLINE 2015-03-15 04:30:46 +01:00
runloop.h Create wrapper functions for initing the runloop message queue 2015-03-15 03:10:45 +01:00
screenshot.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
screenshot.h Move screenshot code to screenshot.c and out of retroarch.c 2015-02-10 20:58:33 +01:00
settings_data.c Create wrapper functions for passing a message to the runloop's 2015-03-15 02:47:23 +01:00
settings_data.h Fixing iOS build 2015-02-08 10:00:39 -05:00
settings_list.c
settings_list.h Update action toggle handler 2015-03-09 04:18:47 +01:00
settings.c Move definition of globals for g_data_runloop and g_runloop 2015-03-15 03:21:58 +01:00
settings.h Add config_save_keybinds_file 2015-01-19 07:43:28 +01: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

./configure

- ```bash
make

Mac

  • Prerequisites: XCode, Cg.
  • You can open the project (apple/RetroArch_OSX.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_OSX -configuration Debug -project apple/RetroArch_OSX.xcodeproj
# Run
open ./apple/build/Debug/RetroArch_OSX.app/
  • Release:
# Build
xcodebuild -target RetroArch_OSX -configuration Release -project apple/RetroArch_OSX.xcodeproj
# Run
open ./apple/build/Release/RetroArch_OSX.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.