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 // Item Module
Permission plugin commands are provided as-is and do not imply endorsement.

Item Module

Introduction

The Item module allows you to manipulate items.

Item Names & Lore

Setting Item Names

The /itemname command affects the item currently in your hand, and has two subcommands, set and clear. Using /itemname set [name], a name can be applied to the item, which supports minecraft colour codes prefixed with an ampersand (&). This name can be removed using /itemname clear.

Setting Lore

Multiple lines of lore is supported. To do this, we have three subcommands for /lore, set, add and clear.

  • /lore set [message] removes all the old lore from the item in your hand, and sets it to the message provided.
  • /lore add [message] adds the message as a new line to the lore.
  • /lore clear removes all the lore from the item.

Again, for the lore, colour codes are supported.

Enchantments

Enchantments can be added to the item in your hand by using the command /enchant [enchant] [level]. If you use this command and it would involve removing a current enchantment, add the flag -o. If you are trying to force an enchantment or enchantment level onto an item which is not normally allowed (often referred to as “unsafe”), add the flag -u, though this requires an extra permission (nucleus.enchant.unsafe).

Repair

Nucleus can be used to repair items in a player’s inventory using /repair. By default, /repair will only target the item held in a player’s main hand. By using and combining the available flag arguments, specific inventory locations or the entire inventory can be repaired.

Flag Arguments

  • /repair -m repairs the player’s main hand (default behaviour).
  • /repair -a repairs the player’s entire inventory.
  • /repair -h repairs the player’s hotbar.
  • /repair -o repairs the player’s off hand.
  • /repair -e repairs the player’s worn equipment (armour).

Repair also supports a configurable blacklist/whitelist.

Other

Nucleus also allows users to turn the item in their hand into a full stack using /more

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.

/enchant
Module: item
Allows the user to enchant items.

Aliases: /enchant, /enchantment

Usage: /enchant <enchantment> level(0 to 32767) [-u|--unsafe <u>] [-o|--overwrite <o>]

Default Role: ADMIN

Basic Command Permission: nucleus.enchant.base

Permissions

  • nucleus.enchant.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /enchant
  • nucleus.enchant.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /enchant
  • nucleus.enchant.base - Default Role: ADMIN
    Allows the user to run the command /enchant
  • nucleus.enchant.unsafe - Default Role: ADMIN
    Allows setting enchantments and levels that are not ordinarily available to the held item.
  • nucleus.enchant.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /enchant

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

/itemname
Module: item
Base command for Item Name related actions.

Aliases: /itemname

Usage: /itemname

Default Role: ADMIN

Basic Command Permission: nucleus.itemname.base

Permissions

  • nucleus.itemname.base - Default Role: ADMIN
    Allows the user to run the command /itemname
/itemname clear
Module: item
Clears the name assigned to the item currently in the player's hand.

Aliases: /itemname clear

Root command aliases: /clearitemname /nclearitemname /resetitemname /nresetitemname

Usage: /itemname clear

Default Role: ADMIN

Basic Command Permission: nucleus.itemname.clear.base

Permissions

  • nucleus.itemname.clear.base - Default Role: ADMIN
    Allows the user to run the command /itemname clear
  • nucleus.itemname.clear.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /itemname clear
  • nucleus.itemname.clear.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /itemname clear
  • nucleus.itemname.clear.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /itemname clear
/itemname set
Module: item
Sets the user facing name for the item currently in the player's hand.

Aliases: /itemname set

Root command aliases: /setitemname /nsetitemname /renameitem /nrenameitem

Usage: /itemname set <name…>

Default Role: ADMIN

Basic Command Permission: nucleus.itemname.set.base

Permissions

  • nucleus.itemname.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /itemname set
  • nucleus.itemname.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /itemname set
  • nucleus.itemname.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /itemname set
  • nucleus.itemname.set.base - Default Role: ADMIN
    Allows the user to run the command /itemname set
/lore
Module: item
Base command for Lore related actions.

Aliases: /lore

Usage: /lore

Default Role: ADMIN

Basic Command Permission: nucleus.lore.base

Permissions

  • nucleus.lore.base - Default Role: ADMIN
    Allows the user to run the command /lore
/lore add
Module: item
Adds a new line to the lore on the current item in the hand.

Aliases: /lore add

Usage: /lore add <lore…>

Default Role: ADMIN

Basic Command Permission: nucleus.lore.set.base

Permissions

  • nucleus.lore.set.base - Default Role: ADMIN
    Allows the user to run the command /lore insert
  • nucleus.lore.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /lore insert
  • nucleus.lore.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /lore insert
  • nucleus.lore.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /lore insert
/lore clear
Module: item
Clears the lore on the current item in the hand.

Aliases: /lore clear

Usage: /lore clear

Default Role: ADMIN

Basic Command Permission: nucleus.lore.set.base

Permissions

  • nucleus.lore.set.base - Default Role: ADMIN
    Allows the user to run the command /lore insert
  • nucleus.lore.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /lore insert
  • nucleus.lore.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /lore insert
  • nucleus.lore.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /lore insert
