Module: Nickname - Module ID: nickname

Introduction

The Nickname module allows players to have a different display name to their Minecraft IGN.

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.

/delnick

Module: nickname

Deletes your current nickname

Aliases: delnick delnickname deletenick

Root command aliases: /ndelnick

Usage: /delnick [<subject>]

Default Role: ADMIN

Basic Command Permission: nucleus.nick.base

Permissions

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

/nick

Module: nickname

Sets your nickname/display name

Aliases: nick nickname

Root command aliases: /nnick

Usage: /nick [<subject>] <nickname>

Default Role: ADMIN

Basic Command Permission: nucleus.nick.base

Permissions

nucleus.nick.colour.dark_blue - Default Role: ADMIN
Allows user to use the colour "dark_blue" (&1) in nicknames.
nucleus.nick.color.light_purple - Default Role: ADMIN
Allows user to use the color "light_purple" (&d) in nicknames.
nucleus.nick.color.green - Default Role: ADMIN
Allows user to use the color "green" (&a) in nicknames.
nucleus.nick.color.dark_green - Default Role: ADMIN
Allows user to use the color "dark_green" (&2) in nicknames.
nucleus.nick.color.black - Default Role: ADMIN
Allows user to use the color "black" (&0) in nicknames.
nucleus.nick.color.white - Default Role: ADMIN
Allows user to use the color "white" (&f) in nicknames.
nucleus.nick.exempt.warmup - Default Role: ADMIN
Allows the user to bypass the warmup for /nick, Allows the user to bypass the warmup for /delnick
nucleus.nick.colour.dark_gray - Default Role: ADMIN
Allows user to use the colour "dark_gray" (&8) in nicknames.
nucleus.nick.exempt.cost - Default Role: ADMIN
Allows the user to bypass the cost for /nick, Allows the user to bypass the cost for /delnick
nucleus.nick.colour.dark_red - Default Role: ADMIN
Allows user to use the colour "dark_red" (&4) in nicknames.
nucleus.nick.color.dark_purple - Default Role: ADMIN
Allows user to use the color "dark_purple" (&5) in nicknames.
nucleus.nick.colour.red - Default Role: ADMIN
Allows user to use the colour "red" (&c) in nicknames.
nucleus.nick.color.dark_aqua - Default Role: ADMIN
Allows user to use the color "dark_aqua" (&3) in nicknames.
nucleus.nick.colour.blue - Default Role: ADMIN
Allows user to use the colour "blue" (&9) in nicknames.
nucleus.nick.style.strikethrough - Default Role: ADMIN
Allows user to use the "strikethrough" style (&m) in nicknames.
nucleus.nick.others - Default Role: ADMIN
Allows the user to change other's nicknames.
nucleus.nick.style.bold - Default Role: ADMIN
Allows user to use the "bold" style (&l) in nicknames.
nucleus.nick.color.dark_red - Default Role: ADMIN
Allows user to use the color "dark_red" (&4) in nicknames.
nucleus.nick.exempt.cooldown - Default Role: ADMIN
Allows the user to bypass the cooldown for /nick, Allows the user to bypass the cooldown for /delnick
nucleus.nick.color.aqua - Default Role: ADMIN
Allows user to use the color "aqua" (&b) in nicknames.
nucleus.nick.base - Default Role: ADMIN
Allows the user to run the command /nick, Allows the user to run the command /delnick
nucleus.nick.style.italic - Default Role: ADMIN
Allows user to use the "italic" style (&o) in nicknames.
nucleus.nick.color.yellow - Default Role: ADMIN
Allows user to use the color "yellow" (&e) in nicknames.
nucleus.nick.style.<style> - Default Role: ADMIN
Allows user to use a single style in nicknames.
nucleus.nick.style.reset - Default Role: ADMIN
Allows user to use the "reset" style (&r) in nicknames.
nucleus.nick.colour.dark_aqua - Default Role: ADMIN
Allows user to use the colour "dark_aqua" (&3) in nicknames.
nucleus.nick.colour.dark_purple - Default Role: ADMIN
Allows user to use the colour "dark_purple" (&5) in nicknames.
nucleus.nick.color.<color> - Default Role: ADMIN
Allows user to use a single color in nicknames.
nucleus.nick.style.underline - Default Role: ADMIN
Allows user to use the "underline" style (&n) in nicknames.
nucleus.nick.colour.white - Default Role: ADMIN
Allows user to use the colour "white" (&f) in nicknames.
nucleus.nick.style - Default Role: ADMIN
Allows the user to style their nickname.
nucleus.nick.color.dark_gray - Default Role: ADMIN
Allows user to use the color "dark_gray" (&8) in nicknames.
nucleus.nick.colour.green - Default Role: ADMIN
Allows user to use the colour "green" (&a) in nicknames.
nucleus.nick.color.gray - Default Role: ADMIN
Allows user to use the color "gray" (&7) in nicknames.
nucleus.nick.colour.aqua - Default Role: ADMIN
Allows user to use the colour "aqua" (&b) in nicknames.
nucleus.nick.colour.gold - Default Role: ADMIN
Allows user to use the colour "gold" (&6) in nicknames.
nucleus.nick.magic - Default Role: ADMIN
Allows the user to use "magic" characters in their nickname.
nucleus.nick.colour.dark_green - Default Role: ADMIN
Allows user to use the colour "dark_green" (&2) in nicknames.
nucleus.nick.colour.light_purple - Default Role: ADMIN
Allows user to use the colour "light_purple" (&d) in nicknames.
nucleus.nick.color.dark_blue - Default Role: ADMIN
Allows user to use the color "dark_blue" (&1) in nicknames.
nucleus.nick.colour - Default Role: ADMIN
Allows the user to colour their nickname.
nucleus.nick.colour.gray - Default Role: ADMIN
Allows user to use the colour "gray" (&7) in nicknames.
nucleus.nick.color.gold - Default Role: ADMIN
Allows user to use the color "gold" (&6) in nicknames.
nucleus.nick.color.red - Default Role: ADMIN
Allows user to use the color "red" (&c) in nicknames.
nucleus.nick.colour.black - Default Role: ADMIN
Allows user to use the colour "black" (&0) in nicknames.
nucleus.nick.color.blue - Default Role: ADMIN
Allows user to use the color "blue" (&9) in nicknames.
nucleus.nick.color - Default Role: ADMIN
Allows the user to color their nickname.
nucleus.nick.colour.yellow - Default Role: ADMIN
Allows user to use the colour "yellow" (&e) in nicknames.

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

