fix(config): disable vignette by default (#53)

* fix(config): disable vignette by default

* refactor: fix typos

.github/_typos.toml

@@ -0,0 +1,8 @@
+[default.extend-identifiers]
+FluffyUnderware = "FluffyUnderware"
+"Edit_Shotcut" = "Edit_Shotcut"
+
+[files]
+extend-exclude = [
+    "unity/*",
+]

.github/workflows/dotnet.yml

@@ -10,8 +10,19 @@ on:
     branches: [ "master" ]
 
 jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Check typos
+        uses: crate-ci/typos@master
+        with:
+          config: .github/_typos.toml
   build:
-
     runs-on: ubuntu-latest
     defaults:
       run:

.vscode/settings.json

@@ -9,6 +9,7 @@
         "comfort",
         "sound",
         "deps",
-        "thunderstore"
+        "thunderstore",
+        "config"
     ]
-}
+}

CHANGELOG.md

@@ -40,7 +40,7 @@
 
 ### 🐛 Bug Fixes
 
-* **input:** bind map controlls and fix player arrow ([#32](https://github.com/Xenira/TechtonicaVR/issues/32)) ([67d2ebb](https://github.com/Xenira/TechtonicaVR/commit/67d2ebb590ae14fa4d51d5f95be527735b5c2496))
+* **input:** bind map controls and fix player arrow ([#32](https://github.com/Xenira/TechtonicaVR/issues/32)) ([67d2ebb](https://github.com/Xenira/TechtonicaVR/commit/67d2ebb590ae14fa4d51d5f95be527735b5c2496))
 
 
 ### 📝 Documentation
@@ -72,7 +72,7 @@
 * **input:** add smooth turning ([dd579c9](https://github.com/Xenira/TechtonicaVR/commit/dd579c94771fb8014eea119e209e02d6f75578b7))
 * **input:** use right hand as target origin ([8e3a749](https://github.com/Xenira/TechtonicaVR/commit/8e3a7499bf44b5de3c9b39d2a2184b5827820471))
 * **player:** add player hands ([0897dca](https://github.com/Xenira/TechtonicaVR/commit/0897dcab4acda07dfd94a19bbdaa31f083bc2fed))
-* **ui:** attched inspector to aim location ([#23](https://github.com/Xenira/TechtonicaVR/issues/23)) ([b7ef8db](https://github.com/Xenira/TechtonicaVR/commit/b7ef8dbf1f7dfae9a08e0f13f3fe2152e2ab1aac))
+* **ui:** attached inspector to aim location ([#23](https://github.com/Xenira/TechtonicaVR/issues/23)) ([b7ef8db](https://github.com/Xenira/TechtonicaVR/commit/b7ef8dbf1f7dfae9a08e0f13f3fe2152e2ab1aac))
 * **ui:** inventory overhaul ([#3](https://github.com/Xenira/TechtonicaVR/issues/3)) ([4c6fdb5](https://github.com/Xenira/TechtonicaVR/commit/4c6fdb5fc2ef4f6923c1e0de463eae719c10b630))
 * **ui:** move crafting queue to left hand ([#22](https://github.com/Xenira/TechtonicaVR/issues/22)) ([8c4fb9b](https://github.com/Xenira/TechtonicaVR/commit/8c4fb9ba23d0b9b7ef09533324eafd64f3e1dec6))
 

README.adoc

@@ -117,6 +117,48 @@ While the mod is in a playable state, it is still in early development. Some fea
 - Tobii eye tracking for dynamic foveated rendering
 - Enable ik (The game ships with `FinalIK` so it should be possible. Probably just not networked yet.)
 
+== Configuration
+The configuration file is located in `BepInEx/config/de.xenira.techtonica.cfg`. You can edit it using a text editor like Notepad.
+
+=== Resetting the Configuration
+To reset the configuration, delete the `de.xenira.techtonica.cfg` file in the `BepInEx/config` folder. The mod will create a new configuration file with the default values the next time you run the game.
+
+To reset only a specific section, delete the section from the configuration file. The mod will create a new section with the default values the next time you run the game.
+
+=== Configuration Options
+[horizontal]
+.General
+Enabed:: Enables or disables the mod. Default: `true`
+[horizontal]
+.Input
+Smooth Turn Speed:: Speed of smooth turning. Default: `90`
+[horizontal]
+.Comfort
+Snap Turn Angle:: Angle of snap turns. Default: `30`
+Teleport Range:: Velocity of teleport arc. Effectively determines rang. Default: `12`
+Vignette Enabled:: Enables or disables vignette. If this is disabled the other vignette effects will be disabled as well. Default: `false`
+Vignette On Teleport:: Enables or disables vignette when teleporting. Default: `true`
+Vignette On Smooth Locomotion:: Enables or disables vignette when using smooth locomotion. Default: `true`
+Vignette On Snap Turn:: Enables or disables vignette when using snap turning. Default: `true`
+Vignette Color:: Color of the vignette. Default: `000000FF` Black
+Vignette Intensity:: Intensity of the vignette. Determines how far the vignette will close. Default: `0.5`
+Vignette Smoothness:: Adds a blur to the vignette edge. 0 is sharp edge, 1 is prob. unusable. Default: `0.15`
+Vignette Fade Speed:: Animation speed of the vignette. Higher is faster. Default: `3`
+[horizontal]
+.Buttons
+Long Press Time:: Time in seconds before a button press is considered a long press. Default: `1`
+[horizontal]
+.UI
+Menu Spawn Distance:: Distance of the menu from the player. Default: `0.8`
+Menu Scale:: Scale of the menu (X/Y/Z). Default: `{"x":0.2,"y":0.2,"z":0.2}`
+Inventory and Crafting Menu Scale Override:: Scale of the inventory and crafting menu (X/Y/Z). This menu has different scaling and needs separate config. Default: `{"x":0.2,"y":0.1,"z":0.2}`
+Menu Downward Offset:: Offset of the menu in the downward direction. Default: `0.2`
+[horizontal]
+.Debug
+Debug Mode:: Mostly used for development. Default: `false`
+Gizmo Enabled:: Enables or disables gizmos. Only some objects have gizmos attached. Default: `false`
+Debug Line Enabled:: Enables or disables debug lines. Only some objects have debug lines attached and the direction might seem arbetrary at first glance. Default: `false`
+
 == Troubleshooting
 
 If you encounter any issues while using this mod, please check the BepInEx console for any error messages. You can also report issues on the https://github.com/{repo}/issues[Issues] page of this repository.

plugin/src/camera/camera_manager.cs

@@ -30,7 +30,7 @@ private void Start()
 		DontDestroyOnLoad(gameObject);
 	}
 
-	private void OnDestory()
+	private void OnDestroy()
 	{
 		Plugin.Logger.LogInfo("Destroying vr camera manager...");
 	}

plugin/src/mod_config.cs

@@ -53,7 +53,7 @@ public static void Init(ConfigFile config)
 		// Comfort
 		snapTurnAngle = config.Bind("Comfort", "Snap Turn Angle", 30f, "Angle of snap turning");
 		teleportRange = config.Bind("Comfort", "Teleport Range", 12f, "Range of teleporting");
-		vignetteEnabled = config.Bind("Comfort", "Vignette Enabled", true, "Enable vignette");
+		vignetteEnabled = config.Bind("Comfort", "Vignette Enabled", false, "Enable vignette");
 		vignetteOnTeleport = config.Bind("Comfort", "Vignette On Teleport", true, "Enable vignette on teleport");
 		vignetteOnSmoothLocomotion = config.Bind("Comfort", "Vignette On Smooth Locomotion", true, "Enable vignette on smooth locomotion");
 		vignetteOnSmoothTurn = config.Bind("Comfort", "Vignette On Smooth Turn", true, "Enable vignette on smooth turn");