Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.
« Return to Documentation Home Page // Administration Module

Administration Module

Introduction

This module adds provision for kicking players in a more flexible way than vanilla Minecraft can, adding the ability to add reasons to kicks, and kicking all players with the option of turning on a whitelist.

Kicking all players

Nucleus provides the command /kickall [-w] [reason] to kick all players from the server (except yourself, if you are a player executing this command). By specifying the -w flag, Nucleus will activate the whitelist at the same time, preventing your eager players from rejoining the server before you get the chance to turn it on yourself.

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.

/kick
Module: kick
Kicks a player

Aliases: /kick

Usage: /kick <player> [<reason…>]

Default Role: staff

Basic Command Permission: nucleus.kick.base

Permissions

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

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

/kickall
Module: kick
Kicks all players, optionally turning the whitelist on.

If the command is executed by a player on the server, the executing player will not be kicked. To turn the whitelist on when kicking everyone, use the "-w" flag.

Aliases: /kickall

Usage: /kickall [-w|-f <w>] [<reason…>]

Default Role: staff

Basic Command Permission: nucleus.kickall.base

Permissions

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

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

Permission Suggested Role Description
nucleus.kick.base staff Allows the user to run the command /kick
nucleus.kick.exempt.target staff Exempts the user from being a target of the /kick command.
nucleus.kick.notify staff Notifies the user about kicks when they occur.
nucleus.kickall.base staff Allows the user to run the command /kickall
nucleus.kickall.whitelist admin Allows the user to turn the whitelist on when kicking all players.
The following configuration is the default for this module:
                            # If "use-permission-level" is true, players can only kick players that have a lower permission level than themselves.
# 
# The permission level for kicking is specified by adding the "nucleus.kick.level" permission option/meta to a player. Default level is 0 for players without the specified command permission, 1 with the permission.
# 
# This does not affect /kickall.
kick-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
}

                        
Search

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