Difference between revisions of "Installation Guide"

From EmuVR Wiki
Jump to: navigation, search
Line 1: Line 1:
−
== Installation ==
+
This guide will teach you how to download, install, and add your own games to EmuVR.
  
−
# Download the following archives;
+
__TOC__
−
#* EmuVR base archive (latest version: 1.0.2)
+
−
#** (Latest download is always available in the official EmuVR Discord server, in #download)
+
−
#* Approved Retroarch version (RetroArch.7z)
+
−
#** http://buildbot.libretro.com/stable/1.7.5/windows/x86_64/RetroArch.7z
+
−
# Create a folder for EmuVR (for this example, we'll use C:\EmuVR, but it can exist anywhere).
+
−
# Extract the contents of '''EmuVR 1.0.2.7z''' to '''C:\EmuVR'''
+
−
#* Note: If you end up with C:\EmuVR\EmuVR, move everything out of there into C:\EmuVR. It should look like this;
+
−
#*:  [[File:Install_emuvr_folder.png]]
+
−
# Extract '''RetroArch.7z''' to '''C:\EmuVR\Retroarch'''
+
−
# Copy your games to '''C:\EmuVR\Games'''. In this example, we can use the following SNES homebrew game, "Hilda" from https://gamejolt.com/games/hilda/162284 (you can use any ROM(s) you like).
+
−
## For this example, create '''C:\EmuVR\Games\SNES'''
+
−
##* The name of the folder doesn't matter, as long as it's descriptive.
+
−
##* Each console will have it's own folder, e.g. "N64", "Genesis", etc.
+
−
##* You can delete the default "SystemX/Y/Z" folders, they're just examples.
+
−
## Move the .zip (or .sfc, etc) into '''C:\EmuVR\Games\SNES'''
+
−
##* Note: EmuVR loads labels textures for all of your games into your video card memory (VRAM) at launch. As such, adding a large number of games could freeze EmuVR when loading them at start. There is no known upper limit, but keep in mind that migrating a full list of ROMSs from a previous library is not recommended (e.g., thousands of games). You should start at around 200~300 games, then go up.
+
−
# Add games to EmuVR
+
−
## Run '''C:\EmuVR\Game Scanner\Game Scanner.exe'''
+
−
## Click "Attempt Autofill"
+
−
## Make sure '''C:\EmuVR\Games\SNES''' has been added, it's Media is "SNES", and a related Core is selected.
+
−
##* In this case, I'm going to manually select "Nintendo - SNES / Famicom (Snes9x)" because I've tested it and it works well.
+
−
## Click "Save Changes".
+
−
## Click "Download Missing Cores" (wait for the download to complete and click "Ok")
+
−
## Click "Scan Games for EmuVR" (Wait for the scan to complete, then click "Ok")
+
−
# Run '''C:\EmuVR\EmuVR.exe''' and make sure your consoles and carts are available in your inventory menu
+
−
#* If you would like to run in Desktop Mode, execute "Force Desktop.exe" in the same place as EmuVR.exe.
+
  
−
== Adding games after the initial install ==
+
=== Quick Steps ===
 +
This may look complicated, but in the end you'll just be doing these basic steps below:
 +
# Download and extract
 +
# Copy your games
 +
# Scan games and download cores
 +
# Play
  
−
# Run '''C:\EmuVR\Game Scanner\Game Scanner.exe'''
+
Please do read everything below. '''Every single information here is important to make EmuVR work correctly.'''
−
# Click "Attempt Autofill"
+
−
# Make sure the folders you've added to '''C:\EmuVR\Games''' have been added. If not, click on "Add Folder..." and add it.
+
−
#* Make sure to select the correct '''Media''' type and '''Core'''
+
−
# Click "Save Changes".
+
−
# Click "Download Missing Cores" (wait for the download to complete and click "Ok")
+
−
# Click "Scan Games for EmuVR" (Wait for the scan to complete, then click "Ok")
+
  
−
== Customizing game labels, posters, etc ==
+
=== Downloads ===
  
−
Please see [[Customization]].
+
In order to setup and start using EmuVR, you will need to download two files:
  
−
== Troubleshooting ==
+
* 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]
  
−
Please see [[Troubleshooting]].
+
=== Extracting ===
 +
 
 +
