Nucleus is no longer updated and this site is frozen in time. Some links may be broken.
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

The Administration Module contains commands that are designed to be used by server owners and administrators.

Not all administrative commands are contained in the admin module, some have their own modules:

Broadcasts

Broadcasts are now in the Notifications Module

/gamemode extra permissions

As well as the standard permissions, /gm command requires an extra permission to change to the target gamemode - the permission is of the form nucleus.gamemode.modes.<gamemode>. To allow someone to switch to all gamemodes, give them the permission nucleus.gamemode.modes.

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.

/blockzap
Module: admin
Sets the target block to air.

Intended as an admin command to turn a problematic block to air.

Aliases: /blockzap, /zapblock

Usage: /blockzap <location>

Default Role: ADMIN

Basic Command Permission: nucleus.blockzap.base

Permissions

  • nucleus.blockzap.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /blockzap
  • nucleus.blockzap.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /blockzap
  • nucleus.blockzap.base - Default Role: ADMIN
    Allows the user to run the command /blockzap
  • nucleus.blockzap.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /blockzap

This command is similar to the following command(s) found in Essentials: /break

Essentials Migration Notes: Requires co-ordinates, whereas Essentials required you to look at the block.

/gamemode
Module: admin
Sets a player's game mode.

Aliases: /gamemode, /gm

Usage: /gamemode <player> game mode|game mode|

Default Role: ADMIN

Basic Command Permission: nucleus.gamemode.base

Permissions

  • nucleus.gamemode.modes.spectator - Default Role: ADMIN
    Allows the user to change a target's gamemode to spectator.
  • nucleus.gamemode.modes.survival - Default Role: ADMIN
    Allows the user to change a target's gamemode to survival.
  • nucleus.gamemode.base - Default Role: ADMIN
    Allows the user to run the command /gamemode
  • nucleus.gamemode.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /gamemode
  • nucleus.gamemode.modes.creative - Default Role: ADMIN
    Allows the user to change a target's gamemode to creative.
  • nucleus.gamemode.modes.adventure - Default Role: ADMIN
    Allows the user to change a target's gamemode to adventure.
  • nucleus.gamemode.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /gamemode
  • nucleus.gamemode.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /gamemode
  • nucleus.gamemode.others - Default Role: ADMIN
    Allows the user to change the gamemode for any user.

This command is similar to the following command(s) found in Essentials: /gamemode, /gm

Essentials Migration Notes: /gm does not toggle between survival and creative, use /gmt for that

/gamemode gmt
Module: admin
Toggles your game mode between survival and creative.

Aliases: /gamemode gmt

Usage: /gamemode gmt

Default Role: ADMIN

Basic Command Permission: nucleus.gamemode.base

Permissions

  • nucleus.gamemode.modes.spectator - Default Role: ADMIN
    Allows the user to change a target's gamemode to spectator.
  • nucleus.gamemode.base - Default Role: ADMIN
    Allows the user to run the command /gamemode
  • nucleus.gamemode.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /gamemode
  • nucleus.gamemode.modes.creative - Default Role: ADMIN
    Allows the user to change a target's gamemode to creative.
  • nucleus.gamemode.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /gamemode
  • nucleus.gamemode.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /gamemode

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

/gma
Module: admin
Toggles your game mode to adventure.

Aliases: /gma, /adventure

Usage: /gma

Default Role: ADMIN

Basic Command Permission: nucleus.gamemode.base

Permissions

  • nucleus.gamemode.base - Default Role: ADMIN
    Allows the user to run the command /gamemode
  • nucleus.gamemode.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /gamemode
  • nucleus.gamemode.modes.adventure - Default Role: ADMIN
    Allows the user to change a target's gamemode to adventure.
  • nucleus.gamemode.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /gamemode
  • nucleus.gamemode.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /gamemode

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

/gmc
Module: admin
Toggles your game mode to creative.

Aliases: /gmc, /creative

Usage: /gmc

Default Role: ADMIN

Basic Command Permission: nucleus.gamemode.base

Permissions

  • nucleus.gamemode.base - Default Role: ADMIN
    Allows the user to run the command /gamemode
  • nucleus.gamemode.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /gamemode
  • nucleus.gamemode.modes.creative - Default Role: ADMIN
    Allows the user to change a target's gamemode to creative.
  • nucleus.gamemode.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /gamemode
  • nucleus.gamemode.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /gamemode

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

/gms
Module: admin
Toggles your game mode to survival.

Aliases: /gms, /survival

Usage: /gms

Default Role: ADMIN

Basic Command Permission: nucleus.gamemode.base

Permissions

  • nucleus.gamemode.modes.survival - Default Role: ADMIN
    Allows the user to change a target's gamemode to survival.
  • nucleus.gamemode.base - Default Role: ADMIN
    Allows the user to run the command /gamemode
  • nucleus.gamemode.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /gamemode
  • nucleus.gamemode.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /gamemode
  • nucleus.gamemode.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /gamemode

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

/gmsp
Module: admin
Toggles your game mode to spectator.

Aliases: /gmsp, /spectator

Usage: /gmsp

Default Role: ADMIN

Basic Command Permission: nucleus.gamemode.base

