> For the complete documentation index, see [llms.txt](https://pandascript.gitbook.io/pandascript/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pandascript.gitbook.io/pandascript/info/readme.md).

# Welcome

<figure><img src="https://3231742108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F71HzMTM7JPxTTWYTKSWO%2Fuploads%2Fgit-blob-1c4f5f034510877783ad42af23272ade817b58d3%2FPbanner.png?alt=media" alt=""><figcaption></figcaption></figure>

**VoiceSentinel** moderates voice chat on **Paper** and **Folia** servers. It works with **Simple Voice Chat** and **PlasmoVoice**. The plugin turns what players say into text, checks it against your word lists, and warns, reports or mutes them.

Speech is processed in one of three ways (**`processor_connection_mode`** in the plugin):

* **LOCAL (On-Server Mode):** the speech engine runs on your Minecraft server. No Docker, and audio never leaves your server.
* **PUBLIC:** the shared PandaScript pool. No setup.
* **CUSTOM:** a processor you run yourself.

In On-Server Mode a second model double-checks every hit, and a listed word is caught while the player is still talking (live detection).

Each hit is mild, moderate or severe. Repeat offenders move up a ladder of report, warn and mute. Players can agree through a join notice or a menu. Several servers can share strikes through MySQL or MariaDB. The optional **VoiceSentinel Cloud** add-on adds incident history, a Discord bot and player appeals.

Start here:

* **Plugin (Paper / Folia):** [Installation](/pandascript/voicesentinel-plugin/installation.md)
* **No Docker:** [On-Server Mode](/pandascript/voicesentinel-plugin/on-server-mode.md)
* **Updating to 3.8.0:** [Updating](/pandascript/voicesentinel-plugin/updating.md)
* **Hear it work:** [Try it](/pandascript/voicesentinel-plugin/try-it.md)
* **Processor (Docker / bare metal):** [Installation](/pandascript/voicesentinel-processor/installation.md)
* **Legal:** [**https://www.pandascript.dev/voicesentinel**](https://www.pandascript.dev/voicesentinel)

Use the sidebar for the full table of contents.