PiVRLoader

v0.1.1·Updated 2024-05-03

Library for VR mods

About this mod Author’s original text

Pi VR Loader

This mod adds VR to Unity games. While the aim is to make it work with any Unity game, the primary focus right now is as a support utility for the Techtonica VR mod and won’t achieve great results out of the box. It is intended to be used by modders to add VR support games in conjunction with their own mod.

I spent countless hours of my free time on this mod.

If you enjoy it, please consider supporting me on Liberapay ❤️

Prerequisites

  • Version 0.3.0-e of the game. As the game is still in early access, this mod may not work with future versions of the game. If you encounter any issues, please create an Issue.
  • BepInEx version BepInEx Version
  • PiUtils mod. Is included in the github release and as as an external dependency release.

Setup

This mod assumes you are a developer or familiar with BepInEx and modding in general. If you are using this mod as basis for your own please package it in a way that users don’t have to come here to figure out how to install it.

If you are a user, please ask the mod author to provide a more user-friendly installation guide or use a mod manager that can install dependencies.

Dependencies

The github release bundles the dependencies with the mod. The release does not include the dependencies. You need to install them separately or use a mod manager that can install dependencies.

PiUtils (Required)

This mod requires the PiUtils mod to be installed. This mod provides some utility functions that are used by the VR mod.

Configuration

The configuration file is located in BepInEx/config/de.xenira.pi_vr_loader.cfg. You can edit it using a text editor like Notepad.

Resetting the Configuration

To reset the configuration, delete the de.xenira.pi_vr_loader.cfg file in the BepInEx/config folder. The mod will create a new configuration file with the default values the next time you run the game.

To reset only a specific section, delete the section from the configuration file. The mod will create a new section with the default values the next time you run the game.

Configuration Options

General

  • Enabed\

Enables or disables the mod. Default: true

Input

  • Laser UI Only\

Only show the laser pointer when pointing at UI elements. Default: true

  • Laser Color\

Color of the laser pointer. Default: 00FFFFFF Cyan

  • Laser Click Color\

Color of the laser pointer when clicking. Default: 0000FFFF Blue

  • Laser Hover Color\

Color of the laser pointer when hovering over a UI element. Default: 00FF00FF Green

  • Laser Invalid Color\

Color of the laser pointer when pointing at an invalid UI element. Default: FF0000FF Red

  • Laser Thickness\

Thickness of the laser pointer. Default: 0.002

  • Laser Click Thickness Multiplier\

Thickness multiplier of the laser pointer when clicking. Default: 2

Comfort

  • Teleport Range\

Velocity of teleport arc. Effectively determines rang. Default: 12

  • Vignette Enabled\

Enables or disables vignette. If this is disabled the other vignette effects will be disabled as well. Default: false

  • Vignette On Teleport\

Enables or disables vignette when teleporting. Default: true

  • Vignette On Smooth Locomotion\

Enables or disables vignette when using smooth locomotion. Default: true

  • Vignette On Snap Turn\

Enables or disables vignette when using snap turning. Default: true

Buttons

  • Click Time\

Time window in seconds for a button press to be considered a click. Higher value makes clicks easier, but delay drag 'n drop. Default: 0.2

UI

  • Menu Scroll Speed\

Speed of scrolling through menus by moving the cursor to the edge. Speed increases when nearer to the edge. Default: 0.125

  • Menu Scroll Deadzone\

Deadzone for scrolling through menus by moving the cursor to the edge. In percent from the center. Effectively the size of the region not triggering scrolling. Default: 0.35

Troubleshooting

If you encounter any issues while using this mod, please check the BepInEx console for any error messages. You can also report issues on the Issues page of this reposit

Install & use Install: follow the bundled instructions

  1. Unzip the archive from playbuff and read the bundled readme / instructions first.
  2. Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
  3. For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
  4. Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.

Install locations vary a lot between mods — the bundled readme is the most reliable guide.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPack3_141-PiUtils

File & checksum

Filename
PiVRLoader-0.1.1.zip
File size
2.9 MiB