# CS\_VOICEUI

* [Watch the preview](https://www.youtube.com/@core-services/videos)
* [Get the script](https://core-services.tebex.io/category/free)

***

## Installation

* [ ] Drag and drop into your resources folder
* [ ] Add to your `server.cfg`:

```
start cs_voiceui
```

* [ ] Configure all settings in `config.lua`.

***

## Configuration

### Config.lua

This configuration file controls server name display, voice system integration, and mute command settings.

<details>

<summary>General Settings</summary>

* **ServerName** – The server name displayed in the UI. Example: `"CoreServices"`.
* **SmallHeading** – A smaller heading text, typically showing the voice system. Example: `"SALTYCHAT"`.
* **DeactivatedHeading** – Text shown when the voice system is deactivated. Example: `"SaltyChat deactivated!"`.
* **InfoText** – Additional information text under the heading. Supports HTML line breaks (`<br>`).\
  Example: `"Please join the TS3 Server coreservices<br>to play on YOURSERVER."`.

</details>

<details>

<summary>Voice System</summary>

* **voice** – Voice system integration. Options: `"pma"` or `"salty"`.

</details>

<details>

<summary>PMA Voice Only Settings</summary>

* **MuteCommandEnabled** – true / false – Enable a mute command for PMA Voice.
* **MuteCommandName** – Name of the mute command. Example: `"muteself"`.
* **MuteKey** – Key mapping for muting yourself. Example: `"j"`.
* **MutedHeading** – Text displayed when player is muted. Example: `"You are muted!"`.
* **MutedInfoText** – Additional info displayed when muted. Supports `<br>` for line breaks. Example: `"You are currently muted."`.

</details>

***

<details>

<summary>Notes</summary>

* Fully compatible with both SaltyChat and PMA Voice.
* Mute commands only work if using PMA Voice.
* All headings and info text can be customized to match your server branding.

</details>

***

## Support

If you have any further questions, open a ticket on our discord server: [**discord.gg/core-services**](https://discord.gg/core-services)