2022-11-22 18:46:05 +01:00
|
|
|
# eu.astrogd.white-leopard
|
|
|
|
|
A Discord bot that checks Discord channel names for banned words and prevents renaming of them
|
2022-11-24 02:12:52 +01:00
|
|
|
|
2022-11-24 12:29:52 +01:00
|
|
|
## Commands
|
2022-11-25 18:41:34 +01:00
|
|
|
### /logchanel [channel?] `Permission: MANAGE_GUILD`
|
2022-11-24 12:29:52 +01:00
|
|
|
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.
|
|
|
|
|
|
2022-11-25 18:41:34 +01:00
|
|
|
### /blocklist `Permission: MANAGE_GUILD`
|
2022-11-24 15:36:33 +01:00
|
|
|
#### /blocklist get
|
2022-11-25 19:28:05 +01:00
|
|
|
Returns the global and server specific banned word list and returns it (Same behaviour as /showblocklist)
|
2022-11-24 15:36:33 +01:00
|
|
|
|
|
|
|
|
#### /blocklist add [word]
|
|
|
|
|
Adds the word to the server specific blocklist
|
|
|
|
|
|
|
|
|
|
#### /blocklist remove [word]
|
|
|
|
|
Removes the word from the server specific blocklist
|
|
|
|
|
|
2022-11-25 18:41:34 +01:00
|
|
|
### /info `Permission: EVERYONE`
|
2022-11-24 18:07:29 +01:00
|
|
|
Returns general information about the bot and the servers stats
|
|
|
|
|
|
2022-11-25 18:41:34 +01:00
|
|
|
### /preservesettings `Permission: ADMINISTRATOR`
|
2022-11-25 18:30:48 +01:00
|
|
|
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]
|
|
|
|
|
|
2022-11-25 18:53:03 +01:00
|
|
|
### /showblocklist `Permission: MANAGE_CHANNELS`
|
2022-11-25 19:28:05 +01:00
|
|
|
Returns the global and server specific banned word list and returns it
|
|
|
|
|
|
|
|
|
|
### /showsettings `Permission: MANAGE_GUILD`
|
|
|
|
|
Returns the current settings for the server
|
2022-11-25 18:53:03 +01:00
|
|
|
|
2022-11-24 02:12:52 +01:00
|
|
|
## Environment variables
|
2022-11-24 21:25:41 +01:00
|
|
|
| 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:3546 |
|
|
|
|
|
| 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 |
|
2022-11-24 02:12:52 +01:00
|
|
|
|
|
|
|
|
### Icon explanation:
|
|
|
|
|
- ▶️ = Required in runtime
|
|
|
|
|
- 🚀 = Required during CI/CD
|
