Skip to content

Xenira/PiVrLoader

Repository files navigation

Pi VR Loader

GitHub release (with filter) GitHub Release Date - Published_At Thunderstore.io GitHub downloads all releases LiberaPay Patrons GitHub Workflow Status (with event) GitHub issues GitHub pull requests License

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 ❤️

Donate using Liberapay

1. 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 in the thunderstore release.

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

2.1. Dependencies

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

2.1.1. PiUtils (Required)

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

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

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

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

4. 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 repository.

5. License

This mod is licensed under the Mozilla Public License 2.0 (MPL 2.0).

Contents of the unity, tools and libs folders are licensed under their respective licenses.

6. Disclaimer

This mod is not affiliated with Unity Technologies or Valve Corporation. All trademarks are the property of their respective owners.