> For the complete documentation index, see [llms.txt](https://xeinmod.gitbook.io/xeinmod-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xeinmod.gitbook.io/xeinmod-wiki/bot-configuration/setup-alert-feature.md).

# Setup alert feature :

{% hint style="info" %}
When a word or group of word is send, you will be alerted or the sender will be warned (it depends on what you have chosen).
{% endhint %}

{% hint style="warning" %}
You can see what words / group of words you have added to the list by using the following commands : 

`!alert list`
{% endhint %}

## Add a word / group of words to the list :

Execute the following command to add a word or group of words to the list : 

`!alert add [word] [boolean]`

| Arguments | Explanation                                                                                                                                         | Required |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| word      | The word or groups of word to add                                                                                                                   | Required |
| boolean   | true or false. If you enter "true", the user that send the message will be warned, else the staff will be alerted that a banned word had been used. | Required |

## Remove a word / group of word from the list :

Execute the following command to remove a word or group of words to the list : 

`!alert remove [word]`

| Arguments | Explanation                                       | Required |
| --------- | ------------------------------------------------- | -------- |
| word      | The word / group of words to remove from the list | Required |

## Alert channel :

Execute the following command to setup the channel in which the staff will received the alerts : 

`!alert setChannel [channelID]`

| Arguments | Explanation                               | Required |
| --------- | ----------------------------------------- | -------- |
| channelID | The channel in which alerts will be sent. | Required |