r-Overwatch2/eu.astrogd.white-leopard
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
A Discord bot that checks Discord channel names for banned words and prevents renaming of them
81 Commits 2 Branches 15 Tags 349 KiB
TypeScript 99.4%
Dockerfile 0.6%
3594c2ea8c
Go to file
AstroGD 3594c2ea8c Merge pull request 'hotfix/db-race' (#23) from hotfix/db-race into dev 
Reviewed-on: #23
2023-09-16 11:20:08 +02:00
ci Beta release 2022-11-24 21:25:41 +01:00
src Fix db race condition 2023-09-16 11:12:43 +02:00
.gitignore Base structure 2022-11-23 13:23:25 +01:00
Changelog.md Fix db race condition 2023-09-16 11:12:43 +02:00
docker-compose.yml Fix db race condition 2023-09-16 11:12:43 +02:00
Dockerfile expose api ports 2022-11-24 22:59:23 +01:00
index.ts Start api service on bot start 2022-11-24 23:06:28 +01:00
LICENSE.md Base structure 2022-11-23 13:23:25 +01:00
package-lock.json Fix db race condition 2023-09-16 11:12:43 +02:00
package.json Fix db race condition 2023-09-16 11:12:43 +02:00
README.md Format Readme 2022-11-29 19:38:18 +01:00
tsconfig.json logchannel command 2022-11-24 12:12:50 +01:00

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