CircuitLordVRModInstaller README

The project's README from github.com/CircuitLord/CircuitLordVRModInstaller. As one markdown file: README.md.

Big Walk VR

CircuitLord's VR Mod Installer

Join the Discord if you have questions or feedback!

Hey, I'm CircuitLord! This is a utility to automatically install my full-conversion VR mods, keep them up-to-date, and launch them in VR. It currently supports:

These mods and this installer are community projects, not affiliated with or endorsed by the game developers or publishers. Use at your own risk.

Download the installer

Titanfall 2 VR

Titanfall 2 VR adds full VR support to the Titanfall 2 campaign. It also includes stereo rendering, full body IK, manual reloads, Titan controls, and more!

What the installer does

  1. Finds Titanfall 2 through your Steam/EA/Xbox install.
  2. Checks the EA app, which Titanfall 2 needs you signed into to play. If it's missing, launch Titanfall 2 once to install it.
  3. Installs Northstar and the mod into a separate TF2VR profile in your game directory.

Launching Titanfall 2 normally stays unmodded. To play in VR, start SteamVR/your VR runtime of choice and use the installer's Launch in VR button.

Campaign saves

VR launches keep their own saves and settings in %LOCALAPPDATA%\Respawn\Titanfall2_VR, so your regular campaign stays untouched. Use the installer's Campaign saves button to check your VR save or open its folder.

Big Walk VR

Big Walk VR adds full multiplayer-compatible SteamVR support to the game Big Walk by House House. It includes stereo rendering support, full 6dof motion controls with support for grabbing and throwing objects, and more!

Do other players need the mod?

The host and other players need the mod installed to see your VR hands.

Your non-vr friends can install the mod and still play in flatscreen!

What the installer does

  1. Finds Big Walk through your Steam install.
  2. Sets up BepInEx, the mod loader Big Walk VR depends on.
  3. Installs the mod into your game directory.

Launching Big Walk normally through Steam stays non-VR while showing VR players' tracked movement. To play in VR, start SteamVR and use the installer's Launch in VR button.

Building from source

Needs the .NET Framework 4.8 SDK.

dotnet build src/Installer -c Release

Output is a single src/Installer/bin/Release/net48/CircuitLordVRModInstaller.exe using only .NET Framework assemblies.

How it works

manifest-v3.json lists the installer version and each mod release with its download URL and SHA-256 hash. The app compares it against what is installed and shows Install or Update. Older manifests stay frozen so older installers can still update themselves.

Each mod entry can declare:

"channels": [
  {
    "id": "beta",
    "description": "New features, may be unstable",
    "version": "1.1.0-beta.1",
    "url": "https://example.com/BigWalkVR-1.1.0-beta.1.zip",
    "sha256": "...",
    "size": 20214466
  }
]

A channel shows only while its version is newer than stable. Removing a channel moves its users back to stable.

Every install records the files it wrote inside the game folder. Updates delete files the previous version shipped that the new one no longer does, and uninstall removes exactly what was recorded.

License

The installer source code is MIT, see LICENSE. Third-party software details are in THIRD-PARTY-NOTICES.md.

The mods are closed source and not covered by the MIT license. All rights reserved. Do not redistribute them without permission.

Supporting

If you've enjoyed something I've made, and want to support my work, see my ko-fi!

https://ko-fi.com/circuitlord

CircuitLordVRModInstaller (CircuitLord/CircuitLordVRModInstaller)

Searching Database…

What is this?This is a one-click Windows installer for CircuitLord's full VR conversion mods: Big Walk VR and Titanfall 2 VR. It finds your game install, sets up the required mod loader, installs the mod, and can launch the game straight into VR.
Is this a mod itself or just an installer app?It is a standalone Windows desktop app (.exe) that manages installing, updating, and launching the mods — the actual mod code is Northstar for Titanfall 2 and a BepInEx package for Big Walk.
How do I get the VR mods running?Download and run the installer exe; it locates your game through Steam/EA/Xbox, installs the mod loader (Northstar for Titanfall 2, BepInEx for Big Walk) and the mod into your game directory, then you use its 'Launch in VR' button.
Do I need an EA account or SteamVR to use this?Yes — Titanfall 2 VR needs you signed into the EA app since the base game requires it, and you need a VR runtime like SteamVR running to actually play in VR; building the installer from source instead needs the .NET Framework 4.8 SDK.
Does installing the mod break my normal, non-VR game?No — Titanfall 2 VR runs from a separate TF2VR profile in your game directory, and Big Walk still launches normally and non-VR through Steam, so your regular install stays untouched.
Do other players need the mod to play Big Walk VR with me?Yes, the host and other players need the mod installed to see your VR hands, though non-VR friends can still join and play in flatscreen without installing anything extra.
Is this free to use?Yes, the installer itself is MIT licensed; the third-party components it bundles (like BepInEx/Northstar) are documented separately.
What does the manifest file actually control?manifest-v2.json lists the installer version, BepInEx build, and every available mod with its download URL and SHA-256 hash; the app compares schema versions to decide whether to show Install or Update.
Will updating the mod wipe my settings or configs?No, files marked 'preserve' in the manifest are left alone during updates so calibration and config survive, and uninstalling removes only the exact files that were recorded during install, nothing else.
Can I keep my existing Titanfall 2 campaign progress?Yes, during install you can copy your existing campaign save into the separate VR profile or start fresh; VR saves live in Documents/Respawn/Titanfall2VR, separate from your normal save.
Is this officially supported by Respawn or House House?No, both mods and the installer are unofficial community projects, not affiliated with or endorsed by the game developers or publishers.
Size
41.8 MB
Stars
1.3K
Age
2mo
Commits · 90 Days