Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.

Ban Module

Introduction

The Ban module allows for server staff to impose and pardon bans on players. The ban module can ban players temporarily or permanently. Any bans that are placed are put into the Minecraft ban system, so will remain if the module is disabled or Nucleus is removed.

Banning Temporarily

The syntax for the /tempban is

/tempban <player> <time> [reason]

The time parameter is of the Timespan Argument format. For example: if you want to ban Notch for 3 hours, 45 minutes, the command would be:

/tempban Notch 3h45m Banned by Nucleus

A Note on Reasons

All reasons support Minecraft Colour codes, prefixed by an &. So, for example, to make a message show up in light red, prefix it with a &c.

The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.

No plugin incompatibilities have been reported.

/ban
Module: ban
Bans a player.

Aliases: /ban

Usage: /ban <user uuid>|<user>|<name> [<reason…>]

Default Role: staff

Basic Command Permission: nucleus.ban.base

Permissions

  • nucleus.ban.notify - Default Role: staff
    Notifies the user about bans when they occur.
  • nucleus.ban.offline - Default Role: staff
    Allows the user to ban offline users.
  • nucleus.ban.base - Default Role: staff
    Allows the user to run the command /ban
  • nucleus.ban.exempt.target - Default Role: staff
    Exempts the user from being a target of the /ban command.

This command is an equivalent to the following command(s) in Essentials: /ban

/checkban
Module: ban
Checks the ban status for a player.

Aliases: /checkban

Usage: /checkban <user uuid>|<user>

Default Role: staff

Basic Command Permission: nucleus.checkban.base

Permissions

  • nucleus.checkban.base - Default Role: staff
    Allows the user to run the command /checkban
/tempban
Module: ban
Temporarily bans a player.

Aliases: /tempban

Usage: /tempban <user> <duration> [<reason…>]

Default Role: staff

Basic Command Permission: nucleus.tempban.base

Permissions

  • nucleus.tempban.offline - Default Role: staff
    Allows the user to temp ban offline users.
  • nucleus.tempban.base - Default Role: staff
    Allows the user to run the command /tempban
  • nucleus.tempban.exempt.target - Default Role: staff
    Exempts the user from being a target of the /tempban command.
  • nucleus.tempban.exempt.length - Default Role: staff
    Allows the user to bypass the maximum tempban length.

This command is an equivalent to the following command(s) in Essentials: /tempban

/unban
Module: ban
Unbans a player.

Aliases: /unban, /pardon

Usage: /unban <user uuid>|<user>

Default Role: staff

Basic Command Permission: nucleus.tempban.base

Permissions

  • nucleus.tempban.base - Default Role: staff
    Allows the user to run the command /tempban

This command is an equivalent to the following command(s) in Essentials: /unban, /pardon

Permission Suggested Role Description
nucleus.ban.base staff Allows the user to run the command /ban
nucleus.ban.exempt.target staff Exempts the user from being a target of the /ban command.
nucleus.ban.notify staff Notifies the user about bans when they occur.
nucleus.ban.offline staff Allows the user to ban offline users.
nucleus.checkban.base staff Allows the user to run the command /checkban
nucleus.tempban.base staff Allows the user to run the command /tempban
nucleus.tempban.exempt.length staff Allows the user to bypass the maximum tempban length.
nucleus.tempban.exempt.target staff Exempts the user from being a target of the /tempban command.
nucleus.tempban.offline staff Allows the user to temp ban offline users.
nucleus.unban.base staff Allows the user to run the command /unban
The following configuration is the default for this module:
                            # If "use-permission-level" is true, players can only ban/unban players that have a lower permission level than themselves.
# 
# The permission level for banning is specified by adding the "nucleus.ban.level" permission option/meta to a player. Default level is 0 for players without the specified command permission, 1 with the permission.
ban-permission-levels {
    # If true, a player can affect another player that has the same level as them (that is, if both havea permission level of 1, they can act on each other). If false, then a higher level is necessary (someone with a level 1 canonly act upon a player with level 0 or below). 
    can-affect-same-level=false
    # If true, checks player level options as specified in the parent node.
    use-permission-level=false
}
# The maximum length a temporary ban may last for (in seconds) unless the user handing the mute has a bypass permission. Set to -1 for no maximum.
maximum-tempban-length=604800

                        
Search

Downloading search database, this won't take long...