Nick Name Changer

A Hytale server plugin that lets players set custom nicknames displayed in chat, map, and above their heads.

NickNameChanger 0.0.18

NickNameChanger is a server mod for Hytale 0.6.x, built against Hytale Server 0.6.8. Its manifest requires server 0.6.8 or newer.

Set a nickname in chat, above your character, in the player list and on map player markers. Chat nicknames support colors, gradients, bold, italic and underline. Choose a separate color or gradient for your chat messages. Nameplates, the player list and map labels use plain text.

Your real username stays unchanged, so other plugins can still find you by your account name.

Report bugs on GitHub Issues. I don't read CurseForge comments.

The name at the top of the inventory or character screen comes from the game client and your account. No server mod can change it.

Install in your own world

  1. Download the NickNameChanger 0.0.18 .jar from CurseForge.
  2. Press Win+R.
  3. Type %AppData%\Hytale\UserData\Mods and press Enter. If it is missing, open %AppData%\Hytale\UserData and create a folder named Mods.
  4. Put the downloaded jar in Mods. Do not unpack it.
  5. Start Hytale.
  6. Open your world settings, go to Mods, then Global Mods, and enable NickNameChanger.
  7. Enter the world and run /nnc in chat.

These are the default Windows paths. If you chose a custom Hytale data location, use its UserData\Mods folder instead.

For a dedicated server, put the jar in the server's mods folder and restart the server. No other mod is required for NNC's basic features.

Check that it loaded

Open %AppData%\Hytale\UserData\Logs after starting your world. Open the newest log and search for the exact prefix Integrations:. This line lists detected optional plugins and the selected chat route. Timestamps and logger names may appear before it. On a dedicated server, check its console or server logs.

Upgrade from 0.0.17 or older

Stop the world or server. Replace the old NickNameChanger jar with 0.0.18 and delete the old jar so only one version remains. Keep the mod's data folder.

Configuration migration runs automatically at startup. When old camelCase keys need conversion, the original is saved beside the config as config.json.pre-0.0.18.bak. Current keys use PascalCase. If both spellings exist, the PascalCase value wins; missing nested values are carried over.

Unreadable nickname data is not overwritten. A failed migration stops loading instead of replacing settings with defaults. Failed saves are reported. The update cannot recover data already deleted or overwritten; use an existing backup for that.

Commands

/nnc is the main command. /nick and /nickname are aliases. Use /nnc if another plugin owns either alias.

CommandAction
/nncOpen the nickname editor
/nnc <name>Set a nickname
/nnc resetReset your nickname and message color
/nnc msgcolor #FF5555Set a message color
/nnc msgcolor gradient:#FF5555:#5555FFSet a message gradient
/nnc msgcolor resetReset only your message color
/nnc settingsOpen global display settings

Use the editor for colors and gradients, or enter supported markup, for example /nnc <gradient:#FF5555:#5555FF>Steve</gradient>. Formatting requires nickname.format. Commands and the editor use the same nickname rules.

Permissions

PermissionDefaultAllows
nickname.useAllowedNickname command and editor
nickname.formatAllowedNickname colors and formatting
nickname.msgcolorAllowedMessage colors in the command and editor
nickname.adminDeniedGlobal display settings

With LuckPerms, unset nodes use these defaults. An explicit denial overrides the default. Message color and nickname formatting are separate permissions.

/lp user Steve permission set nickname.admin true

/lp group Admin permission set nickname.admin true

/lp group default permission set nickname.format false

/lp group default permission set nickname.msgcolor false

/lp user Steve permission set nickname.use false

Without LuckPerms, use Hytale's native permissions. The OP group's * includes nickname.admin. A native denial is -nickname.format or -nickname.msgcolor. Set permissions in your existing permissions.json. Keep its player assignments.

Optional mods and chat setup

Choose one plugin to format chat. NNC uses its own format when no other plugin does. ChatFormat controls NNC's own output.

SetupWhat it enables and what to configure
NNC aloneNicknames and message colors in NNC's ChatFormat. No dependency needed.
LuckPermsPermissions and prefix/suffix in NNC chat. For old LuckPerms 5.5.28 betas with their own formatter, set chat-formatter.enabled to false in LuckPerms.
mini-chat-formatter 0.1.x, optionally with LuckPerms or PlaceholderAPI<username> shows the nickname and <message> gets the message color automatically. No PlaceholderAPI needed for this adapter. For other versions, use %nnc_nickname_mini% instead of <username> with HelpChat PlaceholderAPI. Check Integrations: for the selected route.
EssentialsPlus, optionally with LuckPerms or PlaceholderAPIWith EP's chat.enabled on, NNC syncs the nickname to EP's {player} and applies message colors while EP alone owns chat. Native nickname sync accepts only A-Z, a-z, 0-9 and _. Rejections are reported. For other characters, use %nnc_nickname_mini% in EP's chat format with HelpChat PlaceholderAPI.
EliteEssentials, optionally with LuckPerms or PlaceholderAPIWith EE's chatFormat.enabled on, NNC syncs the nickname to EE's {player}. Message color is not automatic: with HelpChat PlaceholderAPI, put %nnc_msgcolor_legacy% immediately before {message} in EE's chat formats. Through this legacy token, a message gradient becomes its first color.
HelpChat PlaceholderAPIExposes NNC's placeholders and lets NNC's ChatFormat resolve external %placeholders%. Optional; check that its version supports your server.
HyperPermsNNC registers %nnc_nickname% directly with HyperPerms. Replace %player% with it in HyperPerms' chat format. No PlaceholderAPI needed for this token. HyperPerms 2.10.0 has not been updated for server 0.6.8: its player-list code throws NoSuchMethodError for ServerPlayerListPlayer.<init>. Chat with %nnc_nickname% worked in my tests, but other HyperPerms features may break until it is updated.
KyuubiSoft titlesRequires Kyuubi Chat Title Bridge and HelpChat PlaceholderAPI. Put %ks_title_raw% in NNC's ChatFormat, for example before {prefix}. Set Kyuubi's displayMode to nametag or none so it does not also format chat. {title} is not an NNC token.
MysticNameTagsWith its PlaceholderAPI expansion, put %mystictags_tag% in NNC's ChatFormat. If MysticNameTags controls nameplates, set NNC's Display.ShowOnNameplate to false and use %nnc_nameplate% in MysticNameTags' format.