Essentials Migration Notes: To remove a nickname, use '/delnick'

/realname

Module: nickname

Gets the player's realname from the provided nickname.

Aliases: realname

Root command aliases: /nrealname

Usage: /realname <name>

Default Role: USER

Basic Command Permission: nucleus.realname.base

Permissions

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

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

Permission	Suggested Role	Description
nucleus.nick.base	ADMIN	Allows the user to run the command /nick, Allows the user to run the command /delnick
nucleus.nick.color	ADMIN	Allows the user to color their nickname.
nucleus.nick.color.aqua	ADMIN	Allows user to use the color "aqua" (&b) in nicknames.
nucleus.nick.color.black	ADMIN	Allows user to use the color "black" (&0) in nicknames.
nucleus.nick.color.blue	ADMIN	Allows user to use the color "blue" (&9) in nicknames.
nucleus.nick.color.dark_aqua	ADMIN	Allows user to use the color "dark_aqua" (&3) in nicknames.
nucleus.nick.color.dark_blue	ADMIN	Allows user to use the color "dark_blue" (&1) in nicknames.
nucleus.nick.color.dark_gray	ADMIN	Allows user to use the color "dark_gray" (&8) in nicknames.
nucleus.nick.color.dark_green	ADMIN	Allows user to use the color "dark_green" (&2) in nicknames.
nucleus.nick.color.dark_purple	ADMIN	Allows user to use the color "dark_purple" (&5) in nicknames.
nucleus.nick.color.dark_red	ADMIN	Allows user to use the color "dark_red" (&4) in nicknames.
nucleus.nick.color.gold	ADMIN	Allows user to use the color "gold" (&6) in nicknames.
nucleus.nick.color.gray	ADMIN	Allows user to use the color "gray" (&7) in nicknames.
nucleus.nick.color.green	ADMIN	Allows user to use the color "green" (&a) in nicknames.
nucleus.nick.color.light_purple	ADMIN	Allows user to use the color "light_purple" (&d) in nicknames.
nucleus.nick.color.red	ADMIN	Allows user to use the color "red" (&c) in nicknames.
nucleus.nick.color.white	ADMIN	Allows user to use the color "white" (&f) in nicknames.
nucleus.nick.color.yellow	ADMIN	Allows user to use the color "yellow" (&e) in nicknames.
nucleus.nick.colour	ADMIN	Allows the user to colour their nickname.
nucleus.nick.colour.aqua	ADMIN	Allows user to use the colour "aqua" (&b) in nicknames.
nucleus.nick.colour.black	ADMIN	Allows user to use the colour "black" (&0) in nicknames.
nucleus.nick.colour.blue	ADMIN	Allows user to use the colour "blue" (&9) in nicknames.
nucleus.nick.colour.dark_aqua	ADMIN	Allows user to use the colour "dark_aqua" (&3) in nicknames.
nucleus.nick.colour.dark_blue	ADMIN	Allows user to use the colour "dark_blue" (&1) in nicknames.
nucleus.nick.colour.dark_gray	ADMIN	Allows user to use the colour "dark_gray" (&8) in nicknames.
nucleus.nick.colour.dark_green	ADMIN	Allows user to use the colour "dark_green" (&2) in nicknames.
nucleus.nick.colour.dark_purple	ADMIN	Allows user to use the colour "dark_purple" (&5) in nicknames.
nucleus.nick.colour.dark_red	ADMIN	Allows user to use the colour "dark_red" (&4) in nicknames.
nucleus.nick.colour.gold	ADMIN	Allows user to use the colour "gold" (&6) in nicknames.
nucleus.nick.colour.gray	ADMIN	Allows user to use the colour "gray" (&7) in nicknames.
nucleus.nick.colour.green	ADMIN	Allows user to use the colour "green" (&a) in nicknames.
nucleus.nick.colour.light_purple	ADMIN	Allows user to use the colour "light_purple" (&d) in nicknames.
nucleus.nick.colour.red	ADMIN	Allows user to use the colour "red" (&c) in nicknames.
nucleus.nick.colour.white	ADMIN	Allows user to use the colour "white" (&f) in nicknames.
nucleus.nick.colour.yellow	ADMIN	Allows user to use the colour "yellow" (&e) in nicknames.
nucleus.nick.exempt.cooldown	ADMIN	Allows the user to bypass the cooldown for /nick, Allows the user to bypass the cooldown for /delnick
nucleus.nick.exempt.cost	ADMIN	Allows the user to bypass the cost for /nick, Allows the user to bypass the cost for /delnick
nucleus.nick.exempt.warmup	ADMIN	Allows the user to bypass the warmup for /nick, Allows the user to bypass the warmup for /delnick
nucleus.nick.magic	ADMIN	Allows the user to use "magic" characters in their nickname.
nucleus.nick.others	ADMIN	Allows the user to change other's nicknames.
nucleus.nick.style	ADMIN	Allows the user to style their nickname.
nucleus.nick.style.bold	ADMIN	Allows user to use the "bold" style (&l) in nicknames.
nucleus.nick.style.italic	ADMIN	Allows user to use the "italic" style (&o) in nicknames.
nucleus.nick.style.reset	ADMIN	Allows user to use the "reset" style (&r) in nicknames.
nucleus.nick.style.strikethrough	ADMIN	Allows user to use the "strikethrough" style (&m) in nicknames.
nucleus.nick.style.underline	ADMIN	Allows user to use the "underline" style (&n) in nicknames.
nucleus.realname.base	USER	Allows the user to run the command /realname
nucleus.realname.exempt.cooldown	ADMIN	Allows the user to bypass the cooldown for /realname
nucleus.realname.exempt.cost	ADMIN	Allows the user to bypass the cost for /realname
nucleus.realname.exempt.warmup	ADMIN	Allows the user to bypass the warmup for /realname

The following configuration is the default for this module:

# The maximum number of visible characters that the nickname can be.
max-nickname-length=20
# The minimum number of visible characters that the nickname can be.
min-nickname-length=3
# A regular expression that limits what form the nickname can take. If Nucleus fails to read the regex here, the default of "[a-zA-Z0-9_]+" (the same restriction as Minecraft usernames) will be used. To allow all characters, use ".+".
pattern="[a-zA-Z0-9_]+"
# A prefix to any nickname that is displayed in chat.
prefix="&b~"