Clear Comms

Clear Comms is a PEAK mod that adds advanced noise suppression to your microphone input and the ability to preview what you sound like to other players.

It uses a library called RNNoise to filter out sounds like fans, mechanical keyboard clicks, and snack chewing.

This is a client-side mod, so it only affects your microphone's output--not other players' voices. Other players don't need to install the mod to hear the effect.

Configuration

This mod adds three new settings to the "Audio" tab in the in-game settings menu:

• Enable Noise Filtering: Turns the RNNoise filtering effect on and off completely.
• Noise Filtering Strength: Changes the strength of the filtering effect. At values close to 0.5 this may result in more artifacting or voice doubling,
• Preview Microphone Output: Loops/echoes your microphone's final outgoing sound back to your headphones so you can preview what you'll sound like to other players*

*Please note that the "Preview Microphone Output" setting won't work unless you're in a multiplayer lobby--otherwise the game isn't recording your voice!

Compatibility

As mentioned above, this is a client-side mod.

Clear Comms may not be compatible with other mods that apply filtering to the microphone input, such as Peak Suppression by hiccup or SoundGate by Curiosity_Core_Development. Specifically, enabling native WebRTC's implementations of automatic gain control (AGC), automatic echo cancellation (AEC), and/or noise suppression on top of RNNoise's pre-processing results in poor quality speech at best, and garbled audio at worst.

Manual installation

1. Install BepInEx following the instructions on its Thunderstore page.
2. Run your game at least once to generate the necessary directories and configuration.
3. Click the "Manual Download" button on this mod's Thunderstore page.
4. Right-click the entry for PEAK in your Steam library, then click on "Manage" -> "Browse local files"
5. Navigate into the BepInEx directory.
6. Extract ClearComms.dll and librnnoise-0.dll from the mod's .zip file into the plugins directory.

(Advanced) Compiling

1. Install your preferred .NET SDK (tested with version 9.0.109)
2. Clone this repository (git clone https://gitlab.com/zacharygraber/clearcomms.git)
3. Navigate to the project's root
4. The command dotnet build -c Debug -v d will both compile the mod and attempt to place its DLL files in your game's plugins directory, if it exists.

Help

If you encounter any problems with this mod, please feel free to open a new issue in the GitLab repo.

License

This project is licensed under the MIT License. See the full LICENSE file for more information.

Clear Comms also includes third-party software components, whose respective licenses can be found in THIRD-PARTY-LICENSES.md.