r-Overwatch2/eu.astrogd.white-leopard
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Update env variable documentation

Browse Source
This commit is contained in:
Lukas | AstroGD 2022-11-29 19:30:25 +01:00
parent 59429ea548
commit 173438395e
Signed by: AstroGD
GPG Key ID: 82A5E6C236C535AA
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,47 +1,61 @@
# eu.astrogd.white-leopard # eu.astrogd.white-leopard
A Discord bot that checks Discord channel names for banned words and prevents renaming of them A Discord bot that checks Discord channel names for banned words and prevents renaming of them
## Commands ## Commands
### /logchanel [channel?] `Permission: MANAGE_GUILD` ### /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. 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 `Permission: MANAGE_GUILD`
#### /blocklist get #### /blocklist get
Returns the global and server specific banned word list and returns it (Same behaviour as /showblocklist) Returns the global and server specific banned word list and returns it (Same behaviour as /showblocklist)
#### /blocklist add [word] #### /blocklist add [word]
Adds the word to the server specific blocklist Adds the word to the server specific blocklist
#### /blocklist remove [word] #### /blocklist remove [word]
Removes the word from the server specific blocklist Removes the word from the server specific blocklist
### /info `Permission: EVERYONE` ### /info `Permission: EVERYONE`
Returns general information about the bot and the servers stats Returns general information about the bot and the servers stats
### /preservesettings `Permission: ADMINISTRATOR` ### /preservesettings `Permission: ADMINISTRATOR`
Changes the behaviour when the bot leaves the server. Changes the behaviour when the bot leaves the server.
Options are: Options are:
- Keep settings persistent even if the bot leaves - Keep settings persistent even if the bot leaves
- Delete setting when the bot leaves the server [default] - Delete setting when the bot leaves the server [default]
### /showblocklist `Permission: MANAGE_CHANNELS` ### /showblocklist `Permission: MANAGE_CHANNELS`
Returns the global and server specific banned word list and returns it Returns the global and server specific banned word list and returns it
### /showsettings `Permission: MANAGE_GUILD` ### /showsettings `Permission: MANAGE_GUILD`
Returns the current settings for the server Returns the current settings for the server
## Environment variables ## Environment variables
| Name | Description | Required | Example | | Name | Description | Required | Example |
| :--------------- | :------------------------------------------------------------------------------ | :------: | :------------------ | | :--------------- | :------------------------------------------------------------------------------ | :------: | :------------------ |
| TOKEN | Discord bot token to log into the API with | ▶️/🚀 | NzYzMDP3MzE1Mzky... | | TOKEN | Discord bot token to log into the API with | ▶️/🚀 | NzYzMDP3MzE1Mzky... |
| DB_HOST | Hostname of the database | ▶️ | 127.0.0.1:3546 | | DB_HOST | Hostname of the database | ▶️ | 127.0.0.1 |
| DB_USERNAME | Username of the database | ▶️ | root | | DB_USERNAME | Username of the database | ▶️ | root |
| DB_PASSWORD | Password of the database | ▶️ | abc123 | | DB_PASSWORD | Password of the database | ▶️ | abc123 |
| DB_DATABASE | Database name | ▶️ | white-leopard | | DB_DATABASE | Database name | ▶️ | white-leopard |
| CLIENT_ID | Client ID of the Discord appication associated with the token | 🚀 | 763035392692274 | | 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_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 | | DEPLOY_CLIENT_ID | Production Client ID of the Discord appication associated with the deploy token | 🚀 | 763035392692274 |
### Icon explanation
### Icon explanation:
- ▶️ = Required in runtime - ▶️ = Required in runtime
- 🚀 = Required during CI/CD - 🚀 = Required during CI/CD