WaporVave-Clear_Comms 1.0.0 Readme

Communities

PEAK Clear_Comms1.0.0

You are viewing a potentially older version of this package. View Latest Version

Install

Date Uploaded

8 months ago

Downloads

17K

Size

3MB

Dependency string

WaporVave-Clear_Comms-1.0.0

Download

Details Required (1)Versions

Clear Comms is a PEAK mod that adds advanced noise suppression to your microphone input.

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.

Manual installation

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

(Advanced) Compiling

Install your preferred .NET SDK (tested with version 9.0.109)
Clone this repository (git clone https://gitlab.com/zacharygraber/clearcomms.git)
Navigate to the project's root
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.