NickNameMod

A Hytale server plugin that allows players to set custom nicknames displayed in chat.

Description

NickNameMod is a simple yet powerful plugin that gives players the ability to change their display name in chat without affecting their actual username. When a player sets a nickname, their messages in chat will be prefixed with a ~ symbol to indicate they're using a custom nickname.

Features

• Custom Nicknames: Players can set their own display name
• Persistent Storage: Nicknames are saved to disk and persist across server restarts
• Chat Integration: Nicknames automatically appear in chat messages
• Visual Indicator: A ~ prefix shows when a player is using a nickname
• Easy Reset: Players can easily reset their nickname to their original username
• Thread-Safe Cache: Optimized performance with async-safe nickname caching
• Validation: Automatic validation of nickname length and characters

Usage

Commands

/nick <nickname>

Set or change your nickname.

Examples:

/nick Steve          → Sets nickname to "Steve"
/nick SuperPlayer    → Changes nickname to "SuperPlayer"

Restrictions:

• Maximum 16 characters
• Only letters, numbers, and underscores allowed
• Cannot use "reset" as a nickname (reserved word)

/nick reset

Reset your nickname back to your original username.

Example:

/nick reset          → Removes your nickname

Chat Display

When a player has a nickname set, their chat messages will display with a ~ prefix:

Without nickname:

PlayerName: Hello everyone!

With nickname:

~CustomNick: Hello everyone!

The ~ symbol indicates that the player is using a custom nickname instead of their original username.

Installation

1. Download the latest release of NickNameMod
2. Place the .jar file in your Hytale server's Mods folder
3. Restart your server
4. Players can now use /nick to set their nicknames

Technical Details

Architecture

• ECS Component: NicknameComponent stores nicknames persistently
• Cache System: NicknameCache provides thread-safe async access
• Event Listeners:
  • PlayerReadyEvent: Loads nickname into cache on player join
  • PlayerChatEvent: Formats chat messages with nicknames
• Message Utility: MessageUtil provides colored, formatted messages

Permissions

No special permissions required - all players can use the /nick command by default.

Data Storage

Nicknames are stored as ECS components and automatically persist to disk using Hytale's Codec system.

Examples

Setting a Nickname

Player: /nick Dragon
Server: [NickNameMod] >> Nickname set: Dragon

Chat:

~Dragon: Hi everyone!
~Dragon: This is my new nickname

Changing a Nickname

Player: /nick Knight
Server: [NickNameMod] >> Nickname changed: Knight

Chat:

~Knight: I changed my name!

Resetting a Nickname

Player: /nick reset
Server: [NickNameMod] >> Nickname reset.

Chat:

OriginalUsername: Back to my original name

Error Messages

Nickname too long:

Player: /nick ThisIsAVeryLongNicknameTest
Server: [NickNameMod] >> Nickname too long (max 16 characters).

Invalid characters:

Player: /nick Test@123
Server: [NickNameMod] >> Invalid characters (letters, numbers, _ only).

Version

Current Version: 1.0.0

Author

Corentin