# Plugin installation & configuring guide

## 1. Purchase a copy of ChatSentry [here](https://www.spigotmc.org/resources/79616/)

{% hint style="info" %}
By using ChatSentry, you agree to the [**Plugin's Terms of Use**](https://kixmc.gitbook.io/kixmcs-product-resources/) 
{% endhint %}

## 2. Add ChatSentry-x.x.x.jar to your plugins folder <a href="#id-2-add-to-your-plugins-folder" id="id-2-add-to-your-plugins-folder"></a>

## 3. Restart your server to complete installation <a href="#id-3-restart-your-server" id="id-3-restart-your-server"></a>

Avoid reloading as it can cause memory leaks and undesired issues with some plugins.

{% hint style="success" %}
**If ChatSentry was successfully installed, you'll see a message in your console like this along with some more messages from the plugin:**
{% endhint %}

<div align="left"><img src="https://1128828529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M7WJzX3BgFL2V4BaSof%2Fuploads%2Fus0G90Ue60K3ErsiUdQR%2FyRgR8eA.png?alt=media&#x26;token=1c8b2bc3-e634-4da1-98be-e31c4c6c5cf4" alt=""></div>

## 4. Configure modules and features <a href="#id-4-configure" id="id-4-configure"></a>

**By default, all ChatSentry protection modules are turned off. However, virtually a modules settings themselves come pre-configured to the recommended values for most servers.**

Start in the main [config.yml](https://wiki.chatsentry.xyz/files/files/root-folder/config.yml) file and enable which modules best suit your servers needs. Then skim and tinker with those modules individual configs.

{% hint style="success" %}
Though everything comes pre-configured, each server is different, so to ensure effectiveness of the plugin we recommend you skim and tinker enabled modules configs to best fit with your server
{% endhint %}

**Notable components that may require setup:**

* The Word & Phrase Filter's block list comes empty by default. You can create your own, or copy paste one of the [high quality preset lists](https://wiki.chatsentry.xyz/misc-info/preset-word-lists). If you plan to create your own, refer to the [Word & Phrase Filter block list setup guide](https://wiki.chatsentry.xyz/word-and-phrase-filter-block-list-guide) to learn how to make a great filter
* If your server is not English based, you'll want to translate the [Spam Blocker's phrase whitelist](https://wiki.chatsentry.xyz/config-guides/module-config-guides/spam-blocker#phrase-whitelist), and the [Anti Parrot's phrase whitelist](https://wiki.chatsentry.xyz/config-guides/module-config-guides/anti-parrot#phrase-whitelist) if you plan on using either modules

{% hint style="info" %}
Once you're done configuring, type **/chatsentry reload** to push changes into runtime.
{% endhint %}

## 5. Familiarize yourself with the plugins commands

Type **/kcs help** to see a full list of the plugins commands.

## 6. Add desired permissions to your staff and other groups

The plugin offers a vast selection of permission nodes to let you limit certain features to certain players or groups. Depending on what you've enabled, it's good to skim through and ensure everybody can do and access what you'd like.

{% content-ref url="pac/permissions" %}
[permissions](https://wiki.chatsentry.xyz/pac/permissions)
{% endcontent-ref %}

## 7. Run /kcs info to see an overview of what's enabled

To ensure you didn't miss or accidentally enable anything, you can quickly see an overview of what modules & misc. toggles are enabled with the **/kcs info** command.

![](https://1128828529-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M7WJzX3BgFL2V4BaSof%2F-MRqxKZTXuV5JRHso9gN%2F-MRr4zgM8qg1nysPXbcj%2Finfo.png?alt=media\&token=eb1190eb-e672-4952-b690-0a7435449b14)

## 8. Enjoy peace of mind :man\_in\_lotus\_position:

For any questions, issues, suggestions, or alike, don't hesitate to [contact us](https://wiki.chatsentry.xyz/support)