nick:
description: Base command of SimpleNick, allowing the user to change their own nickname.
nickclear:
description: Clear your own or another players nickname and reset it back to their base name.
aliases: clearnick
nickcolors:
description: Show all available colours that a user has access too.
nickstyles:
description: Show all available styles that a user has access too.

# If true all messages will include a [SimpleNicks] prefix, enabling this supports me as a developer by "advertising" this plugin in your server!
# Disabling this has NO effect on this plugin it is only there to help support me
prefix:
usePrefixInMessages: true
# usePrefixInMessages must be TRUE to use this.
# Possibilities:
# AQUA, BLACK, BLUE, DARK_AQUA, DARK_BLUE, DARK_GRAY, DARK_GREEN, DARK_PURPLE
# DARK_RED, GOLD, GRAY, GREEN, LIGHT_PURPLE, RED, WHITE & YELLOW.
prefixColor: AQUA

# Should players be able to set their nicknames to a nickname that contains a users full Game Name?
# I.E. AkaGiant could not set their nickname to Minecrafter918 because that's a name of an online user.
# TODO: Allow a permission to bypass this system.
setNicknamesToOnlinePlayers: false

# Disable this if you have a different plugin that formats your chat!
chatFormatting:
enabled: true
format: '%playerDisplayName% » %playerMessage%'

# If true, when a player joins the server. The plugin will update the users nickname to their setnick name rather
# than is being reset to their normal name (set this to false if you're changing a users name with another plugin)
changePlayerNicknameOnJoin: true

# if false, console will NOT be able to change a users nickname
allowConsoleToChangeNicknames: true

nickColorsMenu:
fillerItem:
fillerItemMaterial: GRAY_STAINED_GLASS_PANE # Use Bukkit Materials here

# List all words that you do NOT want players to be able to set their nick name to here.
blacklistedWords:
- cunt
- fuck
- shit
- dick
- bastard
- piss
- twat
- fucker
- fucking
- nigger
- nigga
- niga
- nignog
- crap
- arse
- arsehole
- asshole
- pussy
- bitch
- bullshit
- piss
- tits
- fanny
- knob
- prick
- bellend
- tit
- cock
- dickhead
- wanker

CONFIG_VERSION: v1 # DO NOT TOUCH THIS VALUE

# Please feel free to remove any comments in this file,
# they're only there to help guide you through what each section does.
# A command is any line that starts with a #

# Have suggestions as to what messages should/could be added to this plugin? contact me @ TODO coming soon

# Want to remove the Prefix before every message? go to the config.yml and set
# usePrefixInMessages: true to usePrefixInMessages: false

noPermission:
# Sent to the executor of a command if they are missing a permission.
- "&cMissing Permission: %missingPermission%"

containsOnlineUser:
- "&cYou cannot set your nickname to a name of an online user"

# Usage of this plugin
usage:
# Sent to the user when they incorrectly try to use the /nick command
usageNickSelf:
- '&cUsage: /nick <newNickname>'
# Sent to the user when they incorrectly try to set the nick of another user.
usageNickOther:
- '&cUsage: /nick <target> <newNickname>'
# Sent to the user when they incorrectly try to clear their own nickname.
usageNickClearSelf:
- '&cUsage: /clearnick'
# Sent to the user when they incorrectly try to clear another users nickname.
usageNickClearOther:
- '&cUsage: /clearnick <target>'

nicknameClear:
# Sent when clearing your own nickname
self:
- '&fYour nickname has been reset to default values'
# Sent when clearing another players nickname
other:
# What is sent to the user that executed the command
toSender:
- "You have cleared %targetName%'s nickname"
# What is sent to the target of the command
toOther:
- 'Your nickname has been reset to default values by %senderName%'
# What is sent to the executor of the command if the target has no nickname
hasNoNickname:
- '%targetName% has no nickname set!'

setSuccessfully:
# Used when setting your own nickname
self:
# What is sent when setting your own nickname to a blacklisted word but you CAN bypass the filter.
canBypass:
- "&cYou have set your own nickname to &b%newNickname% &cbut it does contain a blacklisted word!"
# What is sent when setting your own nickname to a normal nickname.
noBlacklistedWord:
- "&fYou have set your own nickname to &b%newNickname% &fit was previously &b%oldNickname%"

# Used when setting another players nickname
toSender:
# Sent to the executor of the command when they set another users nickname to a blacklisted word and can bypass the filter.
canBypass:
- "&fYou have set &b%targetName%'s &fnick name to &b%newNickname% &fbut it contains a &cBLACKLISTED &fword if this was an accident please contact a member of staff to have it cleared!"
# Sent to the executor of the command when they set another users nickname to a normal nickname.
noBlacklistedWord:
- "&fYou have set &b%targetName%'s &fnickname to &b%newNickname% &fit was previously &b%oldNickname%"

# Sent to the target when another user changes their nickname.
toTarget:
# Sent when the nickname contains a blacklisted word but the executor can bypass the filter.
canBypass:
- "&fYour nickname has been updated to %newNickname% but contains a BLACKLISTED word by %senderName% it was previously %oldNickname% if you wish for it to be changed please contact a member of staff!"
# Sent when the nickname does not contain a blacklisted word.
noBlacklistedWord:
- "&fYour nickname has been updated to &b%newNickname% &fby &b%senderName% &fit was previously &b%oldNickname%"

nickColors:
examples:
tipMessage:
- "Hover for examples | If it's blank you have none!"