If EssentialsPlus and EliteEssentials both format chat, messages can be sent twice. Disable chat formatting in one of them. NNC logs a warning. Do not enable several chat formatters just because they appear in this table.

PlaceholderAPI placeholders

The expansion identifier is nnc. Put tokens in a plugin's format where it supports HelpChat PlaceholderAPI and the corresponding color syntax.

PlaceholderValue
%nnc_nickname%Plain chat nickname, or real name
%nnc_nickname_mini%Chat nickname with MiniMessage / EssentialsPlus color tags
%nnc_nickname_legacy%Chat nickname with &#RRGGBB and legacy style codes
%nnc_nameplate%Plain nickname, independent of ShowInChat
%nnc_has_nickname%true or false
%nnc_realname%Real username
%nnc_msgcolor_open%Opening MiniMessage message-color tags
%nnc_msgcolor_close%Closing MiniMessage message-color tags
%nnc_msgcolor_legacy%Message color as &#RRGGBB; first color for a gradient

The three chat nickname placeholders return the real name when Display.ShowInChat is off. Message-color tokens are empty without a saved color or permission. In a compatible MiniMessage format, put %nnc_msgcolor_open% before the message token and %nnc_msgcolor_close% after it. Keep that formatter's own message token.

Display settings and configuration

/nnc settings changes chat, nameplate and player-list display for all players. Saving applies the settings to online players and keeps them across restarts. Hiding nicknames does not delete them. Map display is separate: edit Display.ShowOnMap. It is off by default.

The server creates mods/NickNameChanger_NickNameChanger/config.json in its data directory. This is the running server's data folder, including the local server used by your world. The default ChatFormat is {prefix}<{username}>{suffix} {message}. Nicknames default to 2–32 visible characters. Cyrillic is enabled; unrestricted Unicode letters are disabled. Unique nicknames and real-name protection are enabled. The default banned words are admin, moderator, server and owner.

ChatFormat accepts {prefix}, {username}, {suffix} and {message}. Prefix and suffix come from LuckPerms when its integration and the corresponding switches are enabled. External %placeholders% require HelpChat PlaceholderAPI and their provider.

Nickname rules apply to visible text after supported formatting is parsed:

  • MinLength and MaxLength exclude formatting tags.
  • AllowedCharactersRegex must match the whole visible nickname. Examples: ^[A-Za-z0-9_]+$ or ^[A-Za-zА-Яа-яЁё0-9_]+$.
  • An empty regex uses the built-in letters/digits rules plus spaces and _ - . ! ?. AllowCyrillic and AllowUnicode extend the allowed letters and digits.
  • Literal < > & § % { } \ are forbidden in visible names. Supported color and gradient tags still work; they are parsed before these checks.
  • BannedWords rejects any nickname containing a listed word, ignoring case.
  • UniqueNicknames compares names without colors or case differences.
  • BlockRealUsernames prevents using another known player's real name, including offline players. It knows names recorded by this server, not every Hytale account.
  • Invalid rules stop nickname changes with an error. Invalid names are rejected with a reason, not silently shortened or rewritten.

Not working?

  1. Check that NNC is enabled for this world and only one jar is installed.
  2. Try /nnc, especially if another plugin has a /nick command.
  3. Check the newest log for Integrations: and earlier loading errors.
  4. Check permissions and Display settings. Map display is off by default.
  5. Use one chat formatter. Changing NNC's ChatFormat does not change EP, EE or MCF's format.
  6. Check the limits below. If it still fails, include server and plugin versions, relevant config and log errors in GitHub Issues. I don't read CurseForge comments.

Known limits

  • The name at the top of the inventory or character screen is your account name from the game client. No server mod can change it.
  • Nameplates, the player list and map labels show plain names, without chat gradients.
  • EssentialsPlus's native nickname sync only accepts A-Z, a-z, 0-9 and _. Use its PlaceholderAPI route for other characters.
  • HyperPerms 2.10.0 is not fully updated for server 0.6.8 (its player-list code throws an error). NNC cannot fix that part.
  • A placeholder needs its provider and a formatter that understands its output. An adapter does not guarantee every third-party plugin version supports 0.6.8.

Nick Name Changer Team

profile avatar
Owner
  • 3
    Projects
  • 4.9K
    Downloads

More from Morgott