brandonmousseau / vhvr-mod

Adds VR support to the PC game Valheim
GNU General Public License v3.0
137 stars 19 forks source link

VHVR-Mod

This is an experimental mod for the PC game Valheim that adds in native VR support using Unity and SteamVR with OpenVR.

Download the mod at Nexus Mods!

Check out the development log of progress on YouTube.

Join the Flatscreen to VR Modding Discord

What's in this package?

Unity Project

This project exists primarily as an asset generator to produce necessary AssetBundles used by the mod as well as a way to build SteamVR and Unity XR libraries necessary in the proper environment.

There are several assets being generated in the Unity package, but the most important include:

ValheimVRMod C# Project

This project contains the bulk of the code for the mod. It includes classes/Unity MonoBehaviour scripts that implement the following functionality:

Requirements

This mod requires BepInExPack Valheim. BepInEx is a mod framework for Unity games that allows modders to inject their code into the game's runtime. It also includes Harmony, which is a tool used to patch existing methods in C# libraries.

Additionally, you need an HMD that supports OpenVR/SteamVR.

Other Info

This is an experimental mod and almost certainly will contain a bunch of bugs and glitches. Additionally, Valheim is currently an early access game, so there is a high probability that patches will be released for the game that break this mod. Please be patient as fixes are worked on and feel free to report any issues you find :)

As Valheim was not made for VR, this implementation isn't going to be as comfortable as a built-for-VR game. If VR tends to make you feel queasy, then this mod probably isn't for you.