Permissions

  • nucleus.gamemode.modes.spectator - Default Role: ADMIN
    Allows the user to change a target's gamemode to spectator.
  • nucleus.gamemode.base - Default Role: ADMIN
    Allows the user to run the command /gamemode
  • nucleus.gamemode.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /gamemode
  • nucleus.gamemode.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /gamemode
  • nucleus.gamemode.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /gamemode
/kill
Module: admin
Kill the specified player(s) and/or entities.

Aliases: /kill

Usage: /kill <subject>

Default Role: ADMIN

Basic Command Permission: nucleus.kill.base

Permissions

  • nucleus.kill.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /kill
  • nucleus.kill.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /kill
  • nucleus.kill.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /kill
  • nucleus.kill.base - Default Role: ADMIN
    Allows the user to run the command /kill

This command is similar to the following command(s) found in Essentials: /kill, /remove, /butcher, /killall, /mobkill

Essentials Migration Notes: Nucleus supports killing entities using the Minecraft selectors.

/killentity
Module: admin
Kills the specified entities.

The entities that can be killed are:

- "armorstand"
- "monster"/"hostile"
- "passive"/"animal"
- "player"
- "item"

Multiple types can be selected at once. A world can be specified using -w, *or* a radius can be specified using -r. Both are optional.

Aliases: /killentity

Usage: /killentity [-r <r>] [-w <w>] <type>*

Default Role: ADMIN

Basic Command Permission: nucleus.killentity.base

Permissions

  • nucleus.killentity.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /killentity
  • nucleus.killentity.base - Default Role: ADMIN
    Allows the user to run the command /killentity
  • nucleus.killentity.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /killentity
  • nucleus.killentity.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /killentity
/stop
Module: admin
Stops the server.

Aliases: /stop

Usage: /stop [<message…>]

Default Role: ADMIN

Basic Command Permission: nucleus.stop.base

Permissions

  • nucleus.stop.base - Default Role: ADMIN
    Allows the user to run the command /stop
/sudo
Module: admin
Forces a player to run a command.

Aliases: /sudo

Usage: /sudo <player> <command…>

Default Role: ADMIN

Basic Command Permission: nucleus.sudo.base

Permissions

  • nucleus.sudo.base - Default Role: ADMIN
    Allows the user to run the command /sudo

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

/tellplain
Module: admin
Allows the user to send a message to a player without prefixes or suffixes.

This command is similar to Minecraft's /tellraw, but allows for Nucleus tokens and ampersand formatting.

Aliases: /tellplain, /plaintell, /ptell

Usage: /tellplain <player|-> <message…>

Default Role: ADMIN

Basic Command Permission: nucleus.tellplain.base

Permissions

  • nucleus.tellplain.base - Default Role: ADMIN
    Allows the user to run the command /tellplain
Permission Suggested Role Description
nucleus.blockzap.base ADMIN Allows the user to run the command /blockzap
nucleus.blockzap.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /blockzap
nucleus.blockzap.exempt.cost ADMIN Allows the user to bypass the cost for /blockzap
nucleus.blockzap.exempt.warmup ADMIN Allows the user to bypass the warmup for /blockzap
nucleus.gamemode.base ADMIN Allows the user to run the command /gamemode
nucleus.gamemode.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /gamemode
nucleus.gamemode.exempt.cost ADMIN Allows the user to bypass the cost for /gamemode
nucleus.gamemode.exempt.warmup ADMIN Allows the user to bypass the warmup for /gamemode
nucleus.gamemode.modes.adventure ADMIN Allows the user to change a target's gamemode to adventure.
nucleus.gamemode.modes.creative ADMIN Allows the user to change a target's gamemode to creative.
nucleus.gamemode.modes.spectator ADMIN Allows the user to change a target's gamemode to spectator.
nucleus.gamemode.modes.survival ADMIN Allows the user to change a target's gamemode to survival.
nucleus.gamemode.others ADMIN Allows the user to change the gamemode for any user.
nucleus.kill.base ADMIN Allows the user to run the command /kill
nucleus.kill.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /kill
nucleus.kill.exempt.cost ADMIN Allows the user to bypass the cost for /kill
nucleus.kill.exempt.warmup ADMIN Allows the user to bypass the warmup for /kill
nucleus.killentity.base ADMIN Allows the user to run the command /killentity
nucleus.killentity.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /killentity
nucleus.killentity.exempt.cost ADMIN Allows the user to bypass the cost for /killentity
nucleus.killentity.exempt.warmup ADMIN Allows the user to bypass the warmup for /killentity
nucleus.stop.base ADMIN Allows the user to run the command /stop
nucleus.sudo.base ADMIN Allows the user to run the command /sudo
nucleus.sudo.exempt.target ADMIN Exempts the user from being a target of the /sudo command.
nucleus.tellplain.base ADMIN Allows the user to run the command /tellplain
The following configuration is the default for this module:
                            # If "use-permission-level" is true, players can only use sudo upon players that have a lower permission level than themselves.
# 
# The permission level for sudo is specified by adding the "nucleus.sudo.level" permission option/meta to a player. Default level is 0 for players without the specified command permission, 1 with the permission.
sudo-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...