eu.astrogd.white-leopard/README.md

# eu.astrogd.white-leopard

A Discord bot that checks Discord channel names for banned words and prevents renaming of them

## Commands

### /logchanel [channel?] `Permission: MANAGE_GUILD`

Sets the channel where the bot will log if a channel meets the banned word criteria. If channel is omitted, the log channel will be disabled.

### /blocklist `Permission: MANAGE_GUILD`

#### /blocklist get

Returns the global and server specific banned word list and returns it (Same behaviour as /showblocklist)

#### /blocklist add [word]

Adds the word to the server specific blocklist

#### /blocklist remove [word]

Removes the word from the server specific blocklist

### /info `Permission: EVERYONE`

Returns general information about the bot and the servers stats

### /preservesettings `Permission: ADMINISTRATOR`

Changes the behaviour when the bot leaves the server.
Options are:

- Keep settings persistent even if the bot leaves
- Delete setting when the bot leaves the server [default]

### /showblocklist `Permission: MANAGE_CHANNELS`

Returns the global and server specific banned word list and returns it

### /showsettings `Permission: MANAGE_GUILD`

Returns the current settings for the server

## Environment variables

| Name             | Description                                                                     | Required | Example             |
| :--------------- | :------------------------------------------------------------------------------ | :------: | :------------------ |
| TOKEN            | Discord bot token to log into the API with                                      |   ▶️/🚀    | NzYzMDP3MzE1Mzky... |
| DB_HOST          | Hostname of the database                                                        |    ▶️     | 127.0.0.1           |
| DB_USERNAME      | Username of the database                                                        |    ▶️     | root                |
| DB_PASSWORD      | Password of the database                                                        |    ▶️     | abc123              |
| DB_DATABASE      | Database name                                                                   |    ▶️     | white-leopard       |
| CLIENT_ID        | Client ID of the Discord appication associated with the token                   |    🚀     | 763035392692274     |
| DEPLOY_TOKEN     | Production Discord bot token to log into the API with                           |    🚀     | NzYzMDP3MzE1Mzky... |
| DEPLOY_CLIENT_ID | Production Client ID of the Discord appication associated with the deploy token |    🚀     | 763035392692274     |

### Icon explanation

- ▶️ = Required in runtime
- 🚀 = Required during CI/CD