* Extract the contents of '''EmuVR <version>.7z''' somewhere convenient. <b>For this example, we'll use "C:\EmuVR"</b>.
 +
* Extract '''RetroArch.7z''' into "<b>C:\EmuVR\Retroarch</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.'''
 +
 
 +
EmuVR's Retroarch installation will not mess your any other Retroarch installation in your disk. They're all portable and unaware of each other.
 +
 
 +
=== Copying Your Games ===
 +
 
 +
'''!!! ATTENTION: DO NOT ADD MORE THAN 300 GAMES, OR EMUVR WILL FREEZE OR CRASH ON STARTUP !!!'''
 +
 
 +
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:
 +
* C:\EmuVR\Games\SNES
 +
* C:\EmuVR\Games\PS1
 +
* C:\EmuVR\Games\Sega Genesis
 +
Now, copy your games into your respective new folders.
 +
 
 +
You can delete the default "SystemX/Y/Z" folders, they're just 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'''.
 +
 
 +
If they're in '''RAR''' files, you also '''must''' extract them.
 +
 
 +
 
 +
''Recap: '''ZIP ''' and  '''7Z ''' work, unless it's a disc file.  '''RAR''' never works.''
 +
 
 +
 
 +
PS: PlayStation games won't work in '''ISO''' format. They need to be in other formats, such as '''CUE + BIN''' or '''PBP'''.
 +
 
 +
=== Games Scanner ===
 +
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.
 +
 
 +
==== 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.
 +
 
 +
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.
 +
 
 +
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.
 +
 
 +
==== 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.
 +
 
 +
You'll need to select a Media type and an emulator Core for that system.
 +
 
 +
==== Media and Core ====
 +
Each system folder need to be assigned a Media type and an emulator Core. Most systems have multiple cores 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.
 +
 
 +
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.
 +
 
 +
==== Scanning Your Games ====
 +
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.
 +
 
 +
'''!!! ATTENTION: DO NOT ADD MORE THAN 300 GAMES, OR EMUVR WILL FREEZE OR CRASH ON STARTUP !!!'''
 +
 
 +
 
 +
==== When To Scan Again ====
 +
* 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:
 +
** Adding a new system folder
 +
** Renaming a system folder
 +
** Adding new games to a system folder
 +
** Renaming game files
 +
 
 +
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 ===
 +
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'''.
 +
 
 +
'''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 another clean folder.
 +
 
 +
=== 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|Customization Guide]].
 +
 
 +
=== Playing EmuVR ===
 +
You're now ready to learn [[How To Play]] and finally enjoy EmuVR!

Revision as of 01:44, 20 November 2018

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

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 information here is important to make EmuVR work correctly.

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

Extracting

  • Extract the contents of EmuVR <version>.7z somewhere convenient. For this example, we'll use "C:\EmuVR".
  • Extract RetroArch.7z into "C:\EmuVR\Retroarch".

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.

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

Copying Your Games

!!! ATTENTION: DO NOT ADD MORE THAN 300 GAMES, OR EMUVR WILL FREEZE OR CRASH ON STARTUP !!!

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\PS1
  • C:\EmuVR\Games\Sega Genesis

Now, copy your games into your respective new folders.

You can delete the default "SystemX/Y/Z" folders, they're just 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.

If they're in RAR files, you also must extract them.


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


PS: PlayStation games won't work in ISO format. They need to be in other formats, such as CUE + BIN or PBP.

Games Scanner

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

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

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.

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.

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.

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.

You'll need to select a Media type and an emulator Core for that system.

Media and Core

Each system folder need to be assigned a Media type and an emulator Core. Most systems have multiple cores 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.

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.

Scanning Your Games

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.

!!! ATTENTION: DO NOT ADD MORE THAN 300 GAMES, OR EMUVR WILL FREEZE OR CRASH ON STARTUP !!!


When To Scan Again

  • 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 custom labels
  • You do NEED to click "Scan Games" again when:
    • Adding a new system folder
    • Renaming a system folder
    • Adding new games to a system folder
    • Renaming game files

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

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.

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 another clean folder.

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!

Retrieved from "https://www.emuvr.net/w/index.php?title=Installation_Guide&oldid=119"