Cross-platform, sophisticated frontend for the libretro API. Licensed GPLv3.
Go to file
2013-04-04 13:06:32 -04:00
android (Android) Add Sega Virtua Stick to input autodetection list 2013-03-30 08:56:46 +01:00
audio Use more compatible .globl symbols in NEON ASM. 2013-03-27 00:38:11 +01:00
compat
conf Major refactor to CGP parsing. 2013-04-01 15:34:02 +02:00
console Combine menu_settings_set and menu_settings_set_default and 2013-03-23 17:21:42 +01:00
deps
dist-scripts Update READMEs 2013-03-24 01:35:32 +01:00
docs
frontend (RGUI) Add 'Change Game' option to RGUI Settings 2013-04-04 04:56:04 +02:00
gfx Fix CXX_BUILD. 2013-04-04 14:36:24 +02:00
griffin Include core_options in griffin. 2013-04-04 14:15:13 +02:00
gx (PS3) Get rid of QUICKMENU_TOGGLE define - was surpassing 64 entries 2013-03-30 07:19:42 +01:00
input Don't warp pointer unless needed. 2013-03-29 19:30:09 +01:00
ios (iOS Thread) Sync input data between main and retroarch thread 2013-04-04 13:06:32 -04:00
libretro-test Check for updated values, log options. 2013-04-04 14:13:42 +02:00
libretro-test-gl Use VAOs for completion. 2013-03-29 16:13:00 +01:00
media (Android) Update overlays - now adds an RGUI toggle button 2013-03-25 03:07:58 +01:00
msvc win32: adjust MSVC project file 2013-03-30 14:57:52 +01:00
ngc
pandora
playbook (Blackberry) Add HAVE_RGUI to managed build 2013-03-24 00:23:48 +01:00
ps3 (RGL PS3) Integrate rglGcmCopySurface into rglPlatformValidateTextureResources 2013-03-30 23:49:54 +01:00
psp
psp1
qb
record
thread
tools Basic mouse grabbing for X11. 2013-03-29 18:55:54 +01:00
vita
wii
xdk (PS3) Get rid of QUICKMENU_TOGGLE define - was surpassing 64 entries 2013-03-30 07:19:42 +01:00
xenon
.empty
.gitignore add some things to .gitignore for xcode projects 2013-03-19 11:57:51 -04:00
AUTHORS Update AUTHORS. 2013-03-29 16:24:19 +01:00
autosave.c
autosave.h
boolean.h
cheats.c
cheats.h
command.c Basic mouse grabbing for X11. 2013-03-29 18:55:54 +01:00
command.h
config.def.h Basic mouse grabbing for X11. 2013-03-29 18:55:54 +01:00
config.features.h
configure
CONTRIBUTING.md
COPYING
core_options.c Check for updated values, log options. 2013-04-04 14:13:42 +02:00
core_options.h Begin adding core options interface. 2013-04-04 13:58:30 +02:00
driver_funcs.h
driver.c Disable threaded driver with HW render. 2013-03-30 21:20:26 +01:00
driver.h Merge pull request #169 from Themaister/gl-render 2013-03-30 06:33:53 -07:00
dynamic.c Begin adding core options interface. 2013-04-04 13:58:30 +02:00
dynamic.h Use more approriate namespacing. 2013-03-22 23:42:34 +01: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
file_extract.h
file_path.c
file.c
file.h
general.h Begin adding core options interface. 2013-04-04 13:58:30 +02:00
hash.c
hash.h
libretro.h Begin adding core options interface. 2013-04-04 13:58:30 +02:00
Makefile Begin adding core options interface. 2013-04-04 13:58:30 +02:00
Makefile.ngc
Makefile.pandora
Makefile.ps3
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
Makefile.psp1
Makefile.shaders
Makefile.wii
Makefile.wii.salamander (Salamander) Split up Salamander into its own separate file 2013-03-22 21:27:34 +01:00
Makefile.win Begin adding core options interface. 2013-04-04 13:58:30 +02:00
Makefile.xenon
message.c
message.h
movie.c
movie.h
netplay_compat.h
netplay.c
netplay.h
patch.c
patch.h
performance.c
performance.h
README.md Update README.md 2013-03-22 14:52:55 +01:00
retroarch_logger.h
retroarch-mingw-build.sh
retroarch-zip
retroarch.c Begin adding core options interface. 2013-04-04 13:58:30 +02:00
retroarch.cfg Begin adding core options interface. 2013-04-04 13:58:30 +02:00
rewind.c
rewind.h
screenshot.c
screenshot.h
settings.c Begin adding core options interface. 2013-04-04 13:58:30 +02:00
thread.c
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'.