Skip to content

Installation Guide

Jump to bottom
JonnyOThan edited this page Sep 29, 2022 · 94 revisions

This mod is still in very early development. The primary focus is on flying a ship in IVA and moving around in EVA. As such no other scenes are supported: map mode, VAB, any kind of UI interaction, etc. Keeping that in mind, you are welcome to try it out and report any issues or feedback.

Note the native dependencies for KerbalVR are only built for windows currently - if you are a linux or mac user please get in touch!

This is complicated, please follow the steps carefully. Start from a clean install of KSP 1.12.3.

Note that KerbalVR does not currently work with MAS (MoarDV Avionics Systems). If you have MAS installed, it will modify many of the prop setups that KerbalVR needs to function. Don't install it.

0. Upgrading from a previous install

If you already have KerbalVR and you're just upgrading to a newer version, you don't need to follow this entire guide. Read the release notes carefully for any new dependencies or files to install. Then delete your old KerbalVR folder and replace it with the new one.

1. Install Dependencies

Download the most recent release zip file: https://github.com/JonnyOThan/Kerbal-VR/releases. DO NOT install it yet.

A note on IVA selection

The pods from KSA IVA Upgrade are the primary development platform for VR. They will give you the richest VR experience since they were designed from the ground up with VR in mind. However, KSA does not include IVAs for all the stock parts. DE_IVAExtension has been the standard IVA pack for all stock pods for a long time now, but they do not include many props that you may want when playing in VR. You can install both of these if you also install Reviva which allows selecting different IVAs for the same set of parts. Note that with Reviva you must actively select the IVA to use, or else you will just get the stock default.

Automatic Installation

The zip file contains a .ckan file which you can use to get all the dependencies. (CKAN is a mod manager, you can get it here: https://github.com/KSP-CKAN/CKAN/releases). In CKAN, go to Settings -> Compatible Game Versions and check the boxes for KSP 1.8 and 1.12 (not all dependencies are officially supported on the latest version, but they do work). Then go to File -> Install from .ckan and select the KerbalVR-dependencies.ckan file. You will then be presented with some options about what to install. KSA IVA Upgrade is listed as a dependency, and DE_IVAExtension and Reviva are listed as suggestions. Read the notes on IVA selection above before deciding what to install.

After installing the dependencies with CKAN, continue with Step 2.

Manual installation

Dependencies

Optional, but useful:

** NOTE: This mod contains a JSI folder which you MUST merge with the one from RasterPropMonitor. They are two separate mods in the same directory! Also, you should delete the MiniAVC.dll file inside the JSI directory that comes with this mod - it's out of date.

Choose an IVA Pack:

Read the notes on IVA selection above and install either KSA IVA Upgrade or DE_IVAExtension (or both and Reviva).

2. Verify

At this point you should launch the game and verify that you can use the IVA in the mk1pod. If you can't, you installed something wrong and there's no point in continuing until you fix it.

3. Install VR Mod

  1. Run vrinstaller.exe and point it at your KSP install directory (where the game executable is - not GameData). For a typical steam install, that might look like this:
    image
    If it ran correctly, you should see some messages that say "SUCCESS:"
    image
    This program will modify the globalgamemanagers file to enable native unity VR support. It will make a backup of the old file if you want to restore it. You can also run ksp with -vrmode None on the command line to disable VR (I'd suggest making a shortcut that launches it with VR disabled). Note that when KerbalVR is installed in GameData, it modifies some props in ways that make them non-functional when playing with VR disabled. You can move or remove KerbalVR temporarily if you want to play without VR and you shouldn't have to undo the change to globalgamemanagers.
  2. Copy the GameData and KSP_x64_Data folders to your root KSP directory. They should merge with the directories that are already there.
  3. Launch the game. Note that VR will not activate until you reach the flight scene. When in the flight scene, you can press alt-V to toggle VR mode.

4. Visual Mods

KerbalVR is now compatible with the following visual mods, with the given requirements:

  • Parallax
  • TUFX version 1.0.5 and later
  • EnvironmentalVisualEnhancements version 1.11.7.1 and later
  • Scatterer. After installing the latest version of scatterer, you must copy the Scatterer folder from the Optional Mods directory in the KerbalVR release zip over your Scatterer folder in GameData. This will replace the scatterer.dll to make it compatible with VR.

Other visual mods are untested; use them at your own risk.

5. How to Fly

See the user guide for instructions on how to control the ship: https://github.com/JonnyOThan/Kerbal-VR/wiki/User-Guide

Clone this wiki locally