NabDev/NabBot

View on GitHub
docs/commands/mod.md

Summary

Maintainability
Test Coverage
# Mod commands

Commands server moderators.

!!! info
    Parameters are enclosed with `< >`.   
    Optional parameters are enclosed in brackets `[]`.
    
## cleanup
**Syntax:** `cleanup [limit=50]`

Cleans the channel from bot commands.

If the bot has `Manage Messages` permission, it will also delete command invocation messages.

??? summary "Examples"
    **/cleanup**  
    ![image](../assets/images/commands/mod/cleanup.png)

----

## ignore
**Syntax:** `ignore [entries...]`

Makes the bot ignore a channel or user.

Commands cannot be used in ignored channels or by ignored users.

The command accepts a list of names, ids or mentions of users or channels.  
If the command is used with no parameters, it ignores the current channel.

Ignores are bypassed by users with the `Manage Server` permission.

??? Summary "Example"
    **/ignore #support #chat #feedback-and-reports #message-suggestions #levels-and-deaths Tschis**  
    ![image](../assets/images/commands/mod/ignore.png)

----

### ignore list
Shows a list of ignored channels and users.

??? Summary "Example"
    **/ignore list**  
    ![image](../assets/images/commands/mod/ignore list.png)

----

## makesay
**Syntax:** `makesay <message>`

Makes the bot say a message.

If the user using the command doesn't have mention everyone permissions, the message will be cleaned of
mass mentions.

----

## unignore
**Syntax:** `unignore [channel]`

Removes a channel or user from the ignored list.

If no parameter is provided, the current channel will be unignored.

If the command is used with no parameters, it unignores the current channel.

----

## unregistered
Shows a list of users with no registered characters.

??? Summary "Example"
    **/unregistered**  
    ![image](../assets/images/commands/mod/unregistered.png)

----

### unregistered guild <name>
Shows a list of unregistered guild members.

Unregistered guild members can be either characters not registered to NabBot or registered to users not in the server.

??? Summary "Example"
    **/unregistered guild Redd Alliance**  
    ![image](../assets/images/commands/mod/unregistered_guild.png)

----