/lore delete
Module: item
Deletes a line of the lore on the current item in the hand at a specific line.

Aliases: /lore delete

Usage: /lore delete <line>

Default Role: ADMIN

Basic Command Permission: nucleus.lore.set.base

Permissions

  • nucleus.lore.set.base - Default Role: ADMIN
    Allows the user to run the command /lore insert
  • nucleus.lore.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /lore insert
  • nucleus.lore.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /lore insert
  • nucleus.lore.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /lore insert
/lore edit
Module: item
Edits the lore on the current item in the hand at a specific line.

Aliases: /lore edit

Usage: /lore edit <line> <lore…>

Default Role: ADMIN

Basic Command Permission: nucleus.lore.set.base

Permissions

  • nucleus.lore.set.base - Default Role: ADMIN
    Allows the user to run the command /lore insert
  • nucleus.lore.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /lore insert
  • nucleus.lore.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /lore insert
  • nucleus.lore.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /lore insert
/lore insert
Module: item
Inserts a new line to the lore on the current item in the hand at a specific line.

Aliases: /lore insert

Usage: /lore insert <line> <lore…>

Default Role: ADMIN

Basic Command Permission: nucleus.lore.set.base

Permissions

  • nucleus.lore.set.base - Default Role: ADMIN
    Allows the user to run the command /lore insert
  • nucleus.lore.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /lore insert
  • nucleus.lore.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /lore insert
  • nucleus.lore.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /lore insert
/lore set
Module: item
Sets the lore on the current item in the hand. The current lore is replaced.

Aliases: /lore set

Usage: /lore set <lore…>

Default Role: ADMIN

Basic Command Permission: nucleus.lore.set.base

Permissions

  • nucleus.lore.set.base - Default Role: ADMIN
    Allows the user to run the command /lore insert
  • nucleus.lore.set.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /lore insert
  • nucleus.lore.set.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /lore insert
  • nucleus.lore.set.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /lore insert
/more
Module: item
Sets item in hand to a full stack.

Aliases: /more, /stack

Usage: /more

Default Role: ADMIN

Basic Command Permission: nucleus.more.base

Permissions

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

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

/repair
Module: item
Repairs item in hand.

Aliases: /repair, /mend, /fix

Usage: /repair [-a|--all <a>] [-o|--offhand <o>] [-m|--mainhand <m>] [-h|--hotbar <h>] [-e|--equip <e>]

Default Role: ADMIN

Basic Command Permission: nucleus.repair.base

Permissions

  • nucleus.repair.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /repair
  • nucleus.repair.base - Default Role: ADMIN
    Allows the user to run the command /repair
  • nucleus.repair.others - Default Role: ADMIN
    Allows the user to target other players using the command "repair".
  • nucleus.repair.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /repair
  • nucleus.repair.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /repair

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

/showitemattributes
Module: item
Shows or hides item attributes on item hover.

Aliases: /showitemattributes, /showattributes

Usage: /showitemattributes [<true|false>]

Default Role: ADMIN

Basic Command Permission: nucleus.showitemattributes.base

Permissions

  • nucleus.showitemattributes.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /showitemattributes
  • nucleus.showitemattributes.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /showitemattributes
  • nucleus.showitemattributes.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /showitemattributes
  • nucleus.showitemattributes.base - Default Role: ADMIN
    Allows the user to run the command /showitemattributes
/skull
Module: item
Spawns in copies of the specified player's skull (or your own, if no player is specified) into your inventory.

Aliases: /skull

Usage: /skull [<user>] [<amount>]

Default Role: ADMIN

Basic Command Permission: nucleus.skull.base

Permissions

  • nucleus.skull.others - Default Role: ADMIN
    Allows the user to target other players using the command "skull".
  • nucleus.skull.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /skull
  • nucleus.skull.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /skull
  • nucleus.skull.base - Default Role: ADMIN
    Allows the user to run the command /skull
  • nucleus.skull.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /skull

This command is an equivalent to the following command(s) in Essentials: /skull, /playerskull, /head

/trash
Module: item
Opens an inventory window which acts as a disposal unit, deleting items placed into it.

Aliases: /trash

Usage: /trash

Default Role: USER

Basic Command Permission: nucleus.trash.base

Permissions

  • nucleus.trash.base - Default Role: USER
    Allows the user to run the command /trash
  • nucleus.trash.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /trash
  • nucleus.trash.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /trash
  • nucleus.trash.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /trash
/unsignbook
Module: item
Makes the book in the target player's hand writable again.

Aliases: /unsignbook, /unsign

Usage: /unsignbook [<player>]

Default Role: ADMIN

Basic Command Permission: nucleus.unsignbook.base

Permissions

  • nucleus.unsignbook.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /unsignbook
  • nucleus.unsignbook.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /unsignbook
  • nucleus.unsignbook.others - Default Role: ADMIN
    Allows the user to target other players using the command "unsignbook".
  • nucleus.unsignbook.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /unsignbook
  • nucleus.unsignbook.base - Default Role: ADMIN
    Allows the user to run the command /unsignbook
