Skip to content

ivozzo/jailor-discord-bot

Repository files navigation

jailor-discord-bot

Discord bot

This is a discord bot which will help you manage your community. As the name implies it will reach users who does not respect your server rules and warning them (or soft banning in case of recidivist behaviour)

Commands

The bot will answer to these commands:

Command Description
j! help Will show a help message that will list the bot commands
j! config Will show a configuration recap
j! config Will update a configuration to the passed value
j! warn Will warn an user sending him a DM with the reason and giving them the warning role (if configured)
j! mute Will mute an user sending him a DM with the reason and giving them the mute role (if configured)
J! unmute Will revoke the muting directive and remove the mute role from the user

A second warning on the same user will automatically transform into a mute command.

Configuration

So far you can customize these configurations for you discord server:

Prefix Description
role <@role> Specify the role the bot will listen to when searching for commands
command_prefix Change the command prefix (defaults to j!)
command_channel <#channel> Specify the channel the bot will listen to (defaults to every channel the bot role can read)
warning_role <@role> Specify the warning role the bot will assign to warned users
mute_role <@role> Specify the mute role the bot will assign to muted users
warning_role_timer Specify the duration of the warning role assignement (defaults to 24)
mute_role_timer Specify the duration of the mute role assignement (defaults to 48)

FAQ

I want to invite this bot to my server

Easy peasy, just click here and follow the procedure for inviting the bot!

Do I have to save some environment variables for the bot to function?

Absolutely, here's the required environment variables (or saved into a .env file):

Variable Description
JAILOR_DISCORD_TOKEN Discord token (obtained through Discord Developer Portal)
JAILOR_LOGGING_LEVEL Logging level [WARN, ERROR, INFO, DEBUG]
JAILOR_DATABASE_HOST MongoDB connection string (it should be something like mongodb://\[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]] )
JAILOR_DATABASE MongoDB database name
JAILOR_DATABASE_USER Self explanatory
JAILOR_DATABASE_PASSWORD Self explanatory

Special Thanks

I'd like to thank the Stadia Italia community for helping me test this bot and of course, giving me a caring home for my gaming sessions!

I'd also like to thank Deps Design for the awesome bot avatar! Run check her portfolio!

About

A Discord bot for moderating your community (yes, another one!)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages