Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: DOCS: Add Userguides to the documentation. #4628

Closed
wants to merge 16 commits into from
132 changes: 129 additions & 3 deletions docs/user-guides/client_config_guide.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,138 @@
# Client Configuration Guide

**Note:** For Installation and Starting of the Mumble Client, see the specific [Userguides](README.md) for your Operating System.

<!-- Pictures or even Gifs could be added for better presentation-->
<!-- Note: The pictures below are from a Mumble Client on Arch Linux, using the Dark Standard Theme, with already adjusted options. -->

<!-- Todo -->
<!--

- Add Troubleshooting section or seperate guide?

- Pictures or even Gifs could be added for better presentation

![Alt-Text](/Path/to/picture.jpg)
Here should be a picture

--->


<!--## Audio Wizard? -->

<!--## Important Config Options -->

<!-- Topics suggested by Krzmbrzl:
change theme between Lite and Dark mode, echo cancellation, transmission modes (VAD, PTT, continous), shortcuts -->
<!--
Topics suggested by Krzmbrzl:
- change theme between Lite and Dark mode,
- (done) echo cancellation,
- (almost done)transmission modes (VAD, PTT, continous),
- shortcuts

-->

## Configuration Menu

<!-- where to find config options, add gif? -->

Click on `Configure`->`Settings` or on the `gear`-symbol to open the Configuration Menu.
toby63 marked this conversation as resolved.
Show resolved Hide resolved

*Tip: A small description of each option is displayed, when you hover your mouse pointer over it.*


Below you find a list with the most important options:

### Audio Input

![Here should be a picture](pictures/audio-input.png)

#### Interface

##### Echo Cancellation

If enabled, this will filter echo from the audio you send to others.

You should usually enable it, because even when you use headsets, they might transmit undesired noise.

Choose one of the following options:

| Option: | Description: | Usecases: |
| --- | --- | --- |
| Mixed echo cancellation | This is the basic Option: It will process all loudspeaker outputs bundled together.
This is less accurate than the Multichannel option, but will also use less CPU. | Sufficient for setups with loudspeakers near to the microphone. |
| Multichannel echo cancellation | Extended option: This will process all audio channels seperately, this is more accurate, but will result in higher CPU usage. | For setups with (multiple) loudspeakers farther away from the microphone. |
| Disabled | Disables echo cancellation (not recommended). | You use a very good headset. Or you use external echo cancellation (for example via pulseaudio on Linux). Or echo cancellation is causing problems. |

#### Transmission

You can choose between three transmission modes:

1. **Push to Talk**

Your voice is only transmitted when you press a button.
You can set the button in the `Shortcuts`-Menu (see below).

![Here should be a picture](pictures/audio/push-to-talk.png)


2. **Voice Activity**

Your voice is only transmitted when a certain limit (loudness) is reached.
All noise below the limit will be canceled.

*Tip:* Use the `Audio Wizard`(`Configure`->`Audio Wizard`) to configure this option correctly.

<!-- what is the difference between `Amplitude` and `Signal to noise` ? -->

![Here should be a picture](pictures/audio/voice-activity.png)

The coloured bar will show the noise-level when you speak, adjust `Silence below` (everything below the marker will not be transmitted) and `Speech above` (everything above the marker will be transmitted) accordingly.

3. **Continuous**

All Audio from your microphone will be transmitted continuously.

**Note:** You should usually **not** use this option, as it can be very annoying for listeners.
It is intended for special usecases (Music bots, Recording etc.) or when you use external tools for audio filtering instead.

#### Compression

**Quality:**
Sets the maximum bandwidth the client will try to accomplish (it is limited by the Server you are connected to).
Setting it higher will increase the audio quality.
Only set it higher if your internet connection is good enough.
<!-- maximum? -->

<!-- Audio per packet: What does it do? Which is option is better for which scenario? -->

#### Audio Processing

**RNNoise**

RNNoise is a noise suppression library.
It is intended to filter background noises from the audio that you send sent to other users.
RNNoise uses a deep learning algorithm so it should work better than most regular filters.

More information can be found on various websites:

- [RNNoise GitHub repo](https://github.com/xiph/rnnoise)
- [Article at Mozilla.org on RNNoise](https://hacks.mozilla.org/2017/09/rnnoise-deep-learning-noise-suppression/)



### Shortcuts

![Here should be a picture](pictures/shortcuts.png)

<!-- insert gif? -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that our shortcut menu currently is not the most intuitive thing to use, this might be a good idea 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will see how good or bad that will work :D.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some testing with the gifs and right now it seems I am not able to make that work properly (filesizes to big, picture to small, quality to bad). Quess I do something wrong.

But I will keep trying; as an alternative I might just create a very short gif with the main steps (clicks) manually...



### Overlay

If enabled, it implements a small window inside other applications (mostly Games), that will show the users and their status in your Mumble channel.

![Here should be a picture](pictures/overlay.png)

In tab <!-- slider? --> `Layout` you can adjust the position of the window.

In tab `Overlay Exceptions` you can either specify a list of programs where the overlay is allowed (whitelist) or where the overlay is denied (blacklist).
<!-- whitelist and blacklist are considered problematic nowadays, use alternatives? -->
Binary file added docs/user-guides/pictures/audio-input.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user-guides/pictures/audio-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user-guides/pictures/messages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user-guides/pictures/network.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user-guides/pictures/overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user-guides/pictures/plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user-guides/pictures/shortcuts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user-guides/pictures/userinteface.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.