Welcome to ModzBott Docs
Learn how to use, manage and configure ModzBott for your Discord server.
If you still need
help, join our support server here.
Useful Links
Features
Here is a list of current ModzBott features:
Frequently Asked Questions (FAQs)
The bot is offline, what do I do?
Please do not make a support ticket in the support server or ask for help, it is likely that the developers are already aware and potentially testing / uploading new features to the bot. It is also worth checking if ModzBott Experimental is online as all changes are made on that bot before publishing.
Why am I unable to unlock a channel after locking it down?
This may be because you have the manage roles permission for the server / channel but you do not have a role that allows you to send messages. This can be changed in the channel settings by setting "send messages" to ✅.
How do I add new lines on DMs, join or leave messages using commands?
To this this just use \n into the text where you would like it to wrap. For
example:
Welcome to the server!\nWe hope you have a great time!Will return:Welcome to the server!
We hope you have a great time!
Channels
Logging Channels
/logging channel set <#channel> <event> sets the channel where server logs
will be sent including message deletes, name changes, role changes and more which can be
found
here.
Join / Leave Channels
/greetings channel <event> <channel> sets the channel for join and
or
leave messages will be sent to. More info can be found here.
Configuration
Server Logging
You can configure the server logging settings either by using the dashboard or by using commands.
Supported event types:
| Event | Description |
|---|---|
ban |
Logs member bans from the server. |
kick |
Logs member kicks from the server. |
timeout |
Logs member timeouts / mutes. |
role_change |
Logs role assignment / removals. |
nickname_change |
Logs member nickname changes. |
message_delete |
Logs deleted messages. |
message_edit |
Logs edited messages. |
channel_purge |
Logs mass message deletions. |
all |
All events mentioned above. |
Logging Commands
| Command | Usage / Purpose | Permission Required |
|---|---|---|
/logging enable |
Enables logging for the server. This will create a
#modzbott-logging channel if the command has not been used before
or a default channel has not been set.
|
Manage Server |
/logging disable |
Disables logging for the server. | Manage Server |
/logging event <event> <enable|disable> |
Enable or disable a specific logging event. | Manage Server |
/logging channel <set|reset> <channel> |
Assign a custom channel to log a specific event or reset it to the default channel. | Manage Server |
/logging cases view <case (int)> |
View the details of a specific event case. This will return the ID, event, target user, moderator, reason and the timestamp. |
Manage Server |
/logging cases list |
List event cases. | Manage Server |
Join / Leave Messages
You can also configure custom join / leave messages and other settings using the dashboard or by using commands.
Events & Default Messages:
| Event | Default Message |
|---|---|
join |
Welcome to **{guild_name}, {member_mention}!** |
leave |
**{member_name}** just left {guild_name}. |
all |
Supported Parameters:
| Parameter | Description |
|---|---|
{member} |
Returns member name |
{member_id} |
Returns member ID |
{member_name} |
Returns member name, same as {member} |
{member_display} |
Returns member nickname if one exists (will show regular name if user does not have one) |
{member_mention} |
Mentions the user |
{guild_name} |
Server name |
{guild_size} |
Member count after them joining |
Greetings Commands:
| Command | Description | Permission Required |
|---|---|---|
/greetings status |
Provides information on the server config for the module. | Manage server |
/greetings enable |
Enables all join / leave messages for the server. | Manage server |
/greetings disable |
Disables all join / leave messages for the server. | Manage server |
/greetings event enable <event> |
Enables join or leave messages only. | Manage server |
/greetings event disable <event> |
Disables join or leave messages only. | Manage server |
/greetings channel <event> <channel> |
Set a channel for either join or leave messages to be posted to. | Manage server |
/greetings message preview <event> |
Preview how the join or leave message embed will appear in an active channel. | Manage server |
/greetings message reset <event> |
Reset the custom join or leave message to the default option. | Manage server |
/greetings message set <event> {text} |
Set a custom message for when member joins or leaves. This supports the placeholders mentioned above. To start a new line, type \n then continue. For example, Welcome to the server!\nWe hope you have a great time! |
Manage server |
/greetings dm enable |
Sends welcome DMs to new members. | Manage server |
/greetings dm disable |
Disables welcome DMs. | Manage server |
/greetings dm set {text} |
Set a custom message for members to recieve when they join the
server. This supports the placeholders mentioned above. To start a new line, type \n then continue. For example, Welcome to the server!\nWe hope you have a great time! |
Manage server |
/greetings dm reset |
Reset the welcome DM message to the default option. | Manage server |
/greetings dm preview |
Preview how the welcome DM will be sent to members. | Manage server |
Autoroles
Autoroles can be setup to be automatically assigned to a user when they join the server. You can either do it on the Dashboard or using commands.
Autorole Commands:
| Command | Description | Permission Required |
|---|---|---|
/greetings autorole list |
View which roles will be given to members when they join. | Manage server |
/greetings autorole add <@role1> <@role2> etc. |
Add one or more autoroles to be given to new members. | Manage server |
/greetings autorole remove <@role1> <@role2> etc. |
Remove one or more autoroles. | Manage server |
/greetings autorole clear |
Clear all autoroles for this server. | Manage server |
Moderation
Punishments
| Command | Permission Required |
|---|---|
/kick <user> [reason] |
Kick Members |
/ban <user> [reason] |
Ban Members |
Channel Purging
You can clear a channel using the purge command. Please note that you can remove a maximum of 100 messages at a time.
| Command | Permission Required |
|---|---|
/purge <messages (int)> |
Manage Messages |
Role Assign | Remove
Use this command to give or remove a role from a person.
| Command | Permission Required |
|---|---|
/role <action> <user> <@role> |
Manage Roles |
Slowmode
Set slowmode using this command.
| Command | Permission Required |
|---|---|
/slowmode <seconds (int)> |
Manage Channels |
Locking & Unlocking Channels
Lock down a channel or unlock a channel using these commands.
| Command | Permission Required |
|---|---|
/lockdown <channel> |
Manage Channels |
/unlock <channel> |
Manage Channels |
Utilities
Polls
| Command | Permission Required |
|---|---|
/poll <question> <option1> <option2> [option3] [option4]
|
Create Polls |
Server Info
Running the serverinfo command will return the server ID, server owner, member
count, number of roles, server boost level, boost count and the server creation date.
| Command | Permission Required |
|---|---|
/serverinfo |
Who Is?
Running the whois command will return the username of a user, their ID, their account creation date, the date they joined the server, their status, current activity, their badges, their highest role, a list of all their roles and when they started boosting (if they did).
| Command | Permission Required |
|---|---|
/whois <@user> |