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…

这是什么?这是一个一键式 Windows 安装器,用于 CircuitLord 的完整 VR 转换模组:Big Walk VR 和 Titanfall 2 VR。它会找到你的游戏安装位置,配置所需的模组加载器,安装模组,并能让游戏直接以 VR 方式启动。
它本身是模组,还是只是一个安装器应用?它是一个独立的 Windows 桌面应用(.exe),负责管理模组的安装、更新和启动——实际的模组代码是 Titanfall 2 的 Northstar 和 Big Walk 的 BepInEx 包。
怎么让这些 VR 模组跑起来?下载并运行安装器 exe;它会通过 Steam/EA/Xbox 定位你的游戏,把模组加载器(Titanfall 2 用 Northstar,Big Walk 用 BepInEx)和模组安装进你的游戏目录,然后你使用它的「以 VR 启动」按钮。
使用它需要 EA 账号或 SteamVR 吗?需要——Titanfall 2 VR 要求你登录 EA 应用,因为本体游戏需要它;要真正以 VR 游玩,你还需要 SteamVR 之类的 VR 运行时在运行;如果改为从源码构建安装器,则需要 .NET Framework 4.8 SDK。
安装模组会弄坏我正常的非 VR 游戏吗?不会——Titanfall 2 VR 从你游戏目录中一个独立的 TF2VR 配置运行,Big Walk 仍通过 Steam 以正常的非 VR 方式启动,你的常规安装不受影响。
其他玩家和我一起玩 Big Walk VR 也需要装这个模组吗?需要,房主和其他玩家必须安装模组才能看到你的 VR 手部,不过非 VR 的朋友仍然可以加入并在平面屏幕上游玩,无需安装任何额外东西。
它免费使用吗?是的,安装器本身采用 MIT 许可证;它捆绑的第三方组件(如 BepInEx/Northstar)另有单独的说明。
manifest 文件实际控制什么?manifest-v2.json 列出安装器版本、BepInEx 构建,以及每个可用模组及其下载 URL 和 SHA-256 哈希;应用会比较 schema 版本来决定显示「安装」还是「更新」。
更新模组会清掉我的设置或配置吗?不会,manifest 中标记为「preserve」的文件在更新时保持原样,校准和配置得以保留;卸载时也只删除安装时记录在案的文件,不会动其他任何东西。
我能保留现有的 Titanfall 2 战役进度吗?可以,安装时你可以把现有的战役存档复制进独立的 VR 配置,也可以从头开始;VR 存档位于 Documents/Respawn/Titanfall2VR,与你的正常存档相互分开。
它得到 Respawn 或 House House 的官方支持吗?没有,模组和安装器都是非官方的社区项目,与游戏开发商或发行商没有隶属关系,也未获其认可。
Size
41.8 MB
Stars
1.3K
Age
2mo
Commits · 90 Days