From efb97f23dbe82702a67592c87cba3f6e2972b877 Mon Sep 17 00:00:00 2001 From: hiina Date: Fri, 23 Aug 2024 16:05:21 -0600 Subject: [PATCH] add steamvr binding automation script cool, it seems to worg. --- README.md | 18 ++++++++- index.html | 73 ++++++++++++++++++++++++++++--------- index.toml | 8 ++++ pack.toml | 2 +- setup-steamvr-bindings.ps1 | 75 ++++++++++++++++++++++++++++++++++++++ setup-steamvr-bindings.vbs | 6 +++ 6 files changed, 162 insertions(+), 20 deletions(-) create mode 100644 setup-steamvr-bindings.ps1 create mode 100644 setup-steamvr-bindings.vbs diff --git a/README.md b/README.md index 4552e20..2534ac0 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,23 @@ entire instance and probably not lose anything important. ### SteamVR Bindings -TODO +The SteamVR bindings are awful, and even worse for non-steam games like Vivecraft; the +bindings are supposed to be in the workshop, but they're not. Plus you still have to click +through a bunch of things even if it was there. + +Thus, we bundle the bindings json file in the pack, downloaded by packwiz, and +include the `setup-steamvr-bindings.ps1` script to copy the bindings file to the +`/steamvr/input/imports` directory, and then call the HTTP API that +steamVR uses internally in the bindings UI to click the button for you. + +And also there's the `setup-steamvr-bindings.vbs` wrapper script, since ps1 +scripts don't seem to run on double-click by default, but VBS does. + +So you still have to do some stuff manually, but it's way less hassle than it'd be +otherwise. + +Ideally the multiMC script would run the script on boot, but the packwiz-installer +already runs there. Might be able to make a wrapper to call both though. ### Mod Descriptions diff --git a/index.html b/index.html index 5dcd66a..45ee2a9 100644 --- a/index.html +++ b/index.html @@ -73,26 +73,60 @@ -
+
+

SteamVR Binding Setup

+ +

+ After you have the instance loaded in launcher, you'll still have to setup the bindings, which is + excruciatingly difficult usually. We've managed to automate most of this, but you'll still have to do the + following at least one time: +

+ +
    +
  1. Open the launcher (PolyMC, MultiMC, or Prism Launcher)
    2. +
  2. Right-click on the VR Crawler instance
    3. +
  3. Select "Minecraft Folder" to open the .minecraft folder
    4. +
  4. Locate the file named "setup-steamvr-bindings.vbs"
    5. +
  5. Double-click the "setup-steamvr-bindings.vbs" script to run it.
    6. +
  6. the script installs the bindings for you!
    7. +
+ +

Manual Binding Setup

+ +

+ If you don't want to use our recommended bindings, you should at least setup the following bindings: + +

    +
  • Combat Roll - Roll
    • +
  • ImmersiveMC VR Bindings - Ranged Grab
    • +
  • VR Jester - Gesture Listener Trigger
    • +
+ + in the "Modded" tab of the binding UI. See this visual + guide for help on how to do this. +

+

+

+ +
+

How to Play

+

- Start the game, put on your headset, then connect to the server that's prefilled in the multiplayer menu. + Double-click the instance in the launcher. It'll take a while to start up. Once you're in, connect to the + server in the multiplayer menu (if it doesn't auto-connect).

- If you're entirely new to vivecraft / minecraft, you may have to set up the SteamVR bindings. With an Index controller - you can use the VR Crawler community binding. It is included in the instance folder as org.jrbudda.vivecraft.steamvrinput_knuckles.json - and can be placed in Documents/steamvr/input. Otherwise use SteamVR's binding menu to bind Combat Roll - Roll, - VR Jester - Gesture Listener Trigger, and ImmersiveMC VR Bindings - Ranged Grab in the Modded tab. - This explains the process of setting up custom bindings. - Check out Vivecraft's How To Play guide - for more basic control info. + If you're entirely new to minecraft/vivecraft, see Vivecraft's How To Play guide for basic info. + TODO our bindings are different though, so we'll eventually have some controller pictures for you.

-

- If it's your first time playing, you'll get some books in your inventory that explain things. - Open them up to read them. We've also put up signs around the starting town to help you figure things out, - hopefully without ever opening the overlay or taking the headset off. + As for actual game mechanics, you will get some books in your inventory that explain things. + As usual though, nobody fucking reads those things, so if somebody else is on the server, ask them in voice + chat for help.

@@ -104,11 +138,12 @@ themselves to actually moving your arms around; inevitably, everyone just logs on in flat mode instead.

If you want a more vanilla - experience, try the other /vrg/ NA minecraft server, or one of the servers shilled on /vm/ . + experience, try the other /vrg/ NA minecraft server, or one of + the servers shilled on /vm/ .

What's actually in the mod pack?

-

See the full modlist for a nicely categorized list, with expandable full descriptions +

See the full modlist for a nicely categorized list, with expandable full + descriptions and links to the modrinth pages.

Something broke / the server is down!

Complain in the thread, I'll see it.

@@ -116,10 +151,12 @@

The modpack doesn't actually have the jars in it. It uses packwiz-installer to - actually download all the jars for you from modrinth, as well as keep the modpack up to date to the changes + actually download all the jars for you from modrinth, as well as keep the modpack up to date to the + changes we make in the git repository for the pack. - It's a lot of autism, and packwiz ain't perfect, but it's a lot more maintainable than a directory full of + It's a lot of autism, and packwiz ain't perfect, but it's a lot more maintainable than a directory full + of jars.

diff --git a/index.toml b/index.toml index b4b66de..88ac467 100644 --- a/index.toml +++ b/index.toml @@ -2523,3 +2523,11 @@ hash = "7a6c14d87a80ec8a6cf49d620148f32a091dccee25a930f72f593840eb6223c8" [[files]] file = "patchouli_books/vrcrawler/loot_tables/grant_book_on_first_join.json" hash = "3223d26ef6c683a5a016a7749c30121457b4f7218641f0db48dbf7ebbab28e48" + +[[files]] +file = "setup-steamvr-bindings.ps1" +hash = "38d2fd63756957a14e4443cbe5b68d09dc3d609b297e038370935dfa8132b842" + +[[files]] +file = "setup-steamvr-bindings.vbs" +hash = "38b42d412ac37f390a94a546dba352a0e89b76c32ea0d45bdd6db401f3feffe9" diff --git a/pack.toml b/pack.toml index 1b10f7c..842a89d 100644 --- a/pack.toml +++ b/pack.toml @@ -5,7 +5,7 @@ pack-format = "packwiz:1.1.0" [index] file = "index.toml" hash-format = "sha256" -hash = "e6e8841f657869ba617ea422b761bea7bc9c3dcf9369ae6b710d35ce8ab8851c" +hash = "5f32b233dbcd548417f2a5399b4e23bea6ed7a02f7ed5c3db67ed54c68b6165d" [versions] fabric = "0.16.0" diff --git a/setup-steamvr-bindings.ps1 b/setup-steamvr-bindings.ps1 new file mode 100644 index 0000000..8fed399 --- /dev/null +++ b/setup-steamvr-bindings.ps1 @@ -0,0 +1,75 @@ +# automatically imports the bindings file into steamvr so you don't have to +# go through the awful UI yourself. +# This uses the undocumented API in the bindings UI itself (it's a webapp). +# SteamVR needs to be running for this to work, but avoids needing to mess with steamvr's json +# config directly. +Write-Host "Checking if SteamVR is running..." +# Check if SteamVR is running +$steamVRProcess = Get-Process -Name "vrcompositor" -ErrorAction SilentlyContinue +if (-not $steamVRProcess) { + $wshell = New-Object -ComObject Wscript.Shell + $wshell.Popup("SteamVR is not running. Please start SteamVR and try again.", 0, "SteamVR Not Running", 0x0 + 0x30) + $null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown") + exit 1 +} + +Write-Host "Copying bindings file..." +# Get the directory that the script is in +$currentDir = Split-Path -Parent $MyInvocation.MyCommand.Definition + +# Source bindings file +$sourceBindingsFile = Join-Path -Path $currentDir -ChildPath "org.jrbudda.vivecraft.steamvrinput_knuckles.json" + +# Ensure the source file exists +if (-not (Test-Path $sourceBindingsFile)) { + Write-Error "Bindings file not found: $sourceBindingsFile" + $null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown") + exit 1 +} + +# Construct the path to the SteamVR input import directory +$steamVRImportDir = Join-Path -Path ([Environment]::GetFolderPath("MyDocuments")) -ChildPath "steamvr\input\imports" + +# Ensure the SteamVR input import directory exists +if (-not (Test-Path $steamVRImportDir)) { + New-Item -ItemType Directory -Path $steamVRImportDir -Force +} + +# Destination path for the bindings file +$destBindingsFile = Join-Path -Path $steamVRImportDir -ChildPath "org.jrbudda.vivecraft.steamvrinput_knuckles.json" + +# Copy the bindings file +Copy-Item -Path $sourceBindingsFile -Destination $destBindingsFile -Force + +Write-Host "Calling SteamVR API..." +# Convert the destination file path to a file URI +$fileUri = [System.Uri]::new($destBindingsFile).AbsoluteUri + +# Construct the body with the correct file URI +$body = @{ + app_key = "org.jrbudda.vivecraft.steamvrinput" + controller_type = "knuckles" + url = $fileUri +} | ConvertTo-Json + +try { + $response = Invoke-WebRequest -UseBasicParsing -Uri "http://localhost:27062/input/selectconfig.action" ` + -Method POST ` + -Headers @{ + "Accept" = "application/json, text/plain, */*" + "Origin" = "http://localhost:27062" + "Referer" = "http://localhost:27062/dashboard/controllerbinding.html" + } ` + -ContentType "application/json" ` + -Body $body + + if ($response.StatusCode -eq 200) { + $wshell = New-Object -ComObject Wscript.Shell + $wshell.Popup("Sucessfully set recommended SteamVR bindings for Vivecraft.", 0, "Success", 0x0 + 0x40) + } +} +catch { + Write-Error "Failed to call the API: $_" + $null = $Host.UI.RawUI.ReadKey("NoEcho,IncludeKeyDown") + exit 1 +} diff --git a/setup-steamvr-bindings.vbs b/setup-steamvr-bindings.vbs new file mode 100644 index 0000000..105f64d --- /dev/null +++ b/setup-steamvr-bindings.vbs @@ -0,0 +1,6 @@ +Set objShell = CreateObject("Wscript.Shell") +strPath = Wscript.ScriptFullName +Set objFSO = CreateObject("Scripting.FileSystemObject") +strFolder = objFSO.GetParentFolderName(strPath) +strPSScript = objFSO.BuildPath(strFolder, "setup-steamvr-bindings.ps1") +objShell.Run "powershell.exe -ExecutionPolicy Bypass -NoProfile -File """ & strPSScript & """", 1, True \ No newline at end of file