Permission Suggested Role Description
nucleus.enchant.base ADMIN Allows the user to run the command /enchant
nucleus.enchant.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /enchant
nucleus.enchant.exempt.cost ADMIN Allows the user to bypass the cost for /enchant
nucleus.enchant.exempt.warmup ADMIN Allows the user to bypass the warmup for /enchant
nucleus.enchant.unsafe ADMIN Allows setting enchantments and levels that are not ordinarily available to the held item.
nucleus.itemname.base ADMIN Allows the user to run the command /itemname
nucleus.itemname.clear.base ADMIN Allows the user to run the command /itemname clear
nucleus.itemname.clear.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /itemname clear
nucleus.itemname.clear.exempt.cost ADMIN Allows the user to bypass the cost for /itemname clear
nucleus.itemname.clear.exempt.warmup ADMIN Allows the user to bypass the warmup for /itemname clear
nucleus.itemname.set.base ADMIN Allows the user to run the command /itemname set
nucleus.itemname.set.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /itemname set
nucleus.itemname.set.exempt.cost ADMIN Allows the user to bypass the cost for /itemname set
nucleus.itemname.set.exempt.warmup ADMIN Allows the user to bypass the warmup for /itemname set
nucleus.lore.base ADMIN Allows the user to run the command /lore
nucleus.lore.set.base ADMIN Allows the user to run the command /lore insert
nucleus.lore.set.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /lore insert
nucleus.lore.set.exempt.cost ADMIN Allows the user to bypass the cost for /lore insert
nucleus.lore.set.exempt.warmup ADMIN Allows the user to bypass the warmup for /lore insert
nucleus.more.base ADMIN Allows the user to run the command /more
nucleus.more.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /more
nucleus.more.exempt.cost ADMIN Allows the user to bypass the cost for /more
nucleus.more.exempt.warmup ADMIN Allows the user to bypass the warmup for /more
nucleus.repair.base ADMIN Allows the user to run the command /repair
nucleus.repair.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /repair
nucleus.repair.exempt.cost ADMIN Allows the user to bypass the cost for /repair
nucleus.repair.exempt.restriction ADMIN Allows the user to bypass any repair restriction specified in the config.
nucleus.repair.exempt.warmup ADMIN Allows the user to bypass the warmup for /repair
nucleus.repair.flag.all ADMIN Allows the user to repair a player's entire inventory.
nucleus.repair.flag.equip ADMIN Allows the user to repair a player's entire equip.
nucleus.repair.flag.hotbar ADMIN Allows the user to repair a player's entire hotbar.
nucleus.repair.flag.offhand ADMIN Allows the user to repair a player's entire offhand.
nucleus.repair.others ADMIN Allows the user to target other players using the command "repair".
nucleus.showitemattributes.base ADMIN Allows the user to run the command /showitemattributes
nucleus.showitemattributes.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /showitemattributes
nucleus.showitemattributes.exempt.cost ADMIN Allows the user to bypass the cost for /showitemattributes
nucleus.showitemattributes.exempt.warmup ADMIN Allows the user to bypass the warmup for /showitemattributes
nucleus.skull.base ADMIN Allows the user to run the command /skull
nucleus.skull.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /skull
nucleus.skull.exempt.cost ADMIN Allows the user to bypass the cost for /skull
nucleus.skull.exempt.limit ADMIN Allows the user to bypass the limit to the number of skulls that can be spawned.
nucleus.skull.exempt.warmup ADMIN Allows the user to bypass the warmup for /skull
nucleus.skull.others ADMIN Allows the user to target other players using the command "skull".
nucleus.trash.base USER Allows the user to run the command /trash
nucleus.trash.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /trash
nucleus.trash.exempt.cost ADMIN Allows the user to bypass the cost for /trash
nucleus.trash.exempt.warmup ADMIN Allows the user to bypass the warmup for /trash
nucleus.unsignbook.base ADMIN Allows the user to run the command /unsignbook
nucleus.unsignbook.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /unsignbook
nucleus.unsignbook.exempt.cost ADMIN Allows the user to bypass the cost for /unsignbook
nucleus.unsignbook.exempt.warmup ADMIN Allows the user to bypass the warmup for /unsignbook
nucleus.unsignbook.others ADMIN Allows the user to target other players using the command "unsignbook".
The following configuration is the default for this module: 
                            repair {
    # The list of item types to prevent (or allow if whitelist is true) repairing using /repair
    restrictions=[]
    # If true, the restriction list will be used as a whitelist vs a blacklist.
    use-whitelist=false
}
skull {
    # Limits the number of skulls that can be spawned using the "/skull" command. Set to -1 to disable the limit.
    spawn-limit=-1
    # If true, Nucleus will simply treat /skull as an alias to "/give [player] skull [number] 3 {SkullOwner:[skullplayer]}"
    use-minecraft-command=false
}
Search
Downloading search database, this won't take long...