Module: Ban - Module ID: ban

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.

/ban
Module: ban
Bans a player.

Aliases: ban

Root command aliases: /nban

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

Default Role: MOD

Basic Command Permission: nucleus.ban.base

Permissions

  • nucleus.ban.notify - Default Role: MOD
    Notifies the user about bans when they occur.
  • nucleus.ban.base - Default Role: MOD
    Allows the user to run the command /ban
  • nucleus.ban.offline - Default Role: MOD
    Allows the user to ban offline users.
  • nucleus.ban.exempt.target - Default Role: MOD
    Exempts the user from being a target of the /tempban 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

Root command aliases: /ncheckban

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

Default Role: MOD

Basic Command Permission: nucleus.checkban.base

Permissions

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

Aliases: tempban

Root command aliases: /ntempban

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

Default Role: MOD

Basic Command Permission: nucleus.tempban.base

Permissions

  • nucleus.tempban.offline - Default Role: MOD
    Allows the user to temp ban offline users.
  • nucleus.tempban.base - Default Role: MOD
    Allows the user to run the command /tempban
  • nucleus.tempban.exempt.target - Default Role: MOD
    Exempts the user from being a target of the /tempban command.
  • nucleus.tempban.exempt.length - Default Role: MOD
    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

Root command aliases: /nunban

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

Default Role: MOD

Basic Command Permission: nucleus.unban.base

Permissions

  • nucleus.unban.base - Default Role: MOD
    Allows the user to run the command /unban

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

Permission Suggested Role Description
nucleus.ban.base MOD Allows the user to run the command /ban
nucleus.ban.exempt.target MOD Exempts the user from being a target of the /tempban command.
nucleus.ban.notify MOD Notifies the user about bans when they occur.
nucleus.ban.offline MOD Allows the user to ban offline users.
nucleus.checkban.base MOD Allows the user to run the command /checkban
nucleus.tempban.base MOD Allows the user to run the command /tempban
nucleus.tempban.exempt.length MOD Allows the user to bypass the maximum tempban length.
nucleus.tempban.exempt.target MOD Exempts the user from being a target of the /tempban command.
nucleus.tempban.offline MOD Allows the user to temp ban offline users.
nucleus.unban.base MOD Allows the user to run the command /unban
The following configuration is the default for this module:
# 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