Skip to content

Installation | Build

username edited this page Mar 14, 2024 · 5 revisions

Installation

Requirements

  • A copy of the latest version of ULTRAKILL (doesn't matter which one)
  • Any SteamVR compatible PC & headset.

Video tutorial here (@guesty5060 you're welcome) (might already be outdated, see text guide)

The process

  1. Make a copy of ULTRAKILL so you can safely mod that version without affecting your normal game:
    1.1 Locate ULTRAKILL in your Steam library (or wherever you store it)
    1.2 RMB -> Manage -> Browse local files
    1.3 Make a copy of the ULTRAKILL folder and put it somewhere

  2. Get & Install latest stable BepInEx 5 that matches your CPU architecture into the new ULTRAKILL folder using their guide. Make sure to run BepInEx'ed ULTRAKILL at least once so it can generate needed folders & files.

  3. Download one of releases, unarchive and merge both ULTRAKILL folders.

  4. Run it once, wait for the error message "unable to find config file, generating a new one" to appear in the console then exit.

  5. Go to BepInEx/plugins/VRTRAKILL, open VRTRAKILL_Config.json and set your preferences there.

  6. Run VR-ed ULTRAKILL again.

  7. For your own convenience you can Add ULTRAKILL to SteamVR library

  8. Add the modded ULTRAKILL as a 'non-steam game': 1.1 ADD A GAME (at the bottom left in the library) -> Add a non-steam game -> select your VR-ed ULTRAKILL.exe

  9. Right click on the new VR-ed ULTRAKILL in your Steam library -> Properties -> Shortcut -> Include in VR Library

  10. Open SteamVR. Now ULTRAKILL should show up in there.

Building from source

Requirements

  • Visual Studio 2022 (edition doesn't matter)
  • C# Module.

Video tutorial here

The process

  1. Download VRTRAKILL source code (as zip file from master branch or from releases)
  2. Open the solution file (.sln)
  3. In the Plugin project:
    • Enable unsafe code
    • Change the Debug thingie on top to Release
  4. Build the solution (RMB on VRTRAKILL -> Build)
  5. Everything should now be in the solution_folder/bin