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.

Features

Here is a list of current ModzBott features:

                            
  • Server Logging
    • 
                            
  • Welcome / Leave Messages
    • 
                            
  • Moderation Commands
    • 
                            
  • Web Dashboard
    •

    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.

    !
    All logging commands require the user AND the bot to have the Manage Server permission. Users who do not have this permission will not be able to use it.

    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.
    channel_create Logs all channel creations.
    channel_delete Logs all channel deletions.
    channel_perm_update Logs updates to channel permissions.
    channel_update Logs updates to channel names, category changes.
    category_create Logs all category creations.
    category_delete Logs all category deletions.
    category_update Logs all category name changes.
    message_pin Logs new pinned messages.
    message_unpin Logs messages that are unpinned.
    role_create Logs all role creations.
    role_delete Logs all role deletions.
    role_update Logs all role updates (color change, name change).
    role_perm_update Logs all role permission updates.
    voice_mute Logs all moderator actioned VC mutes.
    voice_unmute Logs all VC unmutes.
    voice_deafen Logs all moderator actioned VC defeans.
    voice_undeafen Logs all VC undeafens.
    guild_update Logs all guild updates (name changes, icon updatee).
    emoji_create Logs all emoji creations.
    emoji_delete Logs all emoji deletions.
    emoji_update Logs all emoji updates (name change).
    sticker_create Logs all sticker creations.
    sticker_delete Logs all sticker deletions.
    sticker_update Logs all sticker updates (name, emoji, description).
    automod_censor Censored messages deleted by AutoMod.
    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> <channel> Assign a different channel for certain logs to be sent in Manage Server
    /logging channel <reset> <event> Reset the logging channel for certain events 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 all 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.

    !
    All greetings commands require the user AND the bot to have the Manage Server permission. Users who do not have this permission will not be able to use it.

    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 config information for the join & leave messages Manage server
    /greetings enable Enables all join & leave messages. Manage server
    /greetings disable Disables all join & leave messages. 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 join or leave messages. Manage server
    /greetings message preview <event> Preview how the join or leave message will appear in a channel. Manage server
    /greetings message reset <event> Reset a custom message to the default option. Manage server
    /greetings message set <event> {text} Set a custom message for join or leave events.
    This supports the placeholders mentioned above.
    To start a new line, use \n.
    For example, Welcome to the server!\nWe hope you have a great time!    		 Manage server
    /greetings dm enable Enable welcome DMs. Manage server
    /greetings dm disable Disables welcome DMs. Manage server
    /greetings dm set {text} Set a custom welcome DM message.
    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 appear in a user inbox. 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.

    !
    All autorole commands require the user AND the bot to have the Manage Server permission. Users who do not have this permission will not be able to use it.

    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 roles to be given to new members. Manage server
    /greetings autorole remove <@role1> <@role2> etc. Remove one or more autoroles. Manage server
    /greetings autorole clear Removes all autoroles and stops assigning roles to new members. Manage server

    Reaction Roles

    Enable reaction roles, allowing members to react to a certain message and gain or remove roles.

    !
    All reaction role commands require the user to have the manage server permission.
    Please note, the bot can only assign roles that are lower than its own role in the role hierarchy.
    i
    When using the /reactroles create and /reactroles edit commands, if you require a new line, please use \n.

    For example:
    Hello, please choose which roles you would like:\n\n ...
    Command Description Format Permission Required
    /reactroles create <title> <description> [color] Create a new reaction role embed. Manage Server
    /reactroles add <message_id> <emoji:role> Add one or more reaction roles to a reaction role embed. 😀: @Member 🎮: @Gamer Manage Server
    /reactroles remove <message_id> <emojis> Remove one or more reaction roles from an embed and remove the reaction(s). 😀 🎮 🎨 Manage Server
    /reactroles list <message_id> List all reaction roles added to a reaction role embed. Manage Server
    /reactroles edit <message_id> [title] [description] [color] Edit the title, description, or color of a reaction role panel embed. Manage Server
    /reactroles clearroles <message_id> Remove all reaction roles from an embed and clear all reactions. Manage Server
    /reactroles delete <message_id> Delete a reaction role embed. Manage Server
    /reactroles panels List all active reaction role embeds in the server. Manage Server
    /reactroles show <message_id> Show information about a reaction role embed. Manage Server

    AutoMod

    The AutoMod feature contains plenty of features including channel censoring and more!

    !
    Please note, the AutoMod feature is still in heavy development.
    Please report any bugs in the Support Server
    i
    If the censoring module is enabled, the bot will filter server-wide banned words in all channels by default. However, if a channel has its own custom word list, the bot will only filter the words specified for that channel.

    Channel Censoring

    Command Description Permission Required
    /automod censor status View automod censoring status and information. Manage Server
    /automod censor list [channel] List censored words either server-wide or in a specific channel. Manage Server
    /automod censor enable [channel] Enable automod censoring in a channel or server-wide. Manage Server
    /automod censor disable [channel] Disable automod censoring in a channel or server-wide. Manage Server
    /automod censor add <words> [channel] Add censored word(s).
    To add multiple words, separate words with commas (,)    		 Manage Server
    /automod censor remove <words> [channel] Remove censored word(s).
    To remove multiple words, separate words with commas (,)    		 Manage Server
    /automod censor addbypass <@role> Add a role to bypass word censoring. Manage Server
    /automod censor removebypass <@role> Remove role bypass. Manage Server

    Command Toggling & Restricting

    i
    These commands cannot be toggled or restricted: /help, /invite, /support

    Toggling a command will enable or disable it for all users. Users who have administrator permissions will also be unable to use disabled commands.
    When you add channel(s), the command will only work in those channel(s). Having no channels specified will allow the command to work everywhere.
    The same rule applies to roles, if no roles are specified, all users will be able to use the command. If role(s) are specified, only users with those role(s) will be able to use the command.

    Command Description Permission Required
    /commands disable <command> Disables a parent command or one specific command Manage Server
    /commands info <command> Show detailed config info for one command Manage Server
    /commands summary Shows an overview of command configurations Manage Server
    /commands enable <command> Enables a parent command or one specific command Manage Server
    /commands channel add <command> <#channel> Whitelist a channel for a command Manage Server
    /commands role add <command> <@role> Whitelist a role for a command Manage Server
    /commands reset <command> Reset a command or all command configurations Manage Server
    /commands channel remove <command> <#channel> Remove a channel from a command whitelist Manage Server
    /commands role remove <command> <@role> Remove a role from a command whitelist Manage Server
    /commands channel clear <command> Clear all channels from a command whitelist Manage Server
    /commands role clear <command> Clear all roles from a command whitelist 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

    i
    The poll command requires a question and a minimum of 2 answers. You can do up to 10 options but only 2 are required.
    Command Permission Required
    /poll <question> <option1> <option2> [option3] [option4] etc. 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>

    Embed Builder

    The embed builder is currently in development and will be available soon.

    !
    Make sure that you click "Save Changes" when you are finished making changes. If you close the page without doing so, you will lose any unsaved changes.

    Web Dashboard

    Greetings & Welcome DMs

    Start off by making sure the module is enabled. If the module is disabled, you won't be able to change anything.

    Enabling the Greetings Module

    Setting a Custom Message / Welcome DM

    To set a custom message or welcome DM, use the text boxes. If nothing is entered, the bot will use the default option. You can use formatting such as asterisks and underlines alongside placeholders to specify member info or server info.

    Setting a custom message in the text boxes.

    Choosing a Channel for Messages To Post In

    Select a channel you would like join & leave messages to post into by using the channel selectors. No messages will be sent until you specify either the default channel or specific channels.

    Setting a channel for join / leave messages

    Setting a Custom Welcome DM

    i
    If the user has their private messages disabled, the bot will not be able to send a private message when they join.

    Set a custom welcome DM by using the textbox. Similar to the join and leave messages, if no message is specified, the default option will be used.

    Setting a welcome DM

    Configuring Autoroles

    Having autoroles configured will give members role(s) automatically when they join the server. Configure these by selecting which roles you would like to assign from the dropdown menu. To remove an autorole, hover over the role and click the red X.

    Setting autoroles Removing an autorole

    Server Logging

    Enabling the module for the first time will create a new channel called #modzbott-logging unless you specify a default channel beforehand. Once the module is enabled, all events will be monitored and logged until disabled.

    Toggling the Module / Individual Events

    To toggle the entire module, use the toggle labelled "Enable Logging". If you wish to toggle specific logs, you can use the toggles in the list.

    Toggling the module and or specific logs.

    Setting Channels for Events

    Similar to the join / leave messages, you can select channels for certain log types with the channel selectors.

    Setting log channel for events

    Reaction Roles

    Build embeds which can have reactions attached to them. When a user reacts, they will gain the role associated with the emoji. When they remove their reaction, they will lose the role again.

    Creating a Reaction Role Panel

    Click the "+ Create Panel" button and fill in the details in the popup. You can set the channel, color, title and description of the embed. Alongside using colons for emojis, there is also an emoji picker. Click the emoji in the corner of the text box to use it.

    Once you have created your embed, give it a check over using the embed preview section at the bottom. When you are ready, click the "Save Panel" button and the bot will send the embed to the Discord channel.

    Create panel button Create embed popup Save Panel Button

    Adding Reactions to an Embed

    Once you have created your panel, click the "Roles" button to select which reactions and roles you would like to add to the embed. Once you are finished, click "Save Roles".

    !
    You can have multiple reactions attached to the same role however all emojis must be different.
    Add roles to embed button Add roles to embed menu

    Editing an Embed

    Editing an embed is very similar to creating an embed. Click "Edit" and make your changes. Once you click "Save Panel", the bot will automatically make the changes to the original embed. To edit roles, click the "Roles" button, make the changes you need and click "Save Roles". The bot will also automatically update the reactions.

    Edit panel button Editing panel menu

    Deleting an Embed

    Click "Delete" to delete an embed. When you delete an embed, the bot will delete the embed from Discord too. Your browser will confirm whether you want to delete the panel, click "Ok".

    Delete panel button Confirming embed deletion

    AutoMod

    Channel & Server Censoring

    i
    If the censoring module is enabled, the bot will filter server-wide banned words in all channels by default. However, if a channel has its own custom word list, the bot will only filter the words specified for that channel.

    You have the option to censor words throughout the entire server, in specific channels and allow certain roles and channels to not be censored.

    Toggling Censoring

    For toggling the censoring module, use the "Enable Censoring" toggle. When the module is enabled, you can then choose to toggle censoring for individual channels. To do this, use the toggles next to each channel.

    Toggling the censoring module Toggling censoring in specific channels

    Server Levelling

    Server levelling is currently in development and will be available soon.

    Custom Commands

    Custom Commands are currently in development and will be available soon.

    Embed Builder

    The embed builder is currently in development and will be available soon.

    Command Toggling & Restricting

    i
    These commands cannot be toggled or restricted: /help, /invite, /support

    Toggling a Command

    Toggling a command will enable or disable it for all users. Users who have administrator permissions will also be unable to use disabled commands. Use the toggle next to the command to disable it entirely.

    Toggling a command

    Restricting a Command

    Clicking the cog icon next to the command will open a menu where you can set which channels the command will work in and which roles are allowed. When you set channel(s), the command will only work in those channels. When you set a role, only users with that role can use the command.

    Click "Add Channel" to add a channel for the command to work in. You can add as many channels as you like. Click remove to remove a channel. When you add channel(s), the command will work only in those channel(s). Command cog Add Whitelist Channel Selecting a channel

    To add role(s), click "Add roles..." and select which roles you want to allow command usage. To remove a role, hover or click on the role, and click the X that appears. Adding a role