Difference between revisions of "Installation Guide"

From EmuVR Wiki
Jump to: navigation, search
m
m
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This guide will teach you how to download, install, and add your own games to EmuVR.
 
This guide will teach you how to download, install, and add your own games to EmuVR.
 +
 +
After this, the next pages will teach you how to ''play'' it, how to customize it and more.
 +
 +
'''''IMPORTANT:'' The [[#well done you clicked a link|orange underlined words]] are [[#well done you clicked a link|links]]. You'll need to [[#well done you clicked a link|click the links]] you see through the whole wiki to read more and fully understand the instructions.''' ''(Yes, we actually had to add this to the wiki)''
 +
  
 
__TOC__
 
__TOC__
Line 11: Line 16:
  
 
Please do read everything below. '''Every single bit of information here is important to make EmuVR work correctly.'''
 
Please do read everything below. '''Every single bit of information here is important to make EmuVR work correctly.'''
 +
 +
 +
<div style="font-size:140%;>If your games aren't loading, if anything doesn't work right, or if you have any issues even <u>after reading this page,</u> then please read the [[Troubleshooting#Troubleshooting|Troubleshooting]] section *carefully* before asking for help, as 99% of all questions are already answered in this wiki.</div>
 +
  
 
=== Downloads ===
 
=== Downloads ===
Line 17: Line 26:
  
 
* EmuVR itself '''(The latest version is always available on EmuVR's official Discord server, in the ''#download'' channel)'''
 
* EmuVR itself '''(The latest version is always available on EmuVR's official Discord server, in the ''#download'' channel)'''
* [http://buildbot.libretro.com/stable/1.7.5/windows/x86_64/RetroArch.7z RetroArch v1.7.5] (This is the official download link from Retroarch - Note that '''this specific version, 1.7.5''' is required to use EmuVR. '''Not''' 1.7.6, '''not''' 1.8.x, or any other version. ''Click the orange link to the left to download it.'')
+
* [https://download.emuvr.net/RetroArch.7z RetroArch v1.7.5] (Note that '''this specific version, 1.7.5''' is required to use EmuVR. '''Not''' 1.8, '''not''' 1.9, nor any other version. '''Click the orange link to the left to download it.''')
  
Hint: If you get errors, don't use Winrar to extract Retroarch. Use [https://www.7-zip.org/ 7-Zip].
+
Hint: If you get errors, '''don't use WinRAR''' to extract Retroarch. '''Use [https://www.7-zip.org/ 7-Zip]'''.
  
 
=== Extracting ===
 
=== Extracting ===
  
* Extract the contents of '''EmuVR <version>.7z''' somewhere convenient. <b>For this example, we'll use "C:\EmuVR"</b>.
+
* Extract the contents of '''EmuVR <version>.7z''' somewhere convenient. <b>For this example, we'll use "C:\EmuVR"</b>.<br>(Some systems might have denied file access issues if you extract into "C:\Program Files\", so '''avoid installing it there''')
* Extract '''RetroArch.7z''' into "<b>C:\EmuVR\Retroarch</b>".
+
* Extract the contents of '''RetroArch.7z''' into "<b>C:\EmuVR\Retroarch</b>".
  
  
When extracting '''Retroarch.7z''', be sure to not create another Retroarch folder inside the target.
+
When extracting '''Retroarch.7z''' make sure '''not''' to create another Retroarch folder inside the target, or you'll have two "Retroarch" folders inside each other.
  
Retroarch's exe file needs to end up like this: "<b>C:\EmuVR\Retroarch\retroarch.exe'''</b>"
+
Retroarch's exe file needs to end up like this: "<b>C:\EmuVR\<span style="color:#1f8ee0">Retroarch</span>\retroarch.exe'''</b>"
  
And '''NOT''' like this: "<b>C:\EmuVR\Retroarch\<i>Retroarch</i>\retroarch.exe</b>"
+
And '''NOT''' like this: "<b>C:\EmuVR\<span style="color:#e0481f">Retroarch\Retroarch</span>\retroarch.exe</b>"
  
  
Important: If this is your first EmuVR installation, '''do not copy from any previous Retroarch installation in your disk. Extract RetroArch.7z to a clean "C:\EmuVR\Retroarch" folder.'''
+
Important: If this is your first EmuVR installation, '''do not copy anything from any previous Retroarch installation in your computer. Extract RetroArch.7z to an ''empty'' "C:\EmuVR\Retroarch" folder.'''
 +
 
 +
EmuVR's Retroarch installation will not mess with any other Retroarch installation in your computer. They're all portable and unaware of each other.
 +
 
 +
Also, [[Troubleshooting#Don't download cores using Retroarch|do not download cores using Retroarch]], always use Game Scanner for that ''(keep reading to understand this)''.
  
EmuVR's Retroarch installation will not mess with any other Retroarch installation in your disk. They're all portable and unaware of each other.
 
  
 
=== Copying Your Games ===
 
=== Copying Your Games ===
  
'''!!! ATTENTION: DO NOT ADD MORE THAN 300 GAMES, OR EMUVR WILL FREEZE OR CRASH ON STARTUP !!!'''
+
'''EmuVR does not come with any games. You must provide your own.'''
 +
<br>'''DO NOT ASK HOW OR WHERE TO DOWNLOAD ROMS.'''
  
First, go to your "<b>C:\EmuVR\Games</b>" folder and create a new folder there for each console you want. You can name them as you like. Examples:
+
'''ATTENTION:''' Avoid adding more than '''1000''' games, as it can break Netplay or even crash EmuVR.
* C:\EmuVR\Games\SNES
+
* C:\EmuVR\Games\PS1
+
* C:\EmuVR\Games\Sega Genesis
+
* C:\EmuVR\Games\Videos
+
Now, copy your games (or [[Playing Videos and Music|videos, music]]) into your respective new folders. They'll also work in subfolders inside those folders.
+
  
You can delete the default "SystemX/Y/Z" folders, they're just examples.
+
'''Curate your games, pick your favorites.'''
  
 +
First, go to your "<b>C:\EmuVR\Games</b>" folder and create a new folder there for each console you want.<br>You can name them '''as you like. Examples:'''
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>SNES</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>Super Nintendo</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>PS1</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>PSX</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>PlayStation</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>PlayStation (Light Gun)</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>N64</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>Sega Genesis</b></span></code>
 +
* <code>C:\EmuVR\Games\<span style="color:#1f8ee0"><b>Videos</b></span></code>
 +
''(Notice there are multiple examples above for how you could name a same console in any way you like.)''
  
To know what file format each core supports, look up the docs for that libretro core. Example: https://libretro.readthedocs.io/en/latest/library/beetle_psx/#bios
+
Now, '''copy your games''' (or [[Playing Videos and Music|videos, music]]) into the respective folders you've just created. Your games will also work in ''subfolders'' inside these folders, if you need more organization.
  
 +
(You can delete the default "ExampleSystemFolderX/Y/Z" folders, they're just empty examples.)
  
If they're in '''ZIP''' or '''7Z''' files, you do '''not''' need to extract them. They'll work compressed or extracted the same way.
 
  
The exception is '''disc games'''. If they're '''ISO''', '''CUE + BIN''' files, or other ripped disc formats, you '''always need to extract them'''.
+
==== Supported Files ====
 +
'''To know which file formats each core supports,''' click the [[#Core_Options_.28Advanced.29|Core Options <span style="font-size:120%;>&#x2630;</span>]] button to the right in [[#Game_Scanner|Game Scanner]], then click '''[List Supported Files]'''. (You'll learn about Game Scanner and how to use it in the following sections, just keep reading this page and it will make sense soon.)
  
If they're in '''RAR''' files, you also '''must''' extract them.
+
To be able to actually see all your '''file extensions''' (for example: <code>.iso</code> <code>.bin</code> <code>.txt</code>) usually you'll need to [https://cdn.discordapp.com/attachments/497454201266372628/703331317085110413/unknown.png enable this setting].
  
 +
* If your games are in '''ZIP''' or '''7z''' files, you do '''not''' need to extract them if you don't want to ''(unless they're disc-based games).'' They'll work compressed or extracted the same way, with one exception:
  
''Recap: '''ZIP ''' and  '''7Z ''' work, unless it's a disc file.  '''RAR''' never works.''
+
* '''Disc games always need to be extracted.''' If they're '''ISO''', '''CUE + BIN''' files, or other ripped disc formats, you '''need to extract them,''' do not keep them as .zip or .7z files. Examples: PS1, PS2, GameCube, Dreamcast.
  
 +
* '''RAR''' files are not supported at all, so they always must be '''extracted.'''
 +
 +
''Recap: '''ZIP ''' and  '''7z ''' work, unless it's a '''disc''' game.  '''RAR''' never works.''
 +
 +
 +
'''Notes:'''
 +
* '''If''' you're extracting from '''ZIP''' or '''7z''' files, don't forget to remove them after extracting, or you'll have duplicates (and unplayable ones at that, if they're disc games).<br>
 +
* '''PS1''' games won't work in '''ISO''' format. They need to be in other formats, such as '''CUE + BIN''' or '''PBP'''.
 +
 +
 +
'''If your PLAYSTATION games are not working, please read this special section CAREFULLY and you'll fix it: [[Troubleshooting#PlayStation_Games|PlayStation Games Troubleshooting]]'''
 +
 +
'''For PLAYSTATION 2 issues, we have this section: [[Troubleshooting#PlayStation_2_Games|PlayStation 2 Games Troubleshooting]]'''
  
Notes: If you're extracting '''ZIP''' or '''7Z''' files, don't forget to remove them after extracting, or you'll have duplicates (and unplayable ones if they're disc games).<br>
 
PlayStation games won't work in '''ISO''' format. They need to be in other formats, such as '''CUE + BIN''' or '''PBP'''.
 
  
 
==== Adding DOSBox Games ====
 
==== Adding DOSBox Games ====
DOSBox Games are a special case for the Game Scanner. Read [[Adding DOSBox Games]] to learn how to properly add them.
+
DOSBox Games are a special case for Game Scanner. Read [[Adding DOSBox Games]] to learn how to properly add them.
 +
 
  
=== Games Scanner ===
+
=== Game Scanner ===
For EmuVR to recognize your games, you need to scan them.
+
For EmuVR to recognize your games, you need to '''scan''' them.
  
First, run the Game Scanner, located at "<b>C:\EmuVR\Game Scanner\Game Scanner.exe</b>". This will also automatically patch Retroarch to work with EmuVR.
+
First, run Game Scanner, located at "<b>C:\EmuVR\Game Scanner\Game Scanner.exe</b>". Doing this will also automatically patch Retroarch to work with EmuVR.
  
If this is your first install, or you're updating EmuVR, click the '''Update Core List''' button. If you ever see this button with an asterisk, you'll need to click it. This updates your core information, needed scan your games and to download your selected cores.
+
If this is your first install, or if you're updating EmuVR, click the '''[Update Core Data *]''' button. If you ever see this button with an '''asterisk''', you'll need to click it. This will update your core information, needed to scan your games and to download your selected cores.
  
 
==== Autofill ====
 
==== Autofill ====
Click the '''Attempt Autofill''' button. Autofill will search for known names in your folders, and will try to assign the most probable console and emulator core for each one.
+
Next, click the '''[Attempt Autofill]''' button. Autofill will search for known names in your folders, and will try to assign the most probable console and emulator core for each one.
  
If you named you folders with common names like "PS1", "PSX", "PlayStation", "Sony PlayStation", "PlayStation 1", or "SNES", "Super Nintendo", "Super Famicom", they should be automatically detected.
+
If you name your folders with known names like "PS1", "PSX", "PlayStation", "Sony PlayStation", "PlayStation 1", or "SNES", "Super Nintendo", "Super Famicom", they should be automatically detected.
  
Sometimes a folder name will not be recognized. If you notice a folder was not added from Autofill, read below to know how to manually add folders.
+
Sometimes a folder name might not be recognized. If you notice a folder was not added by Autofill, or if the detected system was not assigned correctly, read below to know how to manually add folders or assign their systems.
  
 
==== Adding Folders Manually ====
 
==== Adding Folders Manually ====
After trying the Autofill, if you still need to add some folders manually, click the '''Add folder...''' button, and choose your folder.
+
After trying [[#Autofill|Autofill]], if you still need to add any folders manually, click the '''[Add folder...]''' button down below and choose your folder.
  
You'll need to select a Media type and an emulator Core for that system.
+
You might need to select a Media type and an emulator Core for that system, if it was not correctly detected at this point.
  
 
==== Media and Core ====
 
==== Media and Core ====
Each system folder needs to be assigned a Media type and an emulator Core.
+
Each system folder needs to be assigned a '''Media''' type and an emulator '''Core'''.
  
 
In simple terms, a Core is an emulator that runs inside Retroarch, which in turn runs inside EmuVR. Most systems (consoles) have several alternative Cores (emulators) to choose from.
 
In simple terms, a Core is an emulator that runs inside Retroarch, which in turn runs inside EmuVR. Most systems (consoles) have several alternative Cores (emulators) to choose from.
  
When you use the Autofill or manually select a Media type, the (arguably) most popular/faster core for that system will be automatically selected for you. You can change it to any other core you like. If you have any problems with it, please also try other cores.
+
When you use Autofill or manually select a Media type, the (arguably) most popular/faster core for this system will be automatically selected for you (it's always the first item in the dropdown). You can change it to any other core you like. If you have any problems with them, please try other core alternatives too.
  
After you choose your options, click '''Save Changes'''.
+
After you choose your options, click '''[Save Changes]'''.
  
Next, click '''Download Missing Cores''', and it will download and extract each chosen emulator. If your selected core has a little down arrow icon before the name, it means it still need to be downloaded like that.
+
Next, click '''[Download Missing Cores]''', and it will download and extract each chosen emulator. If your selected core has a little ''down arrow icon'' &#x2193; before its name, it means it still needs to be downloaded using this button.
 +
 
 +
(If you want to update an already downloaded core to its latest version later, you can do so by clicking the '''[Update Core]''' on its [[#Core_Options_.28Advanced.29|Core Options]] window. Notice this is '''not''' the [Update Core ''Data''] button.)
 +
 
 +
'''Important:''' [[Troubleshooting#Don't download cores using Retroarch|never download cores using Retroarch]], always use Game Scanner.''
 +
 
 +
'''Note:''' For now, you'll see placeholder 3D models for every console that isn't modeled yet, represented by the fantastic ''Knock-Off Generic EVR-9000'' video game console. This allows you to play your games for every supported system before we get to model them all or support UGC (custom models). Currently, there are models for PS1, N64, SNES (USA, PAL and Japan), NES, GameCube and PS2 systems, and a VCR. More to come later.
  
Note: For now, you'll see placeholder 3D models for consoles that aren't modeled yet, represented by the fantastic ''Knock-Off Generic EVR-9000'' video game console. This allows you to play your games for every supported system, before we get to model them all. Currently, there are models for PS1, N64 and SNES systems, and a VCR. More to come later.
 
  
 
==== BIOS Files ====
 
==== BIOS Files ====
Some emulator cores will need BIOS files to work.
+
Some emulator cores will need some extra files called '''BIOS''' to work.
  
For example: PS1, Dreamcast, Sega Saturn, Sega CD, Sega 32X.
+
For example: [[Troubleshooting#6._BIOS|PS1]], [[Troubleshooting#5._BIOS|PS2]], Dreamcast, Sega Saturn, Sega CD, Sega 32X.
  
You'll need to find those files by yourself, just like your games. Just try Googling something like "ps1 bios" to learn more. '''Do not ask for BIOS files in the Discord server.'''
+
You'll need to find these files by yourself, just like your games. Just try googling something like "ps1 bios" or "retroarch bios" to learn more. '''Do not ask for BIOS files in the Discord server.'''
  
After you get your BIOS files, you just need to extract them into "<b>C:\EmuVR\Retroarch\system</b>".
+
After you get your BIOS files, you just need to extract them into "<b>C:\EmuVR\Retroarch\system\</b>" (with a few exceptions).
  
'''They need to be named correctly.''' Check this example for PS1 BIOS [https://libretro.readthedocs.io/en/latest/library/beetle_psx/#bios correct file names].
+
'''They need to be named correctly.''' Check this example for PS1 BIOS [https://docs.libretro.com/library/beetle_psx/#bios correct file names].
  
This page will teach all you need to know about BIOS, and '''which cores needs which files''': https://libretro.readthedocs.io/en/latest/library/bios/
+
The following page will teach everything you need to know about your BIOS and '''which cores needs which files''': https://docs.libretro.com/library/bios/
 +
 
 +
If you're having issues with '''PS1 BIOS''', go to [[Troubleshooting#6._BIOS|this section]] for detailed troubleshooting.
 +
 
 +
If you need help with '''PS2 BIOS''', go to [[Troubleshooting#5._BIOS|this section]] (it goes into a different folder).
 +
 
 +
Note: some cores can work without BIOS, but might still need them for some specific games to work correctly, like a few Gamecube and Dreamcast games.
  
  
 
==== Core Options (Advanced) ====
 
==== Core Options (Advanced) ====
By clicking the little wrench button to the right of the Core dropdown, you'll see a window where you can change some options for that specific core in that specific folder.
+
By clicking the <span style="font-size:120%;>&#x2630;</span> buttons to the right of each Core dropdown in Game Scanner, you'll see a new window where you can change some options for that specific core and folder.
  
For now, the only available options to toggle are for [[Keyboard and Mouse Input For Games|Keyboard, Mouse]] and [[Light Guns|Light Gun]] input modes.
+
There are available options for [[Light Guns|Light Gun]], [[Keyboard_and_Mouse_Input_For_Games#Keyboard_Input|Keyboard]] and [[Keyboard_and_Mouse_Input_For_Games#Mouse_Input|Mouse]] input modes.
  
In the Game Scanner some cores already have default values for those options. This means if you choose the DOSBox core, for example, mouse and keyboard will be enabled by default for you. If you need to override the assigned default value for a folder, just click the button and change your options at will.
+
In Game Scanner some cores already have default values for these options. This means that if you choose the DOSBox core, for example, mouse and keyboard will already be enabled by default for you. If you need to override the assigned default value for a folder, just click the <span style="font-size:120%;>&#x2630;</span> button to see this window and change your options at will.
  
Cases where you would need to change the options yourself:
+
Examples for when you would need to change the options yourself:
* Dreamcast games usually don't need a keyboard, but you need to enable it to play The Typing of the Dead.
+
* Dreamcast games usually don't need a [[Keyboard_and_Mouse_Input_For_Games#Keyboard_Input|keyboard]], but you'll need to enable it to play The Typing of the Dead.
* SNES games usually don't need a mouse, but you need to enable it to play Mario Paint.
+
* SNES games usually don't need a [[Keyboard_and_Mouse_Input_For_Games#Mouse_Input|mouse]], but you'll need to enable it to play Mario Paint.
* You'll always need to manually enable [[Light Guns|Light Gun]] games.
+
* Usually you'll need to enable [[Light Guns|Light Gun]] mode for games that need it manually.
  
Changing a core option will affect all games in that folder, so you might want to separate your special games into another folder, e.g.: an "SNES" folder with default options, and an "SNES (Mouse)" folder with mouse input enabled for all games inside this folder. Your games from both folders will seamlessly show up together in the same "SNES" category in the inventory menu, and will work accordingly (with or without mouse support enabled) when inserted into any SNES console ingame. Another example: a "PS1" folder and a "PS1 (Light Gun)" folder.
+
Changing a core option will affect all games under that folder, so you might want to '''separate your special games into another folder,''' e.g.: a '''"PS1"''' folder with default options, and a '''"PS1 (Light Gun)"''' folder with light gun input enabled for all games inside this folder. Your games from both folders will seamlessly show up together in the same "PlayStation" category in your inventory menu, and when inserted into any PlayStation console they'll work accordingly (with or without light gun support enabled). Another example: an "SNES" folder and a "SNES (Mouse)" folder.
  
Please read [[Keyboard and Mouse Input For Games]] to learn how to make it work with your games, and don't forget about [[Light Guns]].
+
* When adding '''new''' folders ([[#Adding_Folders_Manually|manually]] or through [[#Autofill|Autofill]]), Game Scanner will '''attempt''' to detect and automatically set input modes from '''folder names''' like the following examples: "PS1 GunCon", "PSX (Light Guns)", "Arcade Lightgun", "Arcade (Guns)", "NES Zapper", "SNES (Mouse)", "Dreamcast (Keyboard)". These aren't exact names, but just examples of possibilities. Make sure to '''still check''' if the setting was actually detected and enabled for you, don't rely on this.
 +
 
 +
Read the [[Light Guns]] and [[Keyboard and Mouse Input For Games]] pages to learn how to make them work with your games.
 +
 
 +
In this window you can also click '''[List Supported Files]''' to know which file formats the core supports, and '''[Update Core]''' to redownload the latest version of your core.
  
  
Line 137: Line 185:
 
This is the last step.
 
This is the last step.
  
Click '''Scan Games for EmuVR'''. A small window will show the scanning progress, and then the detected games count when it's finished.
+
Click '''[Scan Games for EmuVR]'''. A little window will display your scanning progress.
  
'''!!! ATTENTION: DO NOT ADD MORE THAN 300 GAMES, OR EMUVR WILL FREEZE OR CRASH ON STARTUP !!!'''
+
This might take several minutes depending on your games.
  
 +
After it's done, it will show how many games were detected.
  
==== When To Scan Again ====
+
'''ATTENTION:''' Avoid adding more than '''1000''' games, as it can break Netplay or even crash EmuVR.
* You do '''NOT''' need to click "Scan Games" again when:
+
** Changing Media type
+
** Changing Core
+
** Removing a system folder
+
** Deleting games
+
** Adding, removing or changing [[Customization#Labels|custom labels]]
+
  
* You do '''NEED''' to click "Scan Games" again when:
+
'''Curate your games, pick your favorites.'''
** Adding a new system folder
+
 
** Renaming a system folder
+
 
** Adding new games to a system folder
+
==== When do you need to Scan again? ====
** Renaming game files
+
* You '''need''' to click [Scan Games] again after:
 +
** Adding a new system folder.
 +
** Renaming a system folder.
 +
** Adding new games to a system folder.
 +
** Renaming game files.
 +
 
 +
* You do '''NOT''' need to click [Scan Games] again when just:
 +
** Changing Media types. ''(If they use the same file formats as the old one.)''
 +
** Changing Cores. ''(If they use the same file formats as the old one.)''
 +
** Removing a system folder.
 +
** Deleting games.
 +
** Adding, removing or changing [[Customization#Labels|custom labels]].
 +
 
 +
If you're renaming a system folder or creating a new one, you'll need to add them before scanning. Try [[#Autofill|Autofill]] again before adding them manually.
  
If you're adding or renaming a system folder, you'll need to add them before scanning. Try the Autofill before adding them manually.
 
  
 
=== Updating EmuVR ===
 
=== Updating EmuVR ===
When a new EmuVR update is released on the Discord server, you can just extract it over your previous installation, and everything should work with no need to do all that setup again, '''unless otherwise stated on the update notes'''.
+
When a new EmuVR update is released on our Discord server, you can simply extract it over your previous installation, and everything should work with no need to do all that setup again, '''unless otherwise stated on the update notes'''.
 +
 
 +
Game Scanner will let you know if there is a newer version available there.
  
 
'''Always read the notes on the new updates for further instructions.'''
 
'''Always read the notes on the new updates for further instructions.'''
Line 165: Line 222:
 
'''ALWAYS MAKE BACKUPS!'''
 
'''ALWAYS MAKE BACKUPS!'''
  
If something doesn't work after an update, try a clean installation with the latest version on another clean folder.
+
If something doesn't work after an update, try a clean installation with the latest version on a new clean folder.
 +
 
 +
== Next Steps ==
  
 
=== Customizing EmuVR ===
 
=== Customizing EmuVR ===
Line 173: Line 232:
 
You're now ready to learn [[How To Play]] and finally enjoy EmuVR!
 
You're now ready to learn [[How To Play]] and finally enjoy EmuVR!
  
=== EmuVR Settings ===
+
=== Netplay ===
Learn how to change your [[How To Play#Settings_Menu|Settings]], such as enabling Screen Space Reflections, Ambient Occlusion, adjusting your [[How To Play#Time|time of day]] or [[Controls#snap_turn|snap turn]] values.
+
Invite your friends to your room and play together with [[Netplay]]!
  
 
=== Save and Load Your Bedroom State ===
 
=== Save and Load Your Bedroom State ===
 
Learn more at the [[Room_Saving|Room Saving]] page.
 
Learn more at the [[Room_Saving|Room Saving]] page.
 +
 +
=== Settings Menu ===
 +
Learn how and why to change your [[Settings]].
 +
 +
There you'll be able to change the time of day, seasons, many graphics settings to balance quality and performance, many control options for comfort and ease of use, light gun settings, and many more.
  
 
=== Troubleshooting ===
 
=== Troubleshooting ===
 
If you're having any issues, crashes, or games aren't working, please check out the [[Troubleshooting]] page for known solutions.
 
If you're having any issues, crashes, or games aren't working, please check out the [[Troubleshooting]] page for known solutions.

Revision as of 18:50, 12 May 2022

This guide will teach you how to download, install, and add your own games to EmuVR.

After this, the next pages will teach you how to play it, how to customize it and more.

IMPORTANT: The orange underlined words are links. You'll need to click the links you see through the whole wiki to read more and fully understand the instructions. (Yes, we actually had to add this to the wiki)


Quick Steps

This may look complicated, but in the end you'll just be doing these basic steps below:

  1. Download and extract
  2. Copy your games
  3. Scan games and download cores
  4. Play

Please do read everything below. Every single bit of information here is important to make EmuVR work correctly.


If your games aren't loading, if anything doesn't work right, or if you have any issues even after reading this page, then please read the Troubleshooting section *carefully* before asking for help, as 99% of all questions are already answered in this wiki.


Downloads

In order to setup and start using EmuVR, you will need to download two files:

  • EmuVR itself (The latest version is always available on EmuVR's official Discord server, in the #download channel)
  • RetroArch v1.7.5 (Note that this specific version, 1.7.5 is required to use EmuVR. Not 1.8, not 1.9, nor any other version. Click the orange link to the left to download it.)

Hint: If you get errors, don't use WinRAR to extract Retroarch. Use 7-Zip.

Extracting

  • Extract the contents of EmuVR <version>.7z somewhere convenient. For this example, we'll use "C:\EmuVR".
    (Some systems might have denied file access issues if you extract into "C:\Program Files\", so avoid installing it there)
  • Extract the contents of RetroArch.7z into "C:\EmuVR\Retroarch".


When extracting Retroarch.7z make sure not to create another Retroarch folder inside the target, or you'll have two "Retroarch" folders inside each other.

Retroarch's exe file needs to end up like this: "C:\EmuVR\Retroarch\retroarch.exe"

And NOT like this: "C:\EmuVR\Retroarch\Retroarch\retroarch.exe"


Important: If this is your first EmuVR installation, do not copy anything from any previous Retroarch installation in your computer. Extract RetroArch.7z to an empty "C:\EmuVR\Retroarch" folder.

EmuVR's Retroarch installation will not mess with any other Retroarch installation in your computer. They're all portable and unaware of each other.

Also, do not download cores using Retroarch, always use Game Scanner for that (keep reading to understand this).


Copying Your Games

EmuVR does not come with any games. You must provide your own.
DO NOT ASK HOW OR WHERE TO DOWNLOAD ROMS.

ATTENTION: Avoid adding more than 1000 games, as it can break Netplay or even crash EmuVR.

Curate your games, pick your favorites.

First, go to your "C:\EmuVR\Games" folder and create a new folder there for each console you want.
You can name them as you like. Examples:

  • C:\EmuVR\Games\SNES
  • C:\EmuVR\Games\Super Nintendo
  • C:\EmuVR\Games\PS1
  • C:\EmuVR\Games\PSX
  • C:\EmuVR\Games\PlayStation
  • C:\EmuVR\Games\PlayStation (Light Gun)
  • C:\EmuVR\Games\N64
  • C:\EmuVR\Games\Sega Genesis
  • C:\EmuVR\Games\Videos

(Notice there are multiple examples above for how you could name a same console in any way you like.)

Now, copy your games (or videos, music) into the respective folders you've just created. Your games will also work in subfolders inside these folders, if you need more organization.

(You can delete the default "ExampleSystemFolderX/Y/Z" folders, they're just empty examples.)


Supported Files

To know which file formats each core supports, click the Core Options button to the right in Game Scanner, then click [List Supported Files]. (You'll learn about Game Scanner and how to use it in the following sections, just keep reading this page and it will make sense soon.)

To be able to actually see all your file extensions (for example: .iso .bin .txt) usually you'll need to enable this setting.

  • If your games are in ZIP or 7z files, you do not need to extract them if you don't want to (unless they're disc-based games). They'll work compressed or extracted the same way, with one exception:
  • Disc games always need to be extracted. If they're ISO, CUE + BIN files, or other ripped disc formats, you need to extract them, do not keep them as .zip or .7z files. Examples: PS1, PS2, GameCube, Dreamcast.
  • RAR files are not supported at all, so they always must be extracted.

Recap: ZIP and 7z work, unless it's a disc game. RAR never works.


Notes:

  • If you're extracting from ZIP or 7z files, don't forget to remove them after extracting, or you'll have duplicates (and unplayable ones at that, if they're disc games).
  • PS1 games won't work in ISO format. They need to be in other formats, such as CUE + BIN or PBP.


If your PLAYSTATION games are not working, please read this special section CAREFULLY and you'll fix it: PlayStation Games Troubleshooting

For PLAYSTATION 2 issues, we have this section: PlayStation 2 Games Troubleshooting


Adding DOSBox Games

DOSBox Games are a special case for Game Scanner. Read Adding DOSBox Games to learn how to properly add them.


Game Scanner

For EmuVR to recognize your games, you need to scan them.

First, run Game Scanner, located at "C:\EmuVR\Game Scanner\Game Scanner.exe". Doing this will also automatically patch Retroarch to work with EmuVR.

If this is your first install, or if you're updating EmuVR, click the [Update Core Data *] button. If you ever see this button with an asterisk, you'll need to click it. This will update your core information, needed to scan your games and to download your selected cores.

Autofill

Next, click the [Attempt Autofill] button. Autofill will search for known names in your folders, and will try to assign the most probable console and emulator core for each one.

If you name your folders with known names like "PS1", "PSX", "PlayStation", "Sony PlayStation", "PlayStation 1", or "SNES", "Super Nintendo", "Super Famicom", they should be automatically detected.

Sometimes a folder name might not be recognized. If you notice a folder was not added by Autofill, or if the detected system was not assigned correctly, read below to know how to manually add folders or assign their systems.

Adding Folders Manually

After trying Autofill, if you still need to add any folders manually, click the [Add folder...] button down below and choose your folder.

You might need to select a Media type and an emulator Core for that system, if it was not correctly detected at this point.

Media and Core

Each system folder needs to be assigned a Media type and an emulator Core.

In simple terms, a Core is an emulator that runs inside Retroarch, which in turn runs inside EmuVR. Most systems (consoles) have several alternative Cores (emulators) to choose from.

When you use Autofill or manually select a Media type, the (arguably) most popular/faster core for this system will be automatically selected for you (it's always the first item in the dropdown). You can change it to any other core you like. If you have any problems with them, please try other core alternatives too.

After you choose your options, click [Save Changes].

Next, click [Download Missing Cores], and it will download and extract each chosen emulator. If your selected core has a little down arrow icon ↓ before its name, it means it still needs to be downloaded using this button.

(If you want to update an already downloaded core to its latest version later, you can do so by clicking the [Update Core] on its Core Options window. Notice this is not the [Update Core Data] button.)

Important: never download cores using Retroarch, always use Game Scanner.

Note: For now, you'll see placeholder 3D models for every console that isn't modeled yet, represented by the fantastic Knock-Off Generic EVR-9000 video game console. This allows you to play your games for every supported system before we get to model them all or support UGC (custom models). Currently, there are models for PS1, N64, SNES (USA, PAL and Japan), NES, GameCube and PS2 systems, and a VCR. More to come later.


BIOS Files

Some emulator cores will need some extra files called BIOS to work.

For example: PS1, PS2, Dreamcast, Sega Saturn, Sega CD, Sega 32X.

You'll need to find these files by yourself, just like your games. Just try googling something like "ps1 bios" or "retroarch bios" to learn more. Do not ask for BIOS files in the Discord server.

After you get your BIOS files, you just need to extract them into "C:\EmuVR\Retroarch\system\" (with a few exceptions).

They need to be named correctly. Check this example for PS1 BIOS correct file names.

The following page will teach everything you need to know about your BIOS and which cores needs which files: https://docs.libretro.com/library/bios/

If you're having issues with PS1 BIOS, go to this section for detailed troubleshooting.

If you need help with PS2 BIOS, go to this section (it goes into a different folder).

Note: some cores can work without BIOS, but might still need them for some specific games to work correctly, like a few Gamecube and Dreamcast games.


Core Options (Advanced)

By clicking the buttons to the right of each Core dropdown in Game Scanner, you'll see a new window where you can change some options for that specific core and folder.

There are available options for Light Gun, Keyboard and Mouse input modes.

In Game Scanner some cores already have default values for these options. This means that if you choose the DOSBox core, for example, mouse and keyboard will already be enabled by default for you. If you need to override the assigned default value for a folder, just click the button to see this window and change your options at will.

Examples for when you would need to change the options yourself:

  • Dreamcast games usually don't need a keyboard, but you'll need to enable it to play The Typing of the Dead.
  • SNES games usually don't need a mouse, but you'll need to enable it to play Mario Paint.
  • Usually you'll need to enable Light Gun mode for games that need it manually.

Changing a core option will affect all games under that folder, so you might want to separate your special games into another folder, e.g.: a "PS1" folder with default options, and a "PS1 (Light Gun)" folder with light gun input enabled for all games inside this folder. Your games from both folders will seamlessly show up together in the same "PlayStation" category in your inventory menu, and when inserted into any PlayStation console they'll work accordingly (with or without light gun support enabled). Another example: an "SNES" folder and a "SNES (Mouse)" folder.

  • When adding new folders (manually or through Autofill), Game Scanner will attempt to detect and automatically set input modes from folder names like the following examples: "PS1 GunCon", "PSX (Light Guns)", "Arcade Lightgun", "Arcade (Guns)", "NES Zapper", "SNES (Mouse)", "Dreamcast (Keyboard)". These aren't exact names, but just examples of possibilities. Make sure to still check if the setting was actually detected and enabled for you, don't rely on this.

Read the Light Guns and Keyboard and Mouse Input For Games pages to learn how to make them work with your games.

In this window you can also click [List Supported Files] to know which file formats the core supports, and [Update Core] to redownload the latest version of your core.


Scanning Your Games

This is the last step.

Click [Scan Games for EmuVR]. A little window will display your scanning progress.

This might take several minutes depending on your games.

After it's done, it will show how many games were detected.

ATTENTION: Avoid adding more than 1000 games, as it can break Netplay or even crash EmuVR.

Curate your games, pick your favorites.


When do you need to Scan again?

  • You need to click [Scan Games] again after:
    • Adding a new system folder.
    • Renaming a system folder.
    • Adding new games to a system folder.
    • Renaming game files.
  • You do NOT need to click [Scan Games] again when just:
    • Changing Media types. (If they use the same file formats as the old one.)
    • Changing Cores. (If they use the same file formats as the old one.)
    • Removing a system folder.
    • Deleting games.
    • Adding, removing or changing custom labels.

If you're renaming a system folder or creating a new one, you'll need to add them before scanning. Try Autofill again before adding them manually.


Updating EmuVR

When a new EmuVR update is released on our Discord server, you can simply extract it over your previous installation, and everything should work with no need to do all that setup again, unless otherwise stated on the update notes.

Game Scanner will let you know if there is a newer version available there.

Always read the notes on the new updates for further instructions.

ALWAYS MAKE BACKUPS!

If something doesn't work after an update, try a clean installation with the latest version on a new clean folder.

Next Steps

Customizing EmuVR

If you want to customize your bedroom with your own custom wallpapers, wall posters, bed sheets and game labels, check out the Customization Guide.

Playing EmuVR

You're now ready to learn How To Play and finally enjoy EmuVR!

Netplay

Invite your friends to your room and play together with Netplay!

Save and Load Your Bedroom State

Learn more at the Room Saving page.

Settings Menu

Learn how and why to change your Settings.

There you'll be able to change the time of day, seasons, many graphics settings to balance quality and performance, many control options for comfort and ease of use, light gun settings, and many more.

Troubleshooting

If you're having any issues, crashes, or games aren't working, please check out the Troubleshooting page for known solutions.