Difference between revisions of "Installation Guide"

Revision as of 18:10, 14 May 2020

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 bit of 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 (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.)

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 RetroArch.7z into "C:\EmuVR\Retroarch".

When extracting Retroarch.7z, be sure to not create another Retroarch folder inside the target.

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 disk. Extract RetroArch.7z to a clean "C:\EmuVR\Retroarch" folder.

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

!!! ATTENTION: DO NOT ADD MORE THAN 400 GAMES, OR EMUVR MIGHT FREEZE OR CRASH !!!

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

Now, copy your games (or 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.

To know what file format each core supports, look up the docs for that libretro core. Example: https://docs.libretro.com/library/beetle_psx/#extensions

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 in all cases.

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

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).
PlayStation games won't work in ISO format. They need to be in other formats, such as CUE + BIN or PBP.

Adding DOSBox Games

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

Games 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 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.

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 you 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 is not what it should be, read below to know how to manually add folders or change the systems.

Adding Folders Manually

After trying the Autofill, if you still need to add some 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.

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 that system will be automatically selected for you (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 need to be downloaded using that button.

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 or support UGC (custom models). Currently, there are models for PS1, N64 and SNES systems, and a VCR. More to come later.

BIOS Files

Some emulator cores will need BIOS files to work.

For example: PS1, 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.

After you get your BIOS files, you just need to extract them into "C:\EmuVR\Retroarch\system".

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

This page will teach all you need to know about BIOS, and which cores needs which files: https://docs.libretro.com/library/bios/

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

Core Options (Advanced)

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

Available options are 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 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.

Cases where 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.
• You'll always need to manually enable Light Gun games.

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.

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.

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 400 GAMES, OR EMUVR MIGHT FREEZE OR CRASH !!!

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 creating or renaming a system folder, 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.

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!

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.