docs(gkeys): Add Logitech G-Keys user documentation (PR #190)

mumble-voip · Jun 25, 2023 · 52d388d · 52d388d
2 parents 66042c6 + 880d88f
commit 52d388d
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 0 deletions.
diff --git a/hugo/content/documentation/user/logitech-g-keys/Mumble-gkey-shortcuts.png b/hugo/content/documentation/user/logitech-g-keys/Mumble-gkey-shortcuts.png
diff --git a/hugo/content/documentation/user/logitech-g-keys/Mumble-profile-border.png b/hugo/content/documentation/user/logitech-g-keys/Mumble-profile-border.png
diff --git a/hugo/content/documentation/user/logitech-g-keys/Mumble-profile-detail.png b/hugo/content/documentation/user/logitech-g-keys/Mumble-profile-detail.png
diff --git a/hugo/content/documentation/user/logitech-g-keys/Open-gkeys-border.png b/hugo/content/documentation/user/logitech-g-keys/Open-gkeys-border.png
diff --git a/hugo/content/documentation/user/logitech-g-keys/Open-lgs.png b/hugo/content/documentation/user/logitech-g-keys/Open-lgs.png
diff --git a/hugo/content/documentation/user/logitech-g-keys/Set-as-default-detail.png b/hugo/content/documentation/user/logitech-g-keys/Set-as-default-detail.png
diff --git a/hugo/content/documentation/user/logitech-g-keys/Set-as-default.png b/hugo/content/documentation/user/logitech-g-keys/Set-as-default.png
diff --git a/hugo/content/documentation/user/logitech-g-keys/index.md b/hugo/content/documentation/user/logitech-g-keys/index.md
@@ -0,0 +1,46 @@
++++
+title = "Logitech G-Keys"
++++
+The G-keys available on many Logitech keyboards can be used as keyboard shortcuts in Mumble 1.3.0 and later.
+
+## First-time setup
+
+Install the [Logitech Gaming Software (LGS)](http://support.logitech.com/en_ca/software/gaming-software).
+
+If it is already installed, ensure it is at least version 8.55.
+
+1\. Launch LGS
+
+2\. Launch or restart Mumble.
+
+3\. Open the LGS window
+
+![Screenshot](Open-lgs.png)
+
+5\. Open the G-keys view
+
+<img src="Open-gkeys-border.png" alt="Screenshot" width=300>
+
+6\. You should see that a "mumble" profile has been created
+
+<img src="Mumble-profile-border.png" alt="Screenshot" width=300>
+
+![Screenshot](Mumble-profile-detail.png)
+
+7\. Right click the mumble profile and select **"Set as Default"** or **"Set as Persistent"**.
+
+This is required due to limitations of the Logitech G-key API, since it was designed for use only with games in mind.
+
+*We recommend setting the mumble profile as default.*
+
+*For more information, see "What are persistent and default profiles?" in the LGS help by clicking on the "?" icon on the LGS window, or in [the online manual (PDF)(page 54)](http://www.logitech.com/assets/51813/3/lgs-guide.pdf).*
+
+*If mumble is not set as the default or persistent profile, then your keys will not be active unless mumble is the active window.*
+
+<img src="Set-as-default.png" alt="Screenshot" width=300>
+
+![Screenshot](Set-as-default-detail.png)
+
+8\. In Mumble, you should now be able to set G-keys as your shortcut keys
+
+![Screenshot](Mumble-gkey-shortcuts.png)