Changes

Work in progress guide==Basic Usage=={{Main|Dummies Guide: RetroArch}}After downloading [[RetroArch]],[[File:Rgui. Please expand upon itpng|thumb|300px|RGUI, RetroArch's original interface.]][[File:GLUI.png|thumb|300px|GLUI]][[File:XMB.jpeg|thumb|300px|XMB]][[File:Ozon.png|thumb|300px|Ozon]]start up retroarch.exe.

After downloading RetroArchFor more convenient ROM selection, run setup your browser directory under 'retroarch-phoenix.exe' and then go to 'RetroArch Settings> Update RetroA[[File:RAP_update.png|right]]rchDirectory''' to start downloading emulation cores.

[[File:RA_updater.png|thumb|==Installing RetroArch's Updater]] From there, click 'Check Version'. This checks if everything is up-to-date (you have to do this every time you use the updater). Double-click on a core to start downloading it. To launch a game, select the emulator core you'd like to use under 'libretro core path', and the appropriate ROM under 'Normal ROM path'. Make sure that 'retroarch.exe' is selected under 'RetroArch path', and click 'Start RetroArch'.[[File:RA_System_Directory.png|right|250px]] ==Linux=====Ubuntubased===First, add the PPA for hunter-kaller<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:

https://launchpad.net/~hunter-kaller/+archive/ppa===Any other distro===You will have to compile from source.  For Arch Linux there No cores are AUR packages that simplify this processadded by default, although it is not incredibly difficult otherwise.  The most important part is making sure you have all the dependencieswill need to emerge them.

# emerge <corename>-libretro Alternatively, you can set USE flags through <code>/etc/portage/package.use</code> libretro-meta package to choose what cores you wish; small all USE flags are on.  Syntax: games-emulation/libretro-meta <USEFLAG> <USEFLAG> ... bsnes has USE flags for its balanced, performance and accuracy profiles: games-emulation/bsnes-libretro profile_accuracy ... The cores will be installed under /usr/lib/libretro/ ===Other Distros===You will have to compile from source. For Arch Linux, there are AUR packages that simplify this process, although it is not incredibly difficult otherwise. The most important part is making sure you have all the dependencies. Dependencies: (refer to your distro's wiki or package manager for exact package names)'''===='''

*OpenGL headers (should be on most distros by default, if not try installing libgl/mesa developement development package===='''Optional:'''====

===Using RetroArch===RetroArch has a robust CLI for those who prefer the command line, there are also many pages which should have been installed by default for <code>retroarch</code>, <code>retroarch-joyconfig</code> and others. If you use the CLI be sure to configure your <code>retroarch.cfg</code> file before first use. This config is well commented so each option can be fully understood. Use <code>retroarch-joyconfig</code> command for simplified input setup. RetroArch can auto-detect inputs, which is a great feature to simplify playing with multiple/different controllers (refer to <code>man retroarch-joyconfig</code> for details). The <code>retroarch.cfg</code> file should be located in <code>/etc/retroarch.cfg</code>, your home folder or the directory where RetroArch was installed depending on your distro and compilation setup. ==General Setup/Usage=====Menu 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.===BIOS=== 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 'Building system' directory. ===Disc images=== RetroArch 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===This core has the option to choose between four graphics plugins and two RSP plugins: *Glide64 is the most recommended general use graphics plugin, as it is very compatible and reasonably accurate while still being decently fast. *Rice is much faster than Glide64, but it also suffers from a lot more issues. Only use if your device is too slow to handle Glide64. *gln64 has even more problems than Rice, while not being much faster. Not recommended. Will likely be replaced with GLideN64 in the near future. *Angrylion is ultra accurate, but is too slow for most people to use. Requires the CXD4 RSP to work. Resolution must be set to 640x480 or higher. *paraLLEl is a Vulkan renderer based on Angrylion. It is much faster than Angrylion, but is still incomplete and has more issues. Turning Synchronous RDP off results in a speed boost, but also breaks many things. *The HLE RSP plugin is very fast and will work fine for most games. *The CXD4 RSP is more accurate, and is needed for a few games to work correctly. A good general purpose setup is Glide64 with the CXD4 RSP. If it's a tad slow for your setup, switch to the HLE RSP. There is currently a bug in Glide64 that makes it so texture filtering is applied to everything, even when the Texture Filtering setting is set to Automatic. To make it display textures correctly, go to Core Options, toggle the setting to something other than Automatic, then set it back to Automatic. Glide64 will display textures correctly now, using the 3-point Bilinear method. If you get strange texture issues while using Glide64, such as textures partially disappearing or popping over polygons, mess around with the Polygon Offset Factor setting in Core Options until the issue goes away. Keep in mind some games may require a more aggressive setting than others, so experiment until you get a good balance that works for most games. The optimal setting tends to be GPU-specific. A few games, such as Star Fox 64, suffer from looking too dark due to a lack of gamma correction, which was done on real hardware. Short of implementing this in a plugin, a decent workaround is to use the image-adjustment.cg shader, and set the Target Gamma setting to 1.0. This will make such games look as they ought to. ===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 usable from the menu, you must do so using a command line. Start RetroArch with the following command to load GB games in SGB mode using bsnes:  retroarch "path to Super Game Boy SNES cartridge ROM" --libretro "path to bsnes libretro" --subsystem sgb "path to Game Boy cartridge ROM" Put the actual paths to the ROMs in double quotes if there are spaces in the paths. For example:  retroarch "C:\Games\SNES\Super Game Boy 2 (Japan).sfc" --libretro ".\cores\bsnes_balanced_libretro.dll" --subsystem sgb "C:\Games\Game Boy\Kirby's Dream Land (USA, Europe).gb" You will need <code>sgb.boot.rom</code> (CRC: ec8a83b9) in your System folder, this can be found on the [[Emulator Files]] page in the SNES file pack if you do not have it. If it is named "sgb_bios.bin" then rename it to "sgb.boot.rom". CRC of Super Game Boy SNES cartridge roms:[http://wiki.libretro.com/index.php?title=Bsnes#Super_Gameboy_Support]*Super Game Boy (Japan, USA) (Rev 1).sfc (CRC: 27a03c98)*Super Game Boy (World) (Rev 2).sfc (CRC: 8a4a174f)*Super Game Boy 2 (Japan).sfc (CRC: cb176e45) You can also use the RetroArch-Phoenix launcher to load them, but YMMV since it is not being updated anymore. Also, you can create a batch file like [http://pastebin.com/raw.php?i=yLm3HuDT this] to be able to drag and drop Game Boy ROMs onto it and launch them in SGB mode. Also, if you are using nightly build or Linux build it might just hang at black screen, even if you have all correct requirements. ===Dual Analog Controllers===PS1 games often used a set of default remappings if they didn't support it directly. Some games used both analogs as the D-pad, RetroArch doesn't support that though. Dual analogs only work in games that fully supported them, such as Ape Escape. To use dual analog for such games, start a game with mednafen/beetle_psx then go to Input Options, and change Device Type to '''DualShock'''. Also make sure you're using a [[RetroArch#PC_Versions|recent version]] of RetroArch and the mednafen/beetle_psx core. ===Transfer PS1 Memory Card Files===RetroArch 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. *Go to system folder. Copy the names of the .mcr files created for the game. *Delete them. *Rename the files you want to transfer with the names of the RetroArch memcard files. *Place the new ones in the system folder. ===Disk Changing===To changes disks in-game, go to Core Disk Options > Disk Image Append. 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. === FDS Disk Side Changing ===Just press the configured "Y" button. RetroArch won't display any OSD message to confirm the change. === Gambatte GB custom palettes ===It is possible to use the custom palettes created with the standalone Qt GUI version of [[Gambatte]]. First set the "gb_colorization" core option as "custom". Then create a "palettes" subdirectory in the system directory and copy the custom palettes there. The custom palettes will be searched in this order:* Your Rom Filename.pal* YOUR_ROM_INTERNAL_NAME.pal* default.palYou can download the set of standard SGB and GBC palettes [http://eadmaster.tk here] (look for "goomba2gambatte palette converter in python"). ===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 sourcethe menu, and are available in the main RetroArch repository now. Now you can load DSP filters in the menu under Settings>Audio>Audio DSP Plugin, 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. The filters and their presets can be found [https://github.com/libretro/RetroArch/tree/master/audio/audio_filters here], which the DSP filters can be built for your platform with the makefile. These files should be included in nightly builds from the buildbot. ===SoftFilters===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 the menu under Settings>Video>Video 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. 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===An easy way to get RetroArch to output logs to file for easy copy/pasting:  retroarch --menu --verbose >> log.txt 2>&1 It will load up to the menu 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=={{Main|Building RetroArch}}Libretro-super is a series of scripts used to ease the compilation and installation of each and every libretro emulation core and RetroArch itself. Thus this is the simplest route to a fully functional installation.  If you need or want to build each core individually then you can refer to the [https://github.com/libretro/libretro-super/blob/master/libretro-build-common.sh build-common.sh] script for direction.

===='''Building Phoenix-GUI (Optional for those that If you want point-click control)'''==== git clone git://github.com/Themaister/RetroArch-Phoenix.git cd RetroArch-Phoenix make # Will to build for GTK2 by default. If you're a KDE user or prefer Qtcores individually with the script instead of all of them at once, you can build for Qt with make -f Makefile.qt. sudo make installdo this

===Using RetroArch=Hotkeys==RetroArch has a robust CLI for those who prefer the command line, there are also man pages which should have been installed by default for retro*F1 - Open menu*F2 - Save state*F3 - Toggle frame rate display*F4 - Load state*F6 - Input save state slot decrease*F7 - Input save state slot increase *F8 - Take Screenshot*F9 -arch, retroarchMute Audio*F11 -joyconfig and others.  If you use the CLI be sure to configure your retroarch.cfg file before first use.  This config is well commented so each option can be fully understood.  Use retroarchHide Cursor*Space -joyconfig command for simplified input setup.  RetroArch can autoTurn off Frame Limiter*Esc -detect inputs, which is a great feature to simplify playing with multiple/different controllers (refer to "man retroarchExit game*f -joyconfig" for details).  The retroarch.cfg file should be located in /etc/retroarch.cfg, your home folder or the directory where retroarch was installed depending on your distro and compilation setup.Fullscreen

For those who perfer the Phoenix-Gui, there are a slew of options many of which are self explanatory.  To keep your RetroArch dir clean ==Problems and organized be sure to setup all of the different directories in the General tab.  Choose your perfered video and audio options.  Map your input options.  Make sure you tell Phoenix where to find retroarch if it doesn't configure automatically.  Choose your core and your rom.  And enjoySolutions==

==OSX=Menu runs too fast===????????

==Nintendo Wii==If you are on a SD (not HD) crt-tube tvVsync is disabled for any reason, then you will have the best display results (proper scanlines) 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 512x240 for ''Settings''→''Frame Throttle''. In the NESconfig file, these options are called <code>fastforward_ratio_throttle_enable</code> and 512x224 for <code>fastforward_ratio</code>. However, this will make fast forward not work, you will need to increase the SNES games, and 640x224 ''Maximum Run Speed'' higher than 1.0x for the MD/Genesis gamesthat to work.

==General set This tends to happen when you first start up=====Bios===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 ''Limit Maximum Run Speed'' setting.

If In newer RetroArch versions, you are going to play in a system that needs a BIOS, therecan just enable ''Throttle Menu Framerate'' under ''Settings''s a bit more setup required. Go to →'System > General' and change the Frame Throttle'System directory' to where ever you'd like and place specifically limit the BIOS files in theremenu to 60fps without impacting fastforward speed.

===Mednafen PSXCommand prompt running and closing itself upon running retroarch.exe===

Systems like the PSX require If this only happens on certain cores, then you should check to load games through CUE sheets. Ensure that see if you have all the required BIOS and other files available in the "system" folder or in the CUE sheet folder where the game is properly set up with a relative (not absolute) paths. See the [[Cue sheet (.cue)]] for morelocated.

Mednafen is very picky about which bios If it happens on all cores with a clean config file, then try changing <code>video_driver</code> setting from <code>gl</code> to use<code>d3d</code> or <code>sdl2</code>, if you have a particularly ancient GPU. Choosing certain bios works better than others. The ones to use are:

<ul><li class="de2">scph5500.bin</li><li class="de2">scph5501.bin</li><li class="de2">scph5502.bin</li></ul>Performance issues while using the GL driver===

===Super Game Boy===<p class="de2">Download these [http://www.mediafire.com/download.php?htga58k9rumhla9 SGB-capable bsnes cores]. Then [http://www.its.caltech.edu/~costis/sgb_hack/sgb_biosWindows users with Nvidia hardware may find that even while idle, RetroArch CPU usage is upwards of 12% or above while using the GL video driver.bin download If this]is the case, place it in go into the RetroArch folderNvidia Control Panel, and rename it as "sgb.boot.rom". Now on RetroArch, under File > Special ROMManage 3D Settings, select a Super Game Boy ROM (they will all basically work) and a Game Boy ROMcheck to see if the Threaded Optimizations option is set to Auto or On. FinallyIf so, under ROM type, select Super GameBoy, make sure you have add retroarch.exe to the bsnes core you downloaded selectedlist of programs, and playthen toggle it to Off. This should lower CPU usage drastically.</p>

===Dual analog controllersStuttering due to inaccurate refresh rate estimation===

PS1 games also often used a set RetroArch uses [[Vsync#Dynamic_Rate_Control|Dynamic Rate Control]] to synchronize both audio and video rates of the emulated game to those of default remappings if they didn't support it directlyyour system. Some games used both analogs as It relies on the dpadrefresh rate setting being accurate to your display. By default, RetroArch doesn't support that  thoughit is set to sync to 59. Dual analogs only work in games that fully supported them95Hz, such as Ape Escapewhich is the standard rate for NTSC video. To use dual analog for such gamesHowever, go to phoenixif your display runs at a different rate than what , controllersit can cause problems with synchronization, and change it from digital to dual analogso you should make sure that setting accurately reflects your display's actual refresh rate.  AlternativelyIf you don't know your display's exact refresh rate, open RGUI while in RetroArch and change the gamepad type in the Input optionsprovides a couple of ways of accurately estimating it.

1. Start game in RA.<br />2. Go The second method is to system folder. Copy name(s) of mem cards created for simply launch RetroArch from the game.command line in verbose logging mode, by doing <br /code>3. Delete them.retroarch --menu --verbose<br /code>4, and let it run for at least 4096 frames (about 1 minute at 60fps). Rename the mem card files When you want to transfer with close RetroArch, it will report the names of estimation results in the RA mem files.<br />5log. Place the new ones Again, running in the system folderexclusive fullscreen gives more accurate results.==Problems and solutions=====32 bit Windows===Example estimation output:

32 bit crashes RetroArch [INFO] :: Average audio buffer saturation: 49.84 %, standard deviation (percentage points): 11. It's a known problem99 %. Download an updated build RetroArch [INFO] ::Amount of time spent close to underrun: 0.70 %. Close to blocking: 1.04 %. RetroArch [INFO] :: Average monitor Hz: 60.006001 Hz. (27.568 % frame time deviation, based on 2048 last samples).

http:The refresh rate given there should be very accurate, and you can copy it into <code>video_refresh_rate<//forum.themaister.net/viewtopiccode> in your config file.php?pid=4945#p4945

NES[[File:Retroarch_2013-08-16_06-32===Stuttering on multi-24-62.png|thumb|320px|Example of faulty visuals that are exposed due to crop overscan not working. Note the blank blue area to the left and the green garbage on the right.]]monitor setups===

Crop overscan does not work properly in NES games. Even if you turn it Further testing is needed, but on multi-monitor setups on in Windows using the optionsGL driver, it has no effect, likely because appears RetroArch will only sync smoothly when outputting to the NES cores have not been configured Windows-designated primary monitor. Outputting to make use of it. While this isn't always a problemsecondary monitor will often result in occasional stutter, even in exclusive fullscreen and after accurate refresh rate estimation, some games such as Super Mario Bros[https://mollyrocket. 3 have blank areas or show garbage on the sides, quirks that would have been hidden on a real TV com/casey/blog_0032.html possibly due to overscana WGL oversight]. With the lack Short of overscan croppingswitching primary and secondary designations prior to opening RetroArch, these blemishes become fully visibleincreasing audio latency and/or using only video sync seems to help mitigate this to an extent. If Switching to either the D3D or Vulkan (if available) driver appears to eliminate this bothers you, there are shaders which crop a certain percentage of the edge pixels, such as [[CRT-Geom]]problem completely.

*[http://wiki.libretro.com/index.php?title=Main_Page Libretro Wiki]*[http://forum.themaister.net/viewtopic.php?id=467 Windows Compilation Guide]*[http://www.libretro.com/index.php/wiki/compilation/linux/ Linux Compilation Guide]*[https://github.com/Themaisterlibretro/RetroArch/wiki/CompilationRGUI RGUI Documentation]*[http://www.libretro.com/index.php/wiki/configuration/general-guide-%28Linux%29 Linux Comp Guideconfiguration/ General Configuration]