Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
Twinaphex 37544a7b3b Merge pull request #2439 from ssangkong/patch-3
Fix : iOS UI Bug with navigation bar
2015-11-21 09:48:57 +01:00
audio Emscripten related fixes. 2015-07-17 12:46:08 +02:00
bootstrap
camera Use UINT64_C(1) everywhere instead of 1ULL 2015-07-12 07:53:46 +02:00
cores (ffmpeg_core.c) Buildfix 2015-06-30 14:38:19 +02:00
ctr
defines (GX) Move defines to defines/gx_defines.h 2015-11-18 12:55:28 +01:00
deps Update stb_truetype 2015-07-17 11:15:04 +02:00
dist-scripts (PS3) Remove unused makefile from distscripts 2015-06-14 12:33:08 +02:00
docs
emscripten Emscripten related fixes. 2015-07-17 12:46:08 +02:00
frontend Revert "(iOS) Use the sandboxed Documents directory" 2015-11-19 02:38:33 +01:00
gfx Set g_egl_inited to false after egl_destroy 2015-11-21 09:39:25 +01:00
griffin Add gfx/common/egl_common.c 2015-11-19 13:16:43 +01:00
input Add RARCH_DISPLAY_CTL_IS_FOCUSED 2015-11-20 15:24:24 +01:00
intl Added Polish translation 2015-07-08 00:16:38 +02:00
libretro-common Create 'loading and saving' of configuration settings for video_driver_ctl 2015-11-21 09:32:51 +01:00
libretro-db More C89_BUILD buildfixes 2015-11-19 13:43:48 +01:00
location (location_driver.c) Use rarch_system_info_get_ptr 2015-06-25 13:14:11 +02:00
media Move win32_resource.h 2015-11-19 07:59:10 +01:00
memory (GX) Move defines to defines/gx_defines.h 2015-11-18 12:55:28 +01:00
menu (menu_setting.h) Put macros inside headers 2015-11-21 09:47:09 +01:00
pkg (Android) Define HAVE_EGL 2015-11-19 13:55:16 +01:00
qb (ALSA) There was a C89-compatible API here, now it's gone 2015-11-19 12:52:23 +01:00
record Add RARCH_DISPLAY_CTL_READ_VIEWPORT 2015-11-20 15:41:20 +01:00
tasks More C89_BUILD buildfixes 2015-11-19 13:43:48 +01:00
tests Remove instances of 'RetroArch' name with 'program' 2015-06-30 15:26:14 +02:00
tools Fixed nunchuk controller support, it was not correctly detected. 2015-07-13 22:58:01 -05:00
ui Fix : iOS UI Bug with navigation bar 2015-11-21 17:35:24 +09:00
wii/app_booter Some manifest cleanups 2015-07-15 12:24:25 +02:00
.empty
.gitignore
.project
autosave.c (autosave.c) Cleanups 2015-06-22 21:23:13 +02:00
autosave.h
cheats.c Cleanup some other small leaks to do with config_get_string 2015-07-09 20:16:30 +02:00
cheats.h
cheevos.c (cheevos) Fix clang warning 2015-11-19 10:05:08 -03:00
cheevos.h
circle.yml
command_event.c Ifdef 'SET_PER_GAME_RESOLUTION' for Gekko right now - this is still 2015-11-21 09:31:08 +01:00
command_event.h Refactor Wii per-game resolution mode to be somewhat generic 2015-11-21 08:56:24 +01:00
command.c (command.c) Cleanups 2015-07-02 21:35:57 +02:00
command.h
config.def.h turn this option off by default 2015-11-17 16:28:48 -05:00
config.features.h Refactors 2015-07-03 00:16:46 +02:00
configuration.c Create 'loading and saving' of configuration settings for video_driver_ctl 2015-11-21 09:32:51 +01:00
configuration.h fix setting and clearing system directory when using content dir 2015-07-16 01:46:11 -05:00
configure (qb) Add qb.system.sh 2015-06-16 20:46:11 -03:00
content.c Start going through rarch_main_ctl for grabbing fullpath 2015-11-18 11:43:25 +01:00
content.h
CONTRIBUTING.md
COPYING
core_info.c core_info_list_get_all_extensions - check if global is non-NULL 2015-11-20 13:53:19 +01:00
core_info.h Implement core assignation switching 2015-11-20 05:20:13 +07:00
core_options.c (core_options.c) Make code more robust 2015-06-25 15:38:57 +02:00
core_options.h
database_info.c Cleanups 2015-07-02 00:56:51 +02:00
database_info.h C89 fixes/cleanups 2015-06-26 16:04:42 +02:00
dir_list_special.c
dir_list_special.h (dir_list_special.h) C89 build fix 2015-06-26 16:09:11 +02:00
driver.c Add RARCH_DISPLAY_CTL_MONITOR_ADJUST_SYSTEM_RATES 2015-11-20 20:47:47 +01:00
driver.h Decouple 'overlay' state from driver_t 2015-07-09 01:10:30 +02:00
dynamic.c rarch_game_specific_options - use strdup, free outside of 2015-11-20 17:03:36 +01:00
dynamic.h Add RARCH_DISPLAY_CTL_SET_NONBLOCK_STATE 2015-11-20 17:22:19 +01:00
fetch-submodules.sh
file_ext.h
file_ops.c (file_ops.c) Fix -Wsign_compare warning 2015-06-23 11:49:24 +02:00
file_ops.h
file_path_special.c C89_BUILD fixes 2015-06-29 21:39:00 +02:00
general.h Bump up to 1.2.2 2015-07-16 10:12:31 +02:00
git_version.c
git_version.h
libretro_private.h
libretro_version_1.c Add RARCH_DISPLAY_CTL_FRAME_FILTER_ALIVE 2015-11-20 15:14:12 +01:00
libretro_version_1.h
libretro.h C source isn't executable. Nor is that bitmap. 2015-07-12 12:51:52 +02:00
Makefile Add C89_BUILD flag that makes the compiler throw about 30000 errors. 2015-06-26 15:43:45 +02:00
Makefile.common Add gfx/common/egl_common.c 2015-11-19 13:16:43 +01:00
Makefile.ctr
Makefile.emscripten Makefile.emscripten - add HAVE_EGL 2015-11-20 17:41:50 +01:00
Makefile.griffin Fixed nunchuk controller support, it was not correctly detected. 2015-07-13 22:58:01 -05:00
Makefile.openpandora
Makefile.pandora
Makefile.ps3 (PS3) Compile in HAVE_STB_FONT - remove <memory.h> dependency 2015-07-14 17:21:11 +02:00
Makefile.ps3.cobra
Makefile.ps3.salamander Add rhash.c to Salamander 2015-06-15 01:56:01 +02:00
Makefile.psl1ght
Makefile.psp1
Makefile.psp1.salamander Add rhash.c to Salamander 2015-06-15 01:56:01 +02:00
Makefile.wii.salamander Add rhash.c to Salamander 2015-06-15 01:56:01 +02:00
Makefile.win Make stb font support optional 2015-07-14 12:00:28 -03:00
movie.c (libretro-common) Move hash.c/hash.h to libretro-common 2015-06-04 21:13:13 +02:00
movie.h
msg_hash.c Add Polish (ISO-8859-2) 2015-07-07 02:56:27 +02:00
msg_hash.h Add Polish (ISO-8859-2) 2015-07-07 02:56:27 +02:00
net_http_special.c
net_http_special.h
netlogger.c
netplay.c (netplay.c) C89_BUILD buildfixes 2015-11-19 13:03:23 +01:00
netplay.h C89_BUILD fixes 2015-11-19 12:30:00 +01:00
no-xib.diff
patch.c Cleanups 2015-07-02 00:56:51 +02:00
patch.h
performance.c (SNC) Fix a bunch of compiler warnings 2015-06-30 15:49:40 +02:00
performance.h
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
README-mali_fbdev_r4p0.md
README-OMAP.md
README.md
retroarch_info.c
retroarch-mingw-build.sh
retroarch.c Refactor Wii per-game resolution mode to be somewhat generic 2015-11-21 08:56:24 +01:00
retroarch.cfg (Menu) Refactor zip file handling to be list-based 2015-07-14 12:49:54 +02:00
retroarch.desktop
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 (rewind.c) Style nits 2015-07-02 18:24:55 +02:00
rewind.h Split these functions out. ctult needs them for netplay. 2015-06-27 04:53:37 +02:00
runloop_data.c Move more code to input_overlay.c 2015-07-12 06:47:39 +02:00
runloop_data.h (runloop_data.c) Cleanups 2015-07-09 00:01:55 +02:00
runloop_msg.c Create rarch_main_msg_queue_push_new 2015-07-01 01:49:32 +02:00
runloop.c Add RARCH_DISPLAY_CTL_CACHED_FRAME_RENDER 2015-11-20 15:34:10 +01:00
runloop.h Create RARCH_MAIN_CTL_SET_WINDOWED_SCALE 2015-11-18 11:55:23 +01:00
screenshot.c Add RARCH_DISPLAY_CTL_READ_VIEWPORT 2015-11-20 15:41:20 +01:00
screenshot.h
string_list_special.c
string_list_special.h
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

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.