Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
twinaphex 419620a49e (360) Add viewport hack for now so that XUI doesn't get
cut off depending on the viewport of the game
2013-04-19 23:22:58 +02:00
android Use CGP/GLSL-style format on Android and iOS. 2013-04-11 15:40:57 +02:00
audio (iOS) Various: 2013-04-18 20:39:43 -04:00
blackberry-qnx (BlackBerry) A working BB10 Cascades frontend to choose rom and core currently 2013-04-19 13:32:17 -04:00
compat Fixups in shuffle_block. 2013-04-12 16:37:52 +03:00
conf Reintroduce CGP refactor. 2013-04-06 12:00:10 +02:00
console Remove screenshots_dir and cgp_dir from default_paths - cgp_dir 2013-04-06 22:37:07 +02:00
deps Slim down miniz - filesize from binary went from 10.7MB to 10.2MB 2013-04-07 21:55:55 +02:00
dist-scripts Update READMEs 2013-03-24 01:35:32 +01:00
docs Document behavior with no args. 2013-04-14 22:41:43 +02:00
frontend (360) Add viewport hack for now so that XUI doesn't get 2013-04-19 23:22:58 +02:00
gfx (BlackBerry) A working BB10 Cascades frontend to choose rom and core currently 2013-04-19 13:32:17 -04:00
griffin (BlackBerry) A working BB10 Cascades frontend to choose rom and core currently 2013-04-19 13:32:17 -04:00
gx (GX) Use GX_InitTexObjFilterMode to set filtering modes 2013-04-19 16:23:09 +02:00
input (PS3) Compile in HAVE_OVERLAY 2013-04-10 04:39:27 +02:00
ios (iOS) Various: 2013-04-18 20:39:43 -04:00
libretro-test Check for updated values, log options. 2013-04-04 14:13:42 +02:00
libretro-test-gl Don't use VAO in libretro-test-gl. 2013-04-06 14:05:14 +02:00
media (XDK1) Go lower - to 256x224 - this leaves us with 3.28MB 2013-04-13 16:31:35 +02:00
msvc (RMenu/RGUI) Create menu_common to tie RMenu/RGUI more closely together 2013-04-17 23:31:49 +02:00
ngc (NGC) Remove sidestep code 2013-02-14 15:48:14 +01:00
pandora Revert "More scrubbing (pt. 2)" 2013-04-06 03:52:58 +02:00
ps3 (PS3/XDK) Don't rely on frame_count anymore for menu toggle 2013-04-18 23:54:15 +02:00
psp Revert "Remove platform-specific MAX_PADS - use global define MAX_PLAYERS" 2013-03-16 17:51:45 +01:00
psp1
qb Enable RGUI by default. 2013-04-11 23:31:00 +02:00
record Include avutil/channel_layout.h correctly. 2013-03-15 14:47:45 +01:00
thread
tools Fix wrong sampler translation in cg2glsl. 2013-04-16 15:44:41 +02:00
vita
wii (GX) Remove Wiiuse 2013-02-15 01:34:03 +01:00
xdk (360) Add viewport hack for now so that XUI doesn't get 2013-04-19 23:22:58 +02:00
xenon Revert "Remove platform-specific MAX_PADS - use global define MAX_PLAYERS" 2013-03-16 17:51:45 +01:00
.empty
.gitignore ignore ios provisioning files 2013-03-25 11:38:23 -04:00
AUTHORS Update AUTHORS 2013-04-09 05:08:41 +03:00
autosave.c
autosave.h
boolean.h
cheats.c
cheats.h
command.c Remove fixed shader index in set_shader. 2013-04-07 13:00:21 +02:00
command.h
config.def.h (Salamander) Ifndef some stuff in config.def.h for Salamander 2013-04-14 14:23:54 +02:00
config.features.h
configure Bump versions to 0.9.8.4. 2013-03-16 14:29:45 +01:00
CONTRIBUTING.md
COPYING
core_options.c Set updated to false when core_config_get is called. 2013-04-04 18:10:34 +02:00
core_options.h Begin adding core options interface. 2013-04-04 13:58:30 +02:00
driver_funcs.h (Android) Some leftover Android garbage that was never expanded upon - scrub 2013-04-11 17:31:46 +02:00
driver.c Fix shader dir crash if folder doesn't exist. 2013-04-16 12:01:50 +02:00
driver.h (RMenu/RGUI) Move filebrowser/menu stack initialization to upper-layer 2013-04-18 18:33:03 +02:00
dynamic_dummy.c Namespace dummy libretro core better. 2013-04-19 08:15:43 +02:00
dynamic_dummy.h Add dummy core loading. 2013-04-14 16:29:30 +02:00
dynamic.c Log core option GET_VARIABLE correctly. 2013-04-15 16:04:08 +02:00
dynamic.h Add dummy core loading. 2013-04-14 16:29:30 +02:00
fifo_buffer.c Update fifo_buffer.c license header - license header was still 2013-04-04 07:26:29 +02:00
fifo_buffer.h
file_extract.c Change WANT_RZLIB to WANT_MINIZ 2013-02-16 21:43:29 +01:00
file_extract.h
file_path.c Simplify some _WIN32 includes 2013-04-11 22:35:15 +02:00
file.c Simplify some _WIN32 includes 2013-04-11 22:35:15 +02:00
file.h Remove superfluous wcstombs / mbstowcs wrappers 2013-04-11 17:18:23 +02:00
general.h (RMenu/RGUI) Move filebrowser/menu stack initialization to upper-layer 2013-04-18 18:33:03 +02:00
hash.c
hash.h Change WANT_RZLIB to WANT_MINIZ 2013-02-16 21:43:29 +01:00
libretro.h Begin adding core options interface. 2013-04-04 13:58:30 +02:00
Makefile (RMenu/RGUI) Create menu_common to tie RMenu/RGUI more closely together 2013-04-17 23:31:49 +02:00
Makefile.ngc (Grifin) Move griffin to root (to indicate it's no longer console-specific 2013-03-18 05:46:19 +01:00
Makefile.pandora
Makefile.ps3 (PS3) Compile in HAVE_OVERLAY 2013-04-10 04:39:27 +02:00
Makefile.ps3.rgl (RGL PS3) Combine files 2013-03-30 17:06:19 +01:00
Makefile.ps3.salamander (Salamander) Split up Salamander into its own separate file 2013-03-22 21:27:34 +01:00
Makefile.psl1ght (Grifin) Move griffin to root (to indicate it's no longer console-specific 2013-03-18 05:46:19 +01:00
Makefile.psp1 (Grifin) Move griffin to root (to indicate it's no longer console-specific 2013-03-18 05:46:19 +01:00
Makefile.shaders Use CGP/GLSL-style format on Android and iOS. 2013-04-11 15:40:57 +02:00
Makefile.wii (WII) fix RGUI controls 2013-04-12 09:19:02 -04:00
Makefile.wii.salamander (Salamander) Split up Salamander into its own separate file 2013-03-22 21:27:34 +01:00
Makefile.win (RMenu/RGUI) Create menu_common to tie RMenu/RGUI more closely together 2013-04-17 23:31:49 +02:00
Makefile.xenon (Grifin) Move griffin to root (to indicate it's no longer console-specific 2013-03-18 05:46:19 +01:00
message.c
message.h
movie.c
movie.h
netplay_compat.h
netplay.c Don't compile in autosave for consoles 2013-02-17 02:00:51 +01:00
netplay.h
patch.c
patch.h
performance.c (Playbook) Add NEON sinc/audio_utils 2013-02-28 15:25:27 +01:00
performance.h Fix CXX_BUILD. 2013-02-08 12:05:22 +01:00
README.md Update README.md 2013-03-22 14:52:55 +01:00
retroarch_logger.h
retroarch-mingw-build.sh
retroarch-zip
retroarch.c Preserve sram/state dir on reentrancy. 2013-04-16 12:22:27 +02:00
retroarch.cfg Remove references to audio_rate_step. 2013-04-14 13:21:12 +02:00
rewind.c
rewind.h
screenshot.c Don't hardcode in an ext in fill_dated_*. 2013-02-17 10:20:10 +01:00
screenshot.h
settings.c (RMenu/RGUI) Move filebrowser/menu stack initialization to upper-layer 2013-04-18 18:33:03 +02:00
thread.c Simplify some _WIN32 includes 2013-04-11 22:35:15 +02:00
thread.h

RetroArch

RetroArch (formerly known as SSNES) is a simple frontend for the libretro API. An API that attempts to generalize a retro gaming system, such as SNES, NES, GameBoy, Arcade machines, etc. Emulator/game cores are instantiated as loadable plugins.

libretro

libretro is an API that exposes the core of a retro gaming system. A frontend for libretro handles video output, audio output and input. A libretro core written in portable C or C++ can run seamlessly on many platforms.

libretro API header

Binaries

Latest Windows binaries are currently hosted on my homepage.

Related projects

Philosophy

RetroArch attempts to be very small and lean, while still having all the useful core features expected from an emulator. It is used through command-line. It is also designed to be portable.

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 still requires SDL 1.2 libraries.

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. 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. Each user should create a config file in $XDG_CONFIG_HOME/retroarch/retroarch.cfg. The 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 retroarch-joyconfig tool. It is also possible to configure joypads using the RetroArch-Phoenix GUI frontend.

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'.