Editing Using RetroArch
Jump to navigation
Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | + | Work in progress guide. Please expand upon it. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ==Basic Usage (RGUI)== | |
− | For more convenient ROM selection, setup your browser directory under ''' | + | After downloading [[RetroArch]],[[File:Rgui.png|thumb|205px|RGUI, RetroArch's interface]] start up retroarch.exe. |
+ | |||
+ | To launch a game, select the emulator core you'd like to use under '''Core''', and select a ROM under''' Load Game'''. | ||
+ | |||
+ | For more convenient ROM selection, setup your browser directory under '''Path Options'''. | ||
==Installing RetroArch on Linux== | ==Installing RetroArch on Linux== | ||
− | === | + | ===Debian based=== |
First, add the PPA for <code>ppa:libretro/stable</code> or <code>ppa:libretro/testing</code> for stable builds and dev builds respectively (instructions [[Emulation on Ubuntu|here]]), then type the following into a terminal: | First, add the PPA for <code>ppa:libretro/stable</code> or <code>ppa:libretro/testing</code> for stable builds and dev builds respectively (instructions [[Emulation on Ubuntu|here]]), then type the following into a terminal: | ||
sudo apt-get update | sudo apt-get update | ||
Line 38: | Line 36: | ||
libretro_directory = "/usr/lib/libretro" | libretro_directory = "/usr/lib/libretro" | ||
− | You can also set the libretro path using the | + | You can also set the libretro path using the RGUI. In Retroarch, go to Settings -> Path Options -> Core Directory and navigate to the appropriate folder. If you set everything up correctly, you should see the cores when you select the ''Core'' option in the RGUI. |
===Installation on Gentoo=== | ===Installation on Gentoo=== | ||
Line 56: | Line 54: | ||
Set USE flags that you want, it is not required to enable every single one (you only need at least one audio and video output device; defaults are suitable enough). It is recommended to add udev for joystick support and netplay for netplay support. | Set USE flags that you want, it is not required to enable every single one (you only need at least one audio and video output device; defaults are suitable enough). It is recommended to add udev for joystick support and netplay for netplay support. | ||
+ | |||
Build and install RetroArch from the git repository | Build and install RetroArch from the git repository | ||
Line 74: | Line 73: | ||
The cores will be installed under /usr/lib/libretro/ | The cores will be installed under /usr/lib/libretro/ | ||
+ | |||
===Other Distros=== | ===Other Distros=== | ||
Line 92: | Line 92: | ||
==General Setup/Usage== | ==General Setup/Usage== | ||
− | === | + | ===RGUI Controls=== |
Default keys for the keyboard are: x (confirm), z (back) and the arrow keys. If you're using an XInput (xbox 360) controller, your controller should already be set-up. | Default keys for the keyboard are: x (confirm), z (back) and the arrow keys. If you're using an XInput (xbox 360) controller, your controller should already be set-up. | ||
Line 98: | Line 98: | ||
If you are going to play in a system that needs a BIOS (e.g. PS1), place the [[Emulator_Files#Multi-System|BIOS files]] in RetroArch's 'system' directory. | If you are going to play in a system that needs a BIOS (e.g. PS1), place the [[Emulator_Files#Multi-System|BIOS files]] in RetroArch's 'system' directory. | ||
+ | |||
+ | Mednafen is very picky about which BIOS to use. The ones that you might need are: | ||
+ | |||
+ | <ul> | ||
+ | <li class="de2"><code>scph5500.bin</code></li> | ||
+ | <li class="de2"><code>scph5501.bin</code></li> | ||
+ | <li class="de2"><code>scph5502.bin</code></li> | ||
+ | </ul> | ||
===Disc images=== | ===Disc images=== | ||
− | + | [[Mednafen]] requires you to load games through CUE sheets. Ensure that the CUE sheet is properly set up in order for the game to run. See the [[Cue sheet (.cue)]] for more. | |
===Mupen64Plus=== | ===Mupen64Plus=== | ||
− | + | The following file need to be placed in the System folder to use the Rice plugin: | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | *<code>RiceVideoLinux.ini</code> | |
− | + | Download it [http://www.mediafire.com/?au459fbk8r86jat here]. | |
− | + | <code>Glide64mk2.ini</code> is no longer needed in the current version of mupen64plus-libretro, as it is baked into the Glide64 now. | |
===Super Game Boy=== | ===Super Game Boy=== | ||
− | Using recent builds of the bsnes libretro cores, you can load Game Boy games in a fully emulated Super Game Boy. As this feature is not currently | + | Using recent builds of the bsnes libretro cores, you can load Game Boy games in a fully emulated Super Game Boy. As this feature is not currently implemented in RGUI, you must do so using a command line. |
− | + | First you need to set the core to a bsnes core (any of the 3 profiles will work) using RGUI or editing your config file, then start RetroArch with the following command to load GB games in SGB mode using bsnes: | |
− | |||
− | |||
− | + | retroarch "path to Super Game Boy SNES cartridge ROM" --subsystem sgb "path to Game Boy cartridge ROM" | |
− | + | Put the actual paths to the ROMs in double quotes. For example: | |
− | + | retroarch "C:/Games/SNES/Super Game Boy 2 (Japan).sfc" --subsystem sgb "C:/Games/Game Boy/Kirby's Dream Land (USA, Europe).gb" | |
− | + | You will need <code>sgb.boot.rom</code> in your System folder, this can be found on the [[Emulator Files]] page in the SNES file pack if you do not have it. | |
− | |||
− | |||
− | |||
− | You can also use the RetroArch-Phoenix launcher to load them, but YMMV since it is not being updated anymore | + | You can also use the RetroArch-Phoenix launcher to launcher to load them, but YMMV since it is not being updated anymore. |
− | |||
− | |||
===Dual Analog Controllers=== | ===Dual Analog Controllers=== | ||
Line 154: | Line 139: | ||
===Transfer PS1 Memory Card Files=== | ===Transfer PS1 Memory Card Files=== | ||
− | + | Mednafen creates memory card files for each individual game, in contrast to PCSX-R/ePSXe where all game saves are stored into 2 memory card files. To transfer memory card files from PCSX-R/ePSXe to RetroArch: | |
*Start game in RetroArch. | *Start game in RetroArch. | ||
Line 170: | Line 155: | ||
Some games like Metal Gear Solid require the disk tray to be opened before changing disks. To do this, change 'Disk Index' to 'No Disk' first. | Some games like Metal Gear Solid require the disk tray to be opened before changing disks. To do this, change 'Disk Index' to 'No Disk' first. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===Audio DSP Plugins=== | ===Audio DSP Plugins=== | ||
− | RetroArch supports loading audio DSP plugins to add effects such as reverb to the audio output. This has been in RetroArch for a long time, but was recently reworked to be easier to use and more accessible from | + | RetroArch supports loading audio DSP plugins to add effects such as reverb to the audio output. This has been in RetroArch for a long time, but was recently reworked to be easier to use and more accessible from RGUI, and are available in the main RetroArch repository now. Now you can load DSP filters using RGUI under Settings\Audio Options\DSP Filter, where you can load a DSP preset with .dsp extension, which is a text file similar to a shader preset that lets you chain DSP filters and specify their options. The DSP filters themselves are dynamic libraries that are loaded according to the .dsp file. Each DSP filter has a standalone preset that documents the default options, and there are some example presets that combine more than one filter. |
Note that some of these filters may reduce volume a bit, so you may want to boost RA's volume level to compensate. If you want to remove the filter, press Start when the DSP Filter option is highlighted. | Note that some of these filters may reduce volume a bit, so you may want to boost RA's volume level to compensate. If you want to remove the filter, press Start when the DSP Filter option is highlighted. | ||
Line 193: | Line 164: | ||
===SoftFilters=== | ===SoftFilters=== | ||
− | Classic emulator filters like SuperEagle or Blargg's NTSC have been available as | + | Classic emulator filters like SuperEagle or Blargg's NTSC have been available as bSNES filter plugins in the past, which is no longer supported in bSNES/higan but was still available in RetroArch. However, this filter format was recently replaced with the SoftFilter spec, which has been upgraded to support more platforms, multi-threading and SIMD usage. The filters are dynamic libraries which are loaded in RGUI under Settings\Video\Soft Filter, which will apply the filter before any shaders are applied. |
The filters are found [https://github.com/libretro/RetroArch/tree/master/gfx/video_filters here], which can be built for your platform with the makefile. These files should be included in nightly builds from the buildbot. | The filters are found [https://github.com/libretro/RetroArch/tree/master/gfx/video_filters here], which can be built for your platform with the makefile. These files should be included in nightly builds from the buildbot. | ||
− | Note that these filters are WIP and may not work with all cores as they need to have codepaths for the pixel format the core uses (either 32bpp XRGB8888 or 16bpp RGB565). Blargg's NTSC is currently limited to 16bpp cores for example ( | + | Note that these filters are WIP and may not work with all cores as they need to have codepaths for the pixel format the core uses (either 32bpp XRGB8888 or 16bpp RGB565). Blargg's NTSC is currently limited to 16bpp cores for example (bSNES is 32bpp so it won't work, but SNES9x is 16bpp so it works there). Cores that use Libretro GL for 3D like Mupen64plus can not use these filters. |
===Outputting log to a file=== | ===Outputting log to a file=== | ||
Line 204: | Line 175: | ||
retroarch --menu --verbose >> log.txt 2>&1 | retroarch --menu --verbose >> log.txt 2>&1 | ||
− | It will load up to | + | It will load up to RGUI as if you just double clicked the executable, but it will redirect standard output and standard error to a text file called <code>log.txt</code> in your RetroArch folder. The command above will append to the log and not overwrite existing information, if you want it to overwrite, change ">>" into ">". This can be put into a .bat file to easily run it when desired. |
==Building from source== | ==Building from source== | ||
Line 223: | Line 194: | ||
==Hotkeys== | ==Hotkeys== | ||
− | *F1 - Open | + | *F1 - Open RGUI |
*F2 - Save state | *F2 - Save state | ||
− | |||
*F4 - Load state | *F4 - Load state | ||
*F6 - Input save state slot decrease | *F6 - Input save state slot decrease | ||
Line 240: | Line 210: | ||
===Menu runs too fast=== | ===Menu runs too fast=== | ||
− | If Vsync is disabled for any reason, the menu may run unthrottled and scroll too fast to be usable. To fix this, enable | + | If Vsync is disabled for any reason, the menu may run unthrottled and scroll too fast to be usable. To fix this, enable Limit Maximum Run Speed, and set Maximum Run Speed to 1.0x. In the config file, these options are called <code>fastforward_ratio_throttle_enable</code> and <code>fastforward_ratio</code>. However, this will make fast forward not work, you will need to increase the Maximum Run Speed higher than 1.0x for that to work. |
− | |||
− | |||
− | + | This tends to happen when you first start up RetroArch and not after loading a game. This is because without a core loaded, the menu is only throttled by Vsync when Limit Maximum Run Speed is disabled, while cores are able to throttle on audio as well. Fastforward disables both Vsync and audio sync, which allows the core to run unthrottled unless it is specifically limited by the Maximum Run Speed setting. | |
===Command prompt running and closing itself upon running retroarch.exe=== | ===Command prompt running and closing itself upon running retroarch.exe=== | ||
Line 251: | Line 219: | ||
If it happens on all cores with a clean config file, then try changing <code>video_driver</code> setting from <code>gl</code> to <code>d3d</code> or <code>sdl2</code>, if you have a particularly ancient GPU. | If it happens on all cores with a clean config file, then try changing <code>video_driver</code> setting from <code>gl</code> to <code>d3d</code> or <code>sdl2</code>, if you have a particularly ancient GPU. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==External links== | ==External links== | ||
Line 280: | Line 226: | ||
*[https://github.com/libretro/RetroArch/wiki/RGUI RGUI Documentation] | *[https://github.com/libretro/RetroArch/wiki/RGUI RGUI Documentation] | ||
*[http://www.libretro.com/index.php/wiki/configuration/general-configuration/ General Configuration] | *[http://www.libretro.com/index.php/wiki/configuration/general-configuration/ General Configuration] | ||
+ | *[http://www.libretro.com/index.php/wiki/configuration/windows-guide/ Advanced Configuration] | ||
[[Category:FAQs]] | [[Category:FAQs]] | ||
− |