search

Eusth / VRGIN.Template

Generic project to work with VRGIN.
MIT License
60 stars 65 forks source link

readme

VRGIN.Template

Generic template project that illustrates how to use VRGIN.

Using the source code

Building

  1. Checkout the project (recursively, because VRGIN is included as a submodule) 
    git clone --recursive https://github.com/Eusth/VRGIN.Template.git
cd VRGIN.Template
  2. (Optional) Launch Bootstrapper.exe and set your project name. This will automatically rename the project file to your liking.
  3. Open the solution (*.sln) file
  4. (Optional) Open Deploy.props and set <GameDirectory> to the directory where your game resides. This will automatically deploy your mod when you build
  5. Start the build in the Release configuration

This will generate all you need inside bin\Release. (This should be the same output as on the releases page). If you've set the game directory, your game will also have been updated.

Running

  1. Patch your game by dragging its executable on IPA.exe (only has to be done once)
  2. By default, the game will now boot into VR mode when SteamVR is running (make sure Desktop Game Theatre is disabled)

Using the release

Installation

  1. Download release from the release page
  2. Extract contents into a Unity folder
  3. Drag the game executable onto IPA.exe

Running

Start the game while SteamVR is running or use the --vr flag.