Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2016-12-13 01:43:18 +01:00
audio Move code to dynamic.c 2016-12-12 13:30:50 +01:00
bootstrap (VITA) Allow cores to define heap size 2016-10-11 09:40:55 +02:00
camera Prevent some implicit memsets and reduce the size of some 2016-10-27 10:45:53 +02:00
cores More logging 2016-11-09 00:20:44 +01:00
ctr (3DS) wrap texture coordinate swizzeling in a function. 2016-10-10 22:22:08 +01:00
defines Merge pull request #3697 from d3m3vilurr/vita-extend-input 2016-09-30 19:33:04 +02:00
deps Update subrepos 2016-12-11 06:49:48 +01:00
dist-scripts (WiiU) update dist script with fixed newlines in meta.xml 2016-11-23 01:25:53 -05:00
docs mark these as deprecated 2016-08-27 21:56:37 -05:00
emscripten move these files over to the package dir 2016-08-28 19:09:55 -05:00
frontend (platform) Updates 2016-12-13 01:43:18 +01:00
gfx (Vulkan) Rename pipeline files 2016-12-12 13:17:20 +01:00
griffin Fix Griffin 2016-12-12 13:35:17 +01:00
input Revert "changed input binding order" 2016-12-11 19:00:03 +01:00
intl Rename 'Select File' to 'Favorites' 2016-12-13 01:34:54 +01:00
libretro-common Merge pull request #4234 from leiradel/master 2016-12-13 01:11:03 +01:00
libretro-db Revert "Use string_is_equal" 2016-10-04 10:29:32 +02:00
location location_driver_ctl - return 'true' by default 2016-09-29 12:13:46 +02:00
managers Translate "Applying cheat changes." to all languages 2016-10-31 15:05:39 -05:00
media use invader instead 2016-09-09 22:03:50 -05:00
memory (VITA) Add support for -mthumb 2016-11-14 19:13:07 +01:00
menu (OSX) Buildfixes 2016-12-13 01:34:55 +01:00
network HAVE_SOCKET_LEGACY -> no IPv6 2016-12-10 05:27:25 -05:00
pkg (Android) Buildfix 2016-12-12 13:26:45 +01:00
qb Fix typos 2016-12-11 18:30:01 -02:00
record Move audio resampler drivers (Sinc/nearest) to libretro-common; maister gave permission to relicense to MIT 2016-12-12 13:02:29 +01:00
tasks Revert "make state screenshots non-gpu" 2016-12-12 14:14:45 +01:00
tools chmod +x on pkg.py 2016-08-12 00:09:22 +02:00
ui Fix typos 2016-12-11 18:30:01 -02:00
wifi wifi: fix parsing of connmanctl output 2016-11-22 16:04:53 +03:00
wii/app_booter (wii/app_booter) Style nits 2015-09-21 19:28:20 +02:00
wiiu (WiiU) changed linker script to now properly generate a small rpx elf file instead of a 243mb one every time 2016-11-24 09:09:23 +01:00
.editorconfig Add EditorConfig support 2016-09-16 10:44:33 -04:00
.gitignore Those should be ignored 2016-11-14 17:26:11 +01:00
.gitmodules Some firewalls do better with https 2016-10-27 13:53:17 -06:00
.project Allow to load roms from external apps. 2013-08-19 23:23:39 +02:00
.travis.yml Update Scan Coverity key 2016-09-17 18:59:24 +02:00
autosave.h Cleanups 2016-09-01 04:57:04 +02:00
cheevos.c Fix infinite loop with some NES ROMs 2016-11-27 01:01:23 +00:00
cheevos.h separate hardcore achievements 2016-11-05 16:55:57 -05:00
command.c Reset RARCH_PATH_CORE when we select 'Unload Core' 2016-12-12 17:32:49 +01:00
command.h remove confirm_on_exit menu option 2016-10-30 23:29:03 -04:00
config.def.h C89_BUILD fixes 2016-12-10 09:06:11 +01:00
config.features.h Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
configuration.c Remove hacky 'OSK Keyboard' overlay 2016-11-27 02:46:09 +01:00
configuration.h Remove dead OSK code 2016-11-27 02:52:13 +01:00
configure (qb) Add qb.system.sh 2015-06-16 20:46:11 -03:00
content.h update copyright 2016-10-27 11:47:10 -04:00
CONTRIBUTING.md Update CONTRIBUTING.md 2012-12-09 10:16:35 +01:00
COPYING
core_impl.c Put cheevos_reset_game around HAVE_CHEEVOS ifdef 2016-11-04 22:24:34 +01:00
core_info.c core_info: Fix a leak in core_info_database_supports_content_path 2016-11-25 17:38:54 -05:00
core_info.h update copyright 2016-10-27 11:47:10 -04:00
core_type.h Add Start Video Processor menu entry 2016-07-28 20:35:05 +02:00
core.h core.h - remove retro_miscellaneous.h include 2016-12-10 09:04:40 +01:00
database_info.c update copyright 2016-10-27 11:47:10 -04:00
database_info.h update copyright 2016-10-27 11:47:10 -04:00
defaults.h Remove hacky 'OSK Keyboard' overlay 2016-11-27 02:46:09 +01:00
dirs.c Remove hacky 'OSK Keyboard' overlay 2016-11-27 02:46:09 +01:00
dirs.h Remove hacky 'OSK Keyboard' overlay 2016-11-27 02:46:09 +01:00
driver.c Move audio resampler drivers (Sinc/nearest) to libretro-common; maister gave permission to relicense to MIT 2016-12-12 13:02:29 +01:00
driver.h Start adding a WiFi driver 2016-09-22 02:02:43 +02:00
dynamic.c Move code to dynamic.c 2016-12-12 13:30:50 +01:00
dynamic.h fall gracefully back to the menu if a dynamic core could not be loaded 2016-10-11 20:28:36 -04:00
fetch-submodules.sh Add --recursive in case submodules have third-party dependencies 2016-09-11 19:43:16 -04:00
file_path_special.c Change GLUI default font to support more languages 2016-11-02 18:18:04 +01:00
file_path_special.h fix a couple of nits 2016-09-05 22:49:31 -05:00
file_path_str.c add slang shader menu entry to online updater 2016-10-08 15:16:01 -05:00
lakka.h Add missing copyright mention on some files 2016-10-27 18:17:43 +02:00
list_special.c Move audio resampler drivers (Sinc/nearest) to libretro-common; maister gave permission to relicense to MIT 2016-12-12 13:02:29 +01:00
list_special.h update copyright 2016-10-27 11:47:10 -04:00
Makefile Add HAVE_CC_RESAMPLER to more Makefiles 2016-12-12 12:48:04 +01:00
Makefile.common Move audio resampler drivers (Sinc/nearest) to libretro-common; maister gave permission to relicense to MIT 2016-12-12 13:02:29 +01:00
Makefile.ctr Add HAVE_CC_RESAMPLER to more Makefiles 2016-12-12 12:48:04 +01:00
Makefile.ctr.salamander (3DS) salamander build fix. 2016-10-08 02:35:54 +01:00
Makefile.emscripten Add HAVE_CC_RESAMPLER to more Makefiles 2016-12-12 12:48:04 +01:00
Makefile.griffin Move audio resampler drivers (Sinc/nearest) to libretro-common; maister gave permission to relicense to MIT 2016-12-12 13:02:29 +01:00
Makefile.openpandora Remove WANT_RPNG 2016-05-17 13:41:40 +02:00
Makefile.pandora Move pandora files 2015-09-20 15:41:28 +02:00
Makefile.ps3 Add HAVE_CC_RESAMPLER defines 2016-12-12 12:44:29 +01:00
Makefile.ps3.cobra Don't use HAVE_NETPLAY any more 2016-09-29 21:07:10 +02:00
Makefile.ps3.salamander Create file_path_str.c 2016-06-20 05:20:14 +02:00
Makefile.psl1ght Add HAVE_CC_RESAMPLER defines 2016-12-12 12:44:29 +01:00
Makefile.psp1 Add HAVE_CC_RESAMPLER defines 2016-12-12 12:44:29 +01:00
Makefile.psp1.salamander Add file_path_str.c to PSP Salamander 2016-06-20 18:14:13 +02:00
Makefile.vita.salamander (VITA) Initial Salamander 2016-09-08 01:26:03 +02:00
Makefile.wii.salamander Add file_path_str for Salamander 2016-06-28 03:21:30 +02:00
Makefile.wiiu Add HAVE_CC_RESAMPLER defines 2016-12-12 12:44:29 +01:00
Makefile.win Add HAVE_CC_RESAMPLER to more Makefiles 2016-12-12 12:48:04 +01:00
movie.c Move code to movie.c 2016-09-17 01:54:33 +02:00
movie.h Move code to movie.c 2016-09-17 01:54:33 +02:00
msg_hash.c fix code-style issue 2016-10-29 12:17:26 +08:00
msg_hash.h Rename 'Select File' to 'Favorites' 2016-12-13 01:34:54 +01:00
no-xib.diff Add no-xib.diff 2015-10-13 23:23:33 +02:00
patch.c Revert "Move global->name to paths.c" 2016-10-01 08:18:23 +02:00
patch.h Use RETRO_BEGIN_DECLS/RETRO_END_DECLS in more files 2016-06-03 03:22:35 +02:00
paths.c Prevent some implicit memsets and reduce the size of some 2016-10-27 10:45:53 +02:00
paths.h Get rid of path_get_core_size 2016-10-03 16:17:08 +02:00
performance_counters.c Get rid of more general.h includes 2016-09-01 18:01:41 +02:00
performance_counters.h Use retro_common_api.h 2016-06-03 06:02:49 +02:00
playlist.c playlist_free_entry - use string_is_empty 2016-12-11 23:00:26 +01:00
playlist.h (Menu) Get Remove from Playlist to work on history playlists 2016-08-29 02:22:05 +02:00
README-exynos.md exynos: update TODO list 2014-08-09 16:43:48 +02:00
README-mali_fbdev_r4p0.md Fix some spelling errors (pendantic info lintian warnings). 2016-07-20 23:28:29 -03:00
README-OMAP.md video_omap: more docu fixes 2014-01-14 16:39:24 -06:00
README.md README.md: Minor Markdown fixes 2016-12-11 17:55:36 -02:00
retroarch-mingw-build.sh Add support for different "make" binaries 2014-07-30 01:14:57 +02:00
retroarch.c Add more translatable strings 2016-11-08 15:17:02 +01:00
retroarch.cfg Update skeleton cfg (download directory) 2016-12-07 06:13:40 -06:00
retroarch.desktop (Linux) Add a GenericName to the desktop entry 2015-06-18 09:49:14 -07:00
retroarch.h (retroarch.c) Add RARCH_CTL_IS_MAIN_THREAD 2016-10-17 20:50:19 -03:00
runloop.c Cleanup runloop.h header 2016-12-10 07:21:34 +01:00
runloop.h runloop.h header include cleanup - don't include retro_miscellaneous.h 2016-12-10 08:10:02 +01:00
setting_list.c Reintroduce setting_get_type 2016-10-31 15:01:40 +01:00
setting_list.h Reintroduce setting_get_type 2016-10-31 15:01:40 +01:00
verbosity.c (MSVC) Buildfix 2016-10-09 17:17:29 +02:00
verbosity.h Cleanups 2016-09-12 16:36:27 +02:00
version_git.c Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +02:00
version_git.h Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +02:00
version.h Rename git_version.c to version_git.h, create separate 2016-09-01 17:49:28 +02:00

Build Status Coverity Scan Build Status

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.

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:

  • PlayStation 3
  • Xbox 360 (Libxenon/XeXDK)
  • Xbox 1
  • Wii, Gamecube (Libogc)
  • Nintendo 3DS
  • Raspberry Pi
  • Android
  • iOS
  • Blackberry

Dependencies (PC)

There are no true hard dependencies per se.

On Windows, RetroArch can run with only Win32 as dependency.

On Linux, there are no true dependencies. For optimal usage, the following dependencies come as recommended:

  • GL headers / Vulkan 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.

PlayStation 3

RetroArch PS3 needs to be compiled in the following order:

  1. Compile RetroArch Salamander

    make -f Makefile.ps3.salamander

  2. Finally, compile RetroArch packed together with the GUI:

    make -f Makefile.ps3

PlayStation 3 - 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.griffin platform=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.