Editing Dummies Guide: 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 7: Line 7:
 
For Linux intructions read [[Using RetroArch#Installing RetroArch on Linux|Using RetroArch]].
 
For Linux intructions read [[Using RetroArch#Installing RetroArch on Linux|Using RetroArch]].
  
Open the .7z file with [http://www.7-zip.org/download.html 7zip] or WinRAR, or the archiver of your choice and extract the files to where you want to install RetroArch, or if on console/phone, install it using the standard method for that system.
+
Open the .7z file with [http://www.7-zip.org/download.html 7zip] or WinRAR, or other archiver of your choice and extract the files to where you want to install RetroArch, or if on console/phone, install it using the standard method for that system.
  
 
==Controls==
 
==Controls==
 
The menu is controlled mainly by the RetroPad, which is libretro's gamepad abstraction that uses SNES-style face buttons and PlayStation DualShock-style shoulder buttons and analog sticks. The default keybinds for the RetroPad are as follows:
 
The menu is controlled mainly by the RetroPad, which is libretro's gamepad abstraction that uses SNES-style face buttons and PlayStation DualShock-style shoulder buttons and analog sticks. The default keybinds for the RetroPad are as follows:
{| class="wikitable" style="float:right; text-align:center;"
+
{| class="wikitable" style="float:{{{align|right}}}"
!scope="col"|RetroPad
+
|style="text-align:center;"|RetroPad
!scope="col"|Keyboard
+
|style="text-align:center;"|Keyboard
!scope="col"|PlayStation
+
|style="text-align:center;"|PlayStation
!scope="col"|Xbox
+
|style="text-align:center;"|Xbox
 
|-
 
|-
|[[File:Retro_Dpad.png|48px]]
+
|style="text-align:center;"|[[File:Retro_Dpad.png|48px]]
|[[File:Key_Arrow-Up.png|48px]]<br>[[File:Key_Arrow-Left.png|48px]][[File:Key_Arrow-Down.png|48px]][[File:Key_Arrow-Right.png|48px]]
+
|style="text-align:center;"|[[File:Key_Arrow-Up.png|48px]]<br>[[File:Key_Arrow-Left.png|48px]][[File:Key_Arrow-Down.png|48px]][[File:Key_Arrow-Right.png|48px]]
|[[File:PS3_Dpad.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Dpad.png|48px]]
|[[File:360_D-pad.png|48px]]
+
|style="text-align:center;"|[[File:360_D-pad.png|48px]]
 
|-
 
|-
|[[File:Retro_A_Round.png|48px]]
+
|style="text-align:center;"|[[File:Retro_A_Round.png|48px]]
|[[File:Key_X.png|48px]]
+
|style="text-align:center;"|[[File:Key_X.png|48px]]
|[[File:PS3_Circle.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Circle.png|48px]]
|[[File:360_B.png|48px]]
+
|style="text-align:center;"|[[File:360_B.png|48px]]
 
|-
 
|-
|[[File:Retro_B_Round.png|48px]]
+
|style="text-align:center;"|[[File:Retro_B_Round.png|48px]]
|[[File:Key_Z.png|48px]]
+
|style="text-align:center;"|[[File:Key_Z.png|48px]]
|[[File:PS3_Cross.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Cross.png|48px]]
|[[File:360_A.png|48px]]
+
|style="text-align:center;"|[[File:360_A.png|48px]]
 
|-
 
|-
|[[File:Retro_X_Round.png|48px]]
+
|style="text-align:center;"|[[File:Retro_X_Round.png|48px]]
|[[File:Key_S.png|48px]]
+
|style="text-align:center;"|[[File:Key_S.png|48px]]
|[[File:PS3_Triangle.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Triangle.png|48px]]
|[[File:360_Y.png|48px]]
+
|style="text-align:center;"|[[File:360_Y.png|48px]]
 
|-
 
|-
|[[File:Retro_Y_Round.png|48px]]
+
|style="text-align:center;"|[[File:Retro_Y_Round.png|48px]]
|[[File:Key_A.png|48px]]
+
|style="text-align:center;"|[[File:Key_A.png|48px]]
|[[File:PS3_Sqaure.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Sqaure.png|48px]]
|[[File:360_X.png|48px]]
+
|style="text-align:center;"|[[File:360_X.png|48px]]
 
|-
 
|-
|[[File:Retro_L1.png|48px]]
+
|style="text-align:center;"|[[File:Retro_L1.png|48px]]
|[[File:Key_Q.png|48px]]
+
|style="text-align:center;"|[[File:Key_Q.png|48px]]
|[[File:PS3_L1.png|48px]]
+
|style="text-align:center;"|[[File:PS3_L1.png|48px]]
|[[File:360_Left-Bumper.png|48px]]
+
|style="text-align:center;"|[[File:360_Left-Bumper.png|48px]]
 
|-
 
|-
|[[File:Retro_R1.png|48px]]
+
|style="text-align:center;"|[[File:Retro_R1.png|48px]]
|[[File:Key_W.png|48px]]
+
|style="text-align:center;"|[[File:Key_W.png|48px]]
|[[File:PS3_R1.png|48px]]
+
|style="text-align:center;"|[[File:PS3_R1.png|48px]]
|[[File:360_Right-Bumper.png|48px]]
+
|style="text-align:center;"|[[File:360_Right-Bumper.png|48px]]
 
|-
 
|-
|[[File:Retro_Start.png|48px]]
+
|style="text-align:center;"|[[File:Retro_Start.png|48px]]
|[[File:Key_Enter.png|96px]]
+
|style="text-align:center;"|[[File:Key_Enter.png|96px]]
|[[File:PS3_Start.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Start.png|48px]]
|[[File:360_Start.png|48px]]
+
|style="text-align:center;"|[[File:360_Start.png|48px]]
 
|-
 
|-
|[[File:Retro_Select.png|48px]]
+
|style="text-align:center;"|[[File:Retro_Select.png|48px]]
|[[File:Key_Shift.png|96px]]
+
|style="text-align:center;"|[[File:Key_Shift.png|96px]]
|[[File:PS3_Select.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Select.png|48px]]
|[[File:360_Back.png|48px]]
+
|style="text-align:center;"|[[File:360_Back.png|48px]]
 
|-
 
|-
|[[File:Retro_Menu.png|48px]]
+
|style="text-align:center;"|[[File:Retro_Menu.png|48px]]
|[[File:Key_F1.png|48px]]
+
|style="text-align:center;"|[[File:Key_F1.png|48px]]
|[[File:PS3_Home.png|48px]]
+
|style="text-align:center;"|[[File:PS3_Home.png|48px]]
|[[File:360_Guide.png|48px]]
+
|style="text-align:center;"|[[File:360_Guide.png|48px]]
 
|}
 
|}
 
The R2, L2, R3, and L3 buttons, and left/right analog sticks are not mapped to the keyboard by default.
 
The R2, L2, R3, and L3 buttons, and left/right analog sticks are not mapped to the keyboard by default.
 
Gamepads can be mapped manually in the menu under ''Settings'' → ''Input'' → ''Input User 1 Binds'' → ''User 1 Bind All'', but automatic configuration is possible with [https://github.com/libretro/retroarch-joypad-autoconfig autoconfig profiles]. On Windows, all XInput and some DirectInput gamepads will be mapped automatically when detected to the RetroPad using the included autoconfig profiles.
 
Gamepads can be mapped manually in the menu under ''Settings'' → ''Input'' → ''Input User 1 Binds'' → ''User 1 Bind All'', but automatic configuration is possible with [https://github.com/libretro/retroarch-joypad-autoconfig autoconfig profiles]. On Windows, all XInput and some DirectInput gamepads will be mapped automatically when detected to the RetroPad using the included autoconfig profiles.
Touchscreen controls and light gun peripherals use the mouse.
 
  
 
In the menu, the following buttons are used:
 
In the menu, the following buttons are used:
Line 75: Line 74:
 
*A button = Confirm
 
*A button = Confirm
 
*B button = Cancel
 
*B button = Cancel
*X button = Search prompt
+
*Y button = Search prompt
*Y button = Delete input bind
 
 
*D-Pad = Navigation
 
*D-Pad = Navigation
 
*Start button = Reset option to default
 
*Start button = Reset option to default
 
*Select button = Show tooltip for a particular option
 
*Select button = Show tooltip for a particular option
*R and L buttons = Fast scrolling through files by jumping to the next letter.
+
*R and L buttons = Fast scrolling through files
  
By default, the keys used to navigate the menu are the following:
+
Additionally, in current nightly builds, the Enter, Backspace, and Spacebar keys are used for Confirm, Cancel, and Reset to Default respectively alongside the RetroPad binds.
 
 
*Enter = Confirm
 
*Backspace = Cancel
 
*Slash = Search prompt
 
*Delete = Delete input bind
 
*Arrow keys = Navigation
 
*Spacebar = Reset option to default
 
*Right Shift = Show tooltip for a particular option
 
*Page Up and Page Down = Fast scrolling through files by jumping to the next letter.
 
 
 
If "Unified Menu Controls" are enabled under ''Settings'' → ''Input'' , then the keybinds for the RetroPad are used instead for menu control; this was the original behavior before v1.4.1.
 
  
 
There are also various hotkeys that are mapped by default. The most important ones to remember are the following:
 
There are also various hotkeys that are mapped by default. The most important ones to remember are the following:
Line 115: Line 102:
  
 
==Downloading Cores==
 
==Downloading Cores==
RetroArch doesn't come with emulation cores, so you have to download them yourself. However, RetroArch does have a built-in updater. So to download up to date cores, scroll down to ''Online Updater'', and select ''Core Updater''. RetroArch will download a list of available cores to download, and you can individually download them. To see what core does what, see [[Libretro#Cores|this list.]]
+
RetroArch doesn't come with emulation cores, so you have to download them yourself. However, RetroArch does have a built in updater. So to download up to date cores, scroll down to ''Online Updater'', and select ''Core Updater''. RetroArch will download a list of available cores to download, and you can individually download them. To see what core does what, see [[Libretro#Cores|this list.]]
  
If for whatever reason RetroArch can't download cores, or won't display a list of available cores for download, you can get them from the buildbot [http://buildbot.libretro.com/nightly/ here.]
+
If for what ever reason RetroArch can't download cores, or wont display a list of available cores for download, you can get them from the buildbot [http://buildbot.libretro.com/nightly/ here.]
  
 
==Running a Game==
 
==Running a Game==
Line 125: Line 112:
  
 
==BIOS and System files==
 
==BIOS and System files==
Some emulation cores require special system files or BIOSes. These can be downloaded [[Emulator_Files#Multi-System|here.]] Extract the ''system'' folder in that archive to where you installed RetroArch (the folder where the retroarch program is. retroarch.exe on Windows).  
+
Some emulation cores require special system files, or BIOSes. These can be downloaded [[Emulator_Files#Multi-System|here.]] Extract the ''system'' folder in that archive to where you installed RetroArch (the folder where the retroarch program is. retroarch.exe on Windows).  
  
 
If it doesn't find the BIOS, go to ''Settings'' → ''Directory'' → ''System/BIOS Dir'' (or find <code>system_directory</code> in the config file) and make sure it points to the ''system'' folder.
 
If it doesn't find the BIOS, go to ''Settings'' → ''Directory'' → ''System/BIOS Dir'' (or find <code>system_directory</code> in the config file) and make sure it points to the ''system'' folder.
Line 133: Line 120:
  
 
==Shader Settings==
 
==Shader Settings==
Shaders usually either come in single .cg files or as a group of files controlled by a .cgp preset file. If you want to use a preset, like CRT-Royale or Super-XBR, simply select ''Load Shader Preset'' under ''Shader Options'' and select a .cgp file. If you want to select individual .cg files, increase the ''Shader Passes'' and select a .cg file through ''Shader #0'' (or #1, #2, etc.).
+
Shaders usually either come in single .cg files, or as a group of files controlled by a .cgp preset file. If you want to use a preset, like CRT-Royale or Super-XBR, simply select ''Load Shader Preset'' under ''Shader Options'' and select a .cgp file. If you want to select individual .cg files, increase the ''Shader Passes'' and select a .cg file through ''Shader #0'' (or #1, #2, etc.).
  
 
After selecting your shader setup, hit ''Apply Shader Changes''.
 
After selecting your shader setup, hit ''Apply Shader Changes''.
  
 
==Saves and Saving Settings==
 
==Saves and Saving Settings==
By default, RetroArch will save settings when it closes and will do so unless you put RetroArch in a directory that needs elevated privileges without running as administrator/root. ''Save New Config'' will save a ''new'', different, config that won't be loaded the next time RetroArch starts.
+
By default RetroArch will save settings when it closes, and will do so unless you put RetroArch in a directory that needs elevated privileges without running as administrator/root. ''Save New Config'' will save a ''new'', different, config that wont be loaded the next time RetroArch starts.
  
It's probably a good idea to enable ''SaveRAM Autosave Interval'' (under ''Settings'' → ''Saving'') so game saves will be written to your hard drive while RetroArch is running.
+
It's probably a good idea to enable ''SaveRAM Autosave Interval'' (under ''Settings'' → ''Saving'') so game saves will be written to your harddrive while RetroArch is running.
  
 
==Mednafen PSX==
 
==Mednafen PSX==
This particular core requires some specific care. You should have the correct BIOS (if not follow the [[Dummies_Guide:_RetroArch#BIOS_and_System_files|BIOS and System files]] section), you'll also need to make sure your game has a metadata file in the form of a .cue, .toc, .ccd, or .m3u file. The most common metadata people use is .cue, and if your PS1 game lacks a metafile, you can [[Cue_sheet_(.cue)|create one.]]<br>An easier way to get around metadata issues is to get your games from a better source. Redump PS1 games come in .bin/.cue format and work on mednafen without issue, but other sets that come in .bin/.cue/.mp3 format might need editing their cue file with Notepad with the correct filenames for them to work correctly.
+
This particular core requires some specific care. You should have the correct BIOS (if not follow the [[Dummies_Guide:_RetroArch#BIOS_and_System_files|BIOS and System files]] section), you'll also need to make sure your game has a metadata file in the form of a .cue, .toc, .ccd, or .m3u file. The most common metadata people use is .cue, and if your PS1 game lacks a metafile, you can [[Cue_sheet_(.cue)|create one.]]<br>An easier way to get around metadata issues, is to get your games from a better source. [[Need_Games%3F|Redump]] PS1 games come in .bin/.cue format and work on mednafen without issue.
  
==Customizing RetroArch==
+
==Ricing RetroArch==
There are 4 different menu drivers for RetroArch to choose from, RGUI, GLUI, Ozone and the default XMB. To switch between them go ''Settings'' → ''Driver Settings'' and switch ''Menu Driver''. You'll need to restart RetroArch for changes to take effect.
+
There's 3 different menu drivers for RetroArch to choose from, RGUI, GLUI and the default XMB. To switch between them go ''Settings'' → ''Driver Settings'' and switch ''Menu Driver''. You'll need to restart RetroArch for changes to take effect.
  
You can change your wallpaper, text color settings, text size (DPI Override, GLUI only), toggle mouse support, and whether to display the boxart in the ''Menu Settings''.
+
You can change your wallpaper, text color settings, text size (DPI Override, GLUI only), toggle mouse support, and whether to display boxart in the ''Menu Settings''.
  
You can change RetroArch's menu font, but it'll only work for the GLUI menu driver (only on 1.2.2, newer builds have changed GLUI significantly and it no longer uses the OSD font). To change it, under ''Onscreen Display Settings'' hit ''OSD Message Font'' and select a .ttf font file.<br>Should be noted that Onscreen Display Settings are for the yellow popup messages that RetroArch displays and GLUI happen to use fonts from it, all of the other settings here only change the popup message.
+
You can change RetroArch's menu font, but it'll only work for the GLUI menu driver (only on 1.2.2, newer builds have changed GLUI significantly and it no longer uses the OSD font). To change it, under ''Onscreen Display Settings'' hit ''OSD Message Font'' and select a .ttf font file.<br>Should be noted that Onscreen Display Settings are for the yellow popup messages that RetroArch displays, and GLUI happens to use fonts from it, all of the other settings here only change the popup message.
  
 
XMB loads its font from <code>$assets_directory/xmb/monochrome/font.ttf</code>, so you can replace the default font .ttf with a custom one. The same can be done with the default backgrounds and icons.
 
XMB loads its font from <code>$assets_directory/xmb/monochrome/font.ttf</code>, so you can replace the default font .ttf with a custom one. The same can be done with the default backgrounds and icons.
  
 
==Cheats==
 
==Cheats==
Not all cores support cheats, you can check the [http://wiki.libretro.com/index.php?title=Main_Page#Core_Software_Library Libretro wiki] for which cores do. By default RetroArch comes with a fairly large cheat database, so to make a new cheat file, you can find files in the ''cheats'' folder of RetroArch's install directory for reference. To enable cheats, load the game, toggle RetroArch's menu, load a cheat file in the ''Core Cheat Options'' and you'll get a list of cheats available which you can toggle. After setting your cheats, hit ''Apply Cheat Changes''. Some cheats may require you to ''Restart Content'' to take effect.
+
Not all cores support cheats, you can check the [http://wiki.libretro.com/index.php?title=Main_Page#Core_Software_Library Libretro wiki] for which cores do. By default RetroArch comes with a fairly large cheat database, so to make a new cheat file, you can find files in the ''cheats'' folder of RetroArch's install directory for reference.To enable cheats, load the game, toggle RetroArch's menu, load a cheat file in the ''Core Cheat Options'' and you'll get a list of cheats available which you can toggle. After setting your cheats, hit ''Apply Cheat Changes''. Some cheats may require you to ''Restart Content'' to take effect.
  
 
[[Category:FAQs]]
 
[[Category:FAQs]]
 
[[Category:RetroArch]]
 
[[Category:RetroArch]]

Please note that all contributions to Emulation General Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Emulation General Wiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)