# Sent if they do /nick with nothing applied
noArguments:
# Sent if the player has a nicknmame set.
hasNoNickname:
- "No nickname set"
# Sent if the player does not havea nickname set.
hasNickname:
- "&fYour nickname is &b%playerNickname%"

errors:
# Sent to the executor of the command when the target of their command is not found on the server.
targetNotFound:
- '&cError: &c&l%targetName% &cnot found, are they online? '

blacklistedWords:
# Sent to any user that tries to change their own nickname to a blacklisted word and does not have the correct permissions
blacklistedWordWarning:
- "&cI'm sorry but you cannot set your nickname to a blacklisted word!"
# Sent to the console when a user tries to set their own nickname to a blacklisted word and does not have the correct permissions
blacklistedNicknameSelf:
- "%playerName% tried to set their own nickname to %nickname% but it contains a blacklisted word"
# Sent to the console when a user tries to set another users nickname to a blacklisted word and does not have the correct permissions
blacklistedNicknameOther:
- "%playerName% tried to set %targetName%'s nickname to %nickname% but it contains a blacklisted word"
# Sent to the console when a user changes their nickname to a blacklisted word and DOES have the correct permissions
blacklistedNicknameSelfBypass:
- "%playerName% has set their nickname to a blacklisted nickname (%nickname%) but can bypass blacklisted nicknames"
# Sent to the console when a user changes another users nickname to a blacklisted word and DOES have the correct permissions.
blacklistedNicknameOtherBypass:
- "%playerName% has set %targetName%'s nickname to a blacklisted nickname (%nickname%) but can bypass blacklisted nicknames"

SimpleNick.*:
default: op
children:
SimpleNick.colors.*: true
SimpleNick.style.*: true
SimpleNick.nickname: true
SimpleNick.clearNick: true
SimpleNick.clearNick.other: true
SimpleNick.nickname.other: true
SimpleNick.nickname.self.bypassFilter: true
SimpleNick.nickname.other.bypassFilter: true
description: Permission to give a user all permissions in SimpleNick.

SimpleNick.nickname:
description: Base permission for a player to base able to change their nickname.

SimpleNick.nickname.other:
description: Allows a user to change someone elses nickname.
children:
SimpleNick.nickname: true

SimpleNick.nickname.self.bypassFilter:
description: Allows a user to set their ownnick name to a blacklisted word.

SimpleNick.nickname.other.bypassFilter:
description: Allows a user to set another users nickname to a blacklisted word.
children:
SimpleNick.nickname.self.bypassFilter: true

SimpleNick.clearNickname:
description: Clear you own nickname.

SimpleNick.clearNickname.other:
description: Clear another users nickname
children:
SimpleNick.clearNickname: true

SimpleNick.colors.*:
description: Permission to allow a user to use any standard color code in their nickname.
children:
SimpleNick.colors.DarkRed: true #
SimpleNick.colors.Red: true
SimpleNick.colors.Gold: true #
SimpleNick.colors.Yellow: true #
SimpleNick.colors.DarkGreen: true #
SimpleNick.colors.Green: true #
SimpleNick.colors.Aqua: true #
SimpleNick.colors.DarkAqua: true
SimpleNick.colors.DarkBlue: true #
SimpleNick.colors.Blue: true #
SimpleNick.colors.LightPurple: true #
SimpleNick.colors.DarkPurple: true #
SimpleNick.colors.White: true #
SimpleNick.colors.DarkGray: true #
SimpleNick.colors.Black: true #
SimpleNick.colors.Gray: true #11

SimpleNick.colors.DarkRed:
description: Permission to use &4 in NickNames.
SimpleNick.colors.Red:
description: Permission to use &c in NickNames.
SimpleNick.colors.Gold:
description: Permission to use &6 in NickNames.
SimpleNick.colors.Yellow:
description: Permission to use &e in NickNames.
SimpleNick.colors.DarkGreen:
description: Permission to use &2 in NickNames.
SimpleNick.colors.Green:
description: Permission to use &a in NickNames.
SimpleNick.colors.Aqua:
description: Permission to use &b in NickNames.
SimpleNick.colors.DarkAqua:
description: Permission to use &3 in NickNames.
SimpleNick.colors.DarkBlue:
description: Permission to use &1 in NickNames.
SimpleNick.colors.Blue:
description: Permission to use &9 in NickNames.
SimpleNick.colors.LightPurple:
description: Permission to use &d in NickNames.
SimpleNick.colors.DarkPurple:
description: Permission to use &5 in NickNames.
SimpleNick.colors.White:
description: Permission to use &f in NickNames.
SimpleNick.colors.DarkGray:
description: Permission to use &8 in NickNames.
SimpleNick.colors.Black:
description: Permission to use &0 in NickNames.
SimpleNick.colors.Gray:
description: Permission to use &7 in NickNames.

SimpleNick.style.*:
description: Permission to allow a user to use any styling in their nickname.
children:
SimpleNick.style.Bold: true # &l
SimpleNick.style.StrikeThrough: true # &m
SimpleNick.style.Underline: true # &n
SimpleNick.style.Italic: true #&o
SimpleNick.style.Reset: true #&r
SimpleNick.style.Magic: true #&k
SimpleNick.style.Bold:
description: Permission to use &l in NickNames.
SimpleNick.style.StrikeThrough:
description: Permission to use &m in NickNames.
SimpleNick.style.Underline:
description: Permission to use &n in NickNames.
SimpleNick.style.Italic:
description: Permission to use &o in NickNames.
SimpleNick.style.Reset:
description: Permission to use &r in NickNames.
SimpleNick.style.Magic:
description: Permission to use &k in NickNames.