Difference between revisions of "RetroArch"

From ArchWiki
Jump to: navigation, search
(Input devices do not operate: don't duplicate Users and groups#Group management)
 
(70 intermediate revisions by 25 users not shown)
Line 1: Line 1:
 
[[Category:Gaming]]
 
[[Category:Gaming]]
 
[[Category:Emulators]]
 
[[Category:Emulators]]
[http://themaister.net/retroarch.html RetroArch] is a modular, command-line driven, multi-system emulator that is designed to be fast, lightweight, and portable. It has features few other emulators frontends have, such as real-time rewinding and game-aware shading based on the [http://github.com/libretro/libretro.github.com/wiki/Documentation-devs libretro API].
+
[[es:RetroArch]]
 +
[[ja:RetroArch]]
 +
{{Note|RetroArch is not affiliated with [[Arch Linux]].}}
 +
 
 +
[http://www.retroarch.com/ RetroArch] is a modular, command-line driven, multi-system emulator that is designed to be fast, lightweight, and portable. Some of its features can be found on few other emulators, such as real-time rewinding and game-aware shading based on the libretro API.
  
 
== Installation ==
 
== Installation ==
  
Install {{aur|retroarch-git}} from the [[AUR]].
+
1. Install the {{Pkg|retroarch}} package or alternatively {{AUR|retroarch-git}} for the development version.
  
A GTK+/Qt frontend, {{aur|retroarch-phoenix-git}}, is also available.
+
2. Install {{Pkg|retroarch-assets-xmb}} package to Show '''XMB menu assets''' , Properly.
  
 
== Usage ==
 
== Usage ==
  
'''RetroArch''' employs the use of separate ''emulator cores'' (or ''implementations'') available from both the [[AUR]] and the [http://github.com/libretro libretro] github.
+
RetroArch uses separate libraries, called "emulator cores" or "emulator implementations", available from both [https://www.archlinux.org/packages/?q=libretro Community] and the [https://github.com/libretro libretro GitHub repository].
 +
 
 +
Each libretro core package will install a library to {{ic|/usr/lib/libretro/}}. The syntax to choose one when executing ''retroarch'' is:
 +
 
 +
$ retroarch --libretro /usr/lib/libretro/libretro-''core''.so ''path/to/rom''
  
Each package from the [[AUR]] will install an emulator core to {{ic|/usr/lib/libretro/[system].so}}, thus to use
+
A default emulation core can be defined in the configuration, obviating the need to specify it on every run.
{{ic|retroarch}} with your preferred system simply launch it with the {{ic|-L}} parameter. ''E.g.''
 
  
retroarch -L /usr/lib/libretro/libretro-snes9x-next.so ~/path/to/game
+
{{hc|~/.config/retroarch/retroarch.cfg|2=
 +
libretro_path = "/usr/lib/libretro/libretro-''core''.so"
 +
}}
  
{{Tip|It is possible to run directly from {{ic|.zip}} files using the {{ic|retroarch-zip}} shell wrapper, however, keep in mind that this is not supported within the implementation.}}
+
== Configuration ==
  
This emulation core can also be defined in the {{ic|retroarch.cfg}}, thus obviating the need to specify it on the command line.
+
RetroArch provides a very well commented skeleton configuration file located at {{ic|/etc/retroarch.cfg}}.
  
{{hc|/etc/retroarch.cfg|2=
+
Copy the skeleton configuration file to your home directory
libretro_path = "/usr/lib/libretro/libretro-snes9x-next.so"}}
 
  
There are currently several emulation cores available including ''snes9x'', ''bsnes'', ''visual boy advance'' and ''final burn alpha''. See this [https://aur.archlinux.org/packages.php?K=libretro AUR search] for more.
+
$ cp /etc/retroarch.cfg ~/.config/retroarch/retroarch.cfg
  
== Configuration ==
+
It supports split configuration files using the {{ic|#include "foo.cfg"}} directive within the main configuration file, {{ic|retroarch.cfg}}. This can be overridden using the {{ic|--appendconfig ''/path/to/config''}} parameter and is beneficial if different keybinds, video configurations or audio settings are required for the various implementations.
RetroArch provides a skeleton configuration file located at {{ic|/etc/retroarch.cfg}} and is very well commented.  
+
 
 +
{{Tip|RetroArch is capable of loading [https://gitorious.org/bsnes/xml-shaders bsnes xml filters] and [https://github.com/libretro/common-shaders cg shaders] that can be defined in {{ic|retroarch.cfg}} as {{ic|video_bsnes_shader}} and {{ic|video_cg_shader}} respectively.}}
 +
{{Note|{{AUR|retroarch-git}} requires {{pkg|nvidia-cg-toolkit}} in order to use the ''cg shaders''.}}
 +
{{Warning|When using [[ALSA]] it is necessary for the {{ic|audio_out_rate}} to be equal to the system's default output rate, usually {{ic|48000}}.}}
 +
 
 +
== Online updater ==
 +
 
 +
Recent versions of RetroArch have introduced a built-in menu for updating core files and various assets from the [https://buildbot.libretro.com/ RetroArch Buildbot]. It can be accessed from the main menu at ''Online Updater''.
 +
 
 +
{{hc|1=Online Updater|2=
 +
Core Updater
 +
Update Core Info Files
 +
Update Assets
 +
Update Autoconfig Profiles
 +
Update Cheats
 +
Update Databases
 +
Update Overlays
 +
Update GLSL Shaders
 +
}}
 +
 
 +
These cores and assets are kept up to date and can be pulled from the updater at any time.
 +
 
 +
== Troubleshooting ==
 +
 
 +
=== No cores found ===
 +
 
 +
By default RetroArch will attempt to find cores in {{ic|/usr/lib/libretro/}}. Cores downloaded using the built-in Online Updater will fail to save unless retroarch is run as root (not recommended, as it may overwrite cores installed by [[pacman]]), since the user does not have permission to modify this directory. To use cores from the Online Updater, edit these lines:
 +
 
 +
{{hc|~/.config/retroarch/retroarch.cfg|2=
 +
libretro_directory = "~/.config/retroarch/cores"
 +
libretro_info_path = "~/.config/retroarch/cores/info"
 +
}}
 +
 
 +
=== No option to update or download cores in the menu ===
 +
 
 +
Open {{ic|~/.config/retroarch/retroarch.cfg}} or {{ic|/etc/retroarch.cfg}} and make sure that {{ic|menu_show_core_updater}} is set to {{ic|true}}. This should then allow you to update cores in the ''Online Updater'' menu and download cores in the ''Load Core'' menu.
 +
 
 +
=== Input devices do not operate ===
 +
 
 +
You may encounter problems if running on a CLI or a display server other than [[Xorg]] or if you use the [[udev]] input driver, because {{ic|/dev/input}} nodes are limited to root-only access. Try adding your user to the "input" [[group]] then logging in again.
 +
 
 +
Alternatively, manually add a rule in {{ic|/etc/udev/rules.d/99-evdev.rules}}, with {{ic|1=KERNEL=="event*", NAME="input/%k", MODE="666"}} as its contents. Reload [[udev rules]] by running:
 +
 
 +
# udevadm control --reload-rules
 +
 
 +
If rebooting the system or replugging the devices are not options, permissions may be forced using:
 +
 
 +
# chmod 666 /dev/input/event*
 +
 
 +
=== Poor video performance ===
 +
 
 +
If poor video performance is met, RetroArch may be run on a separate thread by setting {{ic|1=video_threaded = true}} in {{ic|~/.config/retroarch/retroarch.cfg}}.
 +
 
 +
This is, however, a solution that should be not be used if tweaking RetroArch's video resolution/refresh rate fixes the problem, as it makes perfect V-Sync impossible, and slightly increases latency.
  
It is capable of supporting split configuration files using the {{ic|#include "foo.cfg"}} directive within the main {{ic|retroarch.cfg}} file. Alternatively, extra configuration files can be appended on the command line which override the default settings in {{ic|retroarch.cfg}}. This can be achieved by using {{ic|--appendconfig /path/to/config}} and is beneficial if different keybinds, video configurations or audio settings are required for the various implementations.
+
== See also ==
  
{{Tip|{{ic|retroarch}} is capable of loading ''bsnes xml filters'' [https://gitorious.org/bsnes/xml-shaders] and ''cg shaders'' [https://github.com/libretro/common-shaders]. They can be defined in {{ic|retroarch.cfg}} as {{ic|video_bsnes_shader}} and {{ic|video_cg_shader}} respectively.
+
* [http://www.retroarch.com/ Official Website]
{{Note|{{aur|retroarch-git}} requires {{pkg|nvidia-cg-toolkit}} in order to use the ''cg shaders''.}}}}
+
* [https://github.com/libretro/RetroArch/wiki RetroArch wiki on GitHub]
{{Warning|When using the '''alsa''' driver make sure {{ic|audio_out_rate}} is ''equal'' to your system's default output rate. This is usually 48000.}}
+
* [https://github.com/libretro/libretro.github.com/wiki/Documentation-devs Documentation for developers]

Latest revision as of 11:39, 4 October 2017

Note: RetroArch is not affiliated with Arch Linux.

RetroArch is a modular, command-line driven, multi-system emulator that is designed to be fast, lightweight, and portable. Some of its features can be found on few other emulators, such as real-time rewinding and game-aware shading based on the libretro API.

Installation

1. Install the retroarch package or alternatively retroarch-gitAUR for the development version.

2. Install retroarch-assets-xmb package to Show XMB menu assets , Properly.

Usage

RetroArch uses separate libraries, called "emulator cores" or "emulator implementations", available from both Community and the libretro GitHub repository.

Each libretro core package will install a library to /usr/lib/libretro/. The syntax to choose one when executing retroarch is:

$ retroarch --libretro /usr/lib/libretro/libretro-core.so path/to/rom

A default emulation core can be defined in the configuration, obviating the need to specify it on every run.

~/.config/retroarch/retroarch.cfg
libretro_path = "/usr/lib/libretro/libretro-core.so"

Configuration

RetroArch provides a very well commented skeleton configuration file located at /etc/retroarch.cfg.

Copy the skeleton configuration file to your home directory

$ cp /etc/retroarch.cfg ~/.config/retroarch/retroarch.cfg

It supports split configuration files using the #include "foo.cfg" directive within the main configuration file, retroarch.cfg. This can be overridden using the --appendconfig /path/to/config parameter and is beneficial if different keybinds, video configurations or audio settings are required for the various implementations.

Tip: RetroArch is capable of loading bsnes xml filters and cg shaders that can be defined in retroarch.cfg as video_bsnes_shader and video_cg_shader respectively.
Note: retroarch-gitAUR requires nvidia-cg-toolkit in order to use the cg shaders.
Warning: When using ALSA it is necessary for the audio_out_rate to be equal to the system's default output rate, usually 48000.

Online updater

Recent versions of RetroArch have introduced a built-in menu for updating core files and various assets from the RetroArch Buildbot. It can be accessed from the main menu at Online Updater.

Online Updater
Core Updater
Update Core Info Files
Update Assets
Update Autoconfig Profiles
Update Cheats
Update Databases
Update Overlays
Update GLSL Shaders

These cores and assets are kept up to date and can be pulled from the updater at any time.

Troubleshooting

No cores found

By default RetroArch will attempt to find cores in /usr/lib/libretro/. Cores downloaded using the built-in Online Updater will fail to save unless retroarch is run as root (not recommended, as it may overwrite cores installed by pacman), since the user does not have permission to modify this directory. To use cores from the Online Updater, edit these lines:

~/.config/retroarch/retroarch.cfg
libretro_directory = "~/.config/retroarch/cores"
libretro_info_path = "~/.config/retroarch/cores/info"

No option to update or download cores in the menu

Open ~/.config/retroarch/retroarch.cfg or /etc/retroarch.cfg and make sure that menu_show_core_updater is set to true. This should then allow you to update cores in the Online Updater menu and download cores in the Load Core menu.

Input devices do not operate

You may encounter problems if running on a CLI or a display server other than Xorg or if you use the udev input driver, because /dev/input nodes are limited to root-only access. Try adding your user to the "input" group then logging in again.

Alternatively, manually add a rule in /etc/udev/rules.d/99-evdev.rules, with KERNEL=="event*", NAME="input/%k", MODE="666" as its contents. Reload udev rules by running:

# udevadm control --reload-rules

If rebooting the system or replugging the devices are not options, permissions may be forced using:

# chmod 666 /dev/input/event*

Poor video performance

If poor video performance is met, RetroArch may be run on a separate thread by setting video_threaded = true in ~/.config/retroarch/retroarch.cfg.

This is, however, a solution that should be not be used if tweaking RetroArch's video resolution/refresh rate fixes the problem, as it makes perfect V-Sync impossible, and slightly increases latency.

See also