feat(comfort): add comfort options (#30)

* feat(comfort): add snap turning

* feat(comfort): add teleport function

* feat(sound): add snap turn sound

* feat(comfort): add vignette effect

* build(deps): add Tobey.UnityAudio dependency

.github/workflows/dotnet.yml

@@ -51,12 +51,10 @@ jobs:
           cp -r ./libs/* ./artifact/Techtonica/Techtonica_Data/
           cp -r ./unity/AssetBundles/StandaloneWindows/* ./artifact/Techtonica/BepInEx/plugins/techtonica_vr/assets
           cp {README.adoc,CHANGELOG.md,LICENSE} ./artifact/
-      - name: TarGz
-        run: cd artifact && tar -czvf techtonica_vr.tar.gz ./* && cp techtonica_vr.tar.gz ../
       - name: Upload Release Asset Artifact
         uses: actions/upload-artifact@v2
         with:
           name: release-artifact
-          path: techtonica_vr.tar.gz
+          path: artifact
 
 

.github/workflows/release-please.yml

@@ -26,10 +26,24 @@ jobs:
           with:
             workflow: "dotnet.yml"
             name: release-artifact
+        - name: Download Tobey.UnityAudio
+          if: ${{ steps.release.outputs.release_created }}
+          uses: dsaltares/fetch-gh-release-asset@1.1.1
+          with:
+            repo: "toebeann/Tobey.UnityAudio"
+            file: "Tobey.UnityAudio.zip"
+            version: "tags/v2.0.0"
+            token: ${{ secrets.DEPENDENCY_TOKEN }}
+        - name: Zip release artifact
+          if: ${{ steps.release.outputs.release_created }}
+          run: |
+            mkdir ./artifact/
+            unzip techtonica_vr.zip -d ./artifact/
+            unzip Tobey.UnityAudio.zip -d ./artifact/TechtonicaVR/
+            zip -r techtonica_vr-${{ steps.release.outputs.tag_name }}.zip ./artifact/*
         - name: Upload release artifact
           if: ${{ steps.release.outputs.release_created }}
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           run: |
-            mv techtonica_vr.tar.gz techtonica_vr-${{ steps.release.outputs.tag_name }}.tar.gz
-            gh release upload ${{ steps.release.outputs.tag }} techtonica_vr-${{ steps.release.outputs.tag_name }}.tar.gz
+            gh release upload ${{ steps.release.outputs.tag }} techtonica_vr-${{ steps.release.outputs.tag_name }}.zip

.vscode/settings.json

@@ -5,6 +5,9 @@
         "ui",
         "player",
         "game",
-        "readme"
+        "readme",
+        "comfort",
+        "sound",
+        "deps"
     ]
 }

README.adoc

@@ -30,7 +30,7 @@ CAUTION: This mod is still in early development and *will* contain bugs. Use at
 . Run the game. The mod should be loaded automatically by BepInEx.
 
 === Disabling the Mod
-To disable the mod change the `Enabled` under `[General]` value in the `de.xenira.techtonica.cfg` file in the `BepInEx/config` folder to `false`.`
+To disable the mod change the `Enabled` under `[General]` value in the `de.xenira.techtonica.cfg` file in the `BepInEx/config` folder to `false`.
 
 === Uninstalling the Mod
 To uninstall the mod remove the mod's files from the `BepInEx/plugins` folder. This should be the following files:
@@ -54,7 +54,6 @@ While the mod is in a playable state, it is still in early development. Some fea
 
 === Missing
 - Gesture support (e.g. Mining using pickaxe motion)
-- Comfort options (e.g. Teleportation). Smooth locomotion and turning only for now. (#9)
 - Model for the player's body. Currently not a priority as this requires IK.
 - Default bindings for VR controllers other than the Valve Index Controllers (#16, #17)
 - Object outlines. Disabled for now as the shader is broken in VR.
@@ -64,7 +63,7 @@ While the mod is in a playable state, it is still in early development. Some fea
 - Hand crank using uhhhhh... hands?
 
 === Known Issues
-- The players position is not synced correctly with the game when using roomscale. The characters position is in the center of the playspace. This might cause issues with collisions and other things. Also map shows the player looking in the wrong direction. (#14)
+- Map shows the player looking in the wrong direction.
 - Button prompts are not for VR controllers. (#13)
 - Haptics are played on both controllers by the game. One improvement would be to play them on the hand that is actually holding the tool.
 - The game is locked to 60fps when running in windowed mode. This is based on the refresh rate of your monitor. To unlock the framerate, switch to fullscreen mode. (#10)
@@ -82,12 +81,18 @@ If you encounter any issues while using this mod, please check the BepInEx conso
 [qanda]
 Why is my framerate locked to 60fps?::
 The game is locked to x fps when running in Windowed mode. This is based on the refresh rate of your monitor. To unlock the framerate, switch to fullscreen mode. (For now)
+Does this mod work with Gamepass?::
+Yes, the mod needs to be installed in `Gamepass/Techtonica/Content`.
 // AI generated below :P
 Why is the mod not open source?::
 It is. You are looking at the source right now (duh!).
 Why is the mod not on NexusMods?::
 I don't like NexusMods. I don't like their ToS and I don't like their mod manager. I don't want to support them.
 
 == License
-
 This mod is licensed under the GNU General Public License v3.0 (GPL-3.0).
+
+Contents of the `unity` and `libs` folders are licensed under their respective licenses.
+
+== Disclaimer
+This mod is not affiliated with the game's developers Fire Hose Games, Unity Technologies or Valve Corporation. All trademarks are the property of their respective owners.

libs/StreamingAssets/SteamVR/actions.json

@@ -193,6 +193,10 @@
       "name": "/actions/default/in/HotbarSwap",
       "type": "boolean"
     },
+    {
+      "name": "/actions/default/in/Teleport",
+      "type": "boolean"
+    },
     {
       "name": "/actions/default/out/Haptic",
       "type": "vibration"
@@ -306,7 +310,8 @@
       "/actions/default/in/ExitHotbarEdit": "Exit Hotbar Edit",
       "/actions/default/in/PauseMenu": "Toggle Pause Menu",
       "/actions/default/in/ClearHotbar": "Clear Hotbar",
-      "/actions/default/in/HotbarSwap": "Swap Hotbar Item"
+      "/actions/default/in/HotbarSwap": "Swap Hotbar Item",
+      "/actions/default/in/Teleport": "Teleport"
     }
   ]
 }