Move docs over. (#3760)

* Docs * Update docs.yaml * Delete docs/LICENCE * Delete docs/README.md * Update module path in go.mod
2026-02-05 23:40:10 +00:00 · 2026-01-07 19:55:35 +00:00
parent 63eeab0b19
commit 69d8649986
165 changed files with 13532 additions and 0 deletions
--- a/docs/content/dev/tweaks/Customize-Preferences/MouseAcceleration.md
+++ b/docs/content/dev/tweaks/Customize-Preferences/MouseAcceleration.md
@@ -0,0 +1,84 @@
+# Mouse Acceleration
+
+Last Updated: 2024-08-07
+
+
+> [!NOTE]
+     The Development Documentation is auto generated for every compilation of Winutil, meaning a part of it will always stay up-to-date. **Developers do have the ability to add custom content, which won't be updated automatically.**
+## Description
+
+If Enabled then Cursor movement is affected by the speed of your physical mouse movements.
+
+<!-- BEGIN CUSTOM CONTENT -->
+
+<!-- END CUSTOM CONTENT -->
+
+<details>
+<summary>Preview Code</summary>
+
+```json
+{
+  "Content": "Mouse Acceleration",
+  "Description": "If Enabled then Cursor movement is affected by the speed of your physical mouse movements.",
+  "category": "Customize Preferences",
+  "panel": "2",
+  "Order": "a107_",
+  "Type": "Toggle",
+  "link": "https://christitustech.github.io/Winutil/dev/tweaks/Customize-Preferences/MouseAcceleration"
+}
+```
+
+</details>
+
+## Function: Invoke-WinutilMouseAcceleration
+
+```powershell
+Function Invoke-WinutilMouseAcceleration {
+    <#
+
+    .SYNOPSIS
+        Enables/Disables Mouse Acceleration
+
+    .PARAMETER DarkMoveEnabled
+        Indicates the current Mouse Acceleration State
+
+    #>
+    Param($MouseAccelerationEnabled)
+    try {
+        if ($MouseAccelerationEnabled -eq $false) {
+            Write-Host "Enabling Mouse Acceleration"
+            $MouseSpeed = 1
+            $MouseThreshold1 = 6
+            $MouseThreshold2 = 10
+        } else {
+            Write-Host "Disabling Mouse Acceleration"
+            $MouseSpeed = 0
+            $MouseThreshold1 = 0
+            $MouseThreshold2 = 0
+
+        }
+
+        $Path = "HKCU:\Control Panel\Mouse"
+        Set-ItemProperty -Path $Path -Name MouseSpeed -Value $MouseSpeed
+        Set-ItemProperty -Path $Path -Name MouseThreshold1 -Value $MouseThreshold1
+        Set-ItemProperty -Path $Path -Name MouseThreshold2 -Value $MouseThreshold2
+    } catch [System.Security.SecurityException] {
+        Write-Warning "Unable to set $Path\$Name to $Value due to a Security Exception"
+    } catch [System.Management.Automation.ItemNotFoundException] {
+        Write-Warning $psitem.Exception.ErrorRecord
+    } catch {
+        Write-Warning "Unable to set $Name due to unhandled exception"
+        Write-Warning $psitem.Exception.StackTrace
+    }
+}
+
+```
+
+
+<!-- BEGIN SECOND CUSTOM CONTENT -->
+
+<!-- END SECOND CUSTOM CONTENT -->
+
+
+[View the JSON file](https://github.com/ChrisTitusTech/Winutil/tree/main/config/tweaks.json)
+