diff --git a/README.md b/README.md index 26a82cf..2d00539 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ A replacement for SteelSeries GG software, to manage your Arctis device on Linux - Configure any device via a simple configuration file - Enable per-device features by adding them in the relative configuration file - D-Bus based communication, to support different clients (alternative clients, Plasma extensions, etc) +- [User Manual](docs/manual.md) ## 🎧 Supported devices table diff --git a/docs/images/manual/apps-kde.png b/docs/images/manual/apps-kde.png new file mode 100644 index 0000000..c390186 Binary files /dev/null and b/docs/images/manual/apps-kde.png differ diff --git a/docs/images/manual/device.png b/docs/images/manual/device.png new file mode 100644 index 0000000..71bf787 Binary files /dev/null and b/docs/images/manual/device.png differ diff --git a/docs/images/manual/general.png b/docs/images/manual/general.png new file mode 100644 index 0000000..1f807b1 Binary files /dev/null and b/docs/images/manual/general.png differ diff --git a/docs/images/manual/mixer-kde.png b/docs/images/manual/mixer-kde.png new file mode 100644 index 0000000..64a0120 Binary files /dev/null and b/docs/images/manual/mixer-kde.png differ diff --git a/docs/images/manual/status.png b/docs/images/manual/status.png new file mode 100644 index 0000000..ff56e4f Binary files /dev/null and b/docs/images/manual/status.png differ diff --git a/docs/manual-kde.md b/docs/manual-kde.md new file mode 100644 index 0000000..a36a672 --- /dev/null +++ b/docs/manual-kde.md @@ -0,0 +1,67 @@ +# Linux Arctis Manager: KDE User manual + +- [Which App to Use?](#which-app-to-use) +- [Status](#status) +- [General](#general) +- [Device](#device) +- [Optional - Using the Mixer](#optional---using-the-mixer) +- [Tips](#tips) + + +## Which App to use? +**Arctis Manager** - The Main app that allows you to manage your headphones. + +**Arctis Manager (system tray)** - Displays a shortcut to the manager in your system tray. *Tip* - Add to your `Autostart - System Settings`. + + + +[Back To Top](#linux-arctis-manager) + +## Status +Gives information on your devices if connected. + + + +[Back To Top](#linux-arctis-manager) + +## General +| Option | Description | +|--------|-------------| +| Redirect Audio On Connect | When headphones turn on it should redirect to them. | +| Redirect Audio on Disconnet | When your headphones disconnect it will connect to a different device such as external speakers. | +| Redirect Audio on Disconnet Device | Select the device to change to if `Redirect Audio on Disconnect` is on. | + + + +[Back To Top](#linux-arctis-manager) + +## Device +| Option | Description | +|--------|-------------| +| Gain | **High**: Will sound louder and have possible distortion or clipping, more sensitive to background noise.
**Low**: Will be quieter, less risk of distortion. | +| Mic Volume | Helps make your voice louder or quieter for your listeners. | +| Mic Side Tone | Feeds a small amount of your mic signal back to you in real time to your headset. | +Mic LED Brightness | When Mic is muted how bright the light will be. | +| PM Shutdown | Will shutdown headest if no activity detected after a certain period of time. | +| Wireless Mode | **Speed**: Prioritizes low latency.
**Range**: Extends the wireless signal range. | + + + +[Back To Top](#linux-arctis-manager) + +## *Optional* - Using the Mixer + +1. Open up the system's sound system tray and go to applications. +1. Click the three dots of the application you want change. +1. You can choose to keep it neutral `Arctis...Analog Stereo`, set it to the `SteelSeries...Media` (Game) or `SteelSeries...Chat` (Chat). + + + +[Back To Top](#linux-arctis-manager) + +## Tips +- Sometimes the Application is slow to respond close and reopen to refresh. +- If you need to kill the app completely you can either go to your distro's monitor and kill it there, or use the terminal command `killall lam-daemon` + + +[Back To Top](#linux-arctis-manager)