An open API service indexing awesome lists of open source software.

https://github.com/ubermorgott/nicknamechanger

Server-side Hytale plugin for custom display nicknames
https://github.com/ubermorgott/nicknamechanger

Last synced: 5 months ago
JSON representation

Server-side Hytale plugin for custom display nicknames

Awesome Lists containing this project

README

          

# NickNameChanger

[![en](https://img.shields.io/badge/lang-English-blue)](README.md) [![ru](https://img.shields.io/badge/lang-Русский-green)](README.ru.md)

A server-side plugin for Hytale that allows players to customize their display nickname with colors, gradients, and text styles.

![Nickname Editor](img/editor_gradient.png)

## Features

- **UI Editor** — Graphical interface for nickname customization
- 12 preset colors + custom color picker
- 8 gradient presets + custom gradient colors
- Text styles: Bold, Italic, Underline
- Live preview
- **Chat** — Custom nickname displayed in chat messages
- **Nameplate** — Nickname shown above player's head
- **Map** — Custom name displayed on the world map
- **Tab List** — Nickname visible in the player list
- **LuckPerms** — Optional integration for chat formatting compatibility

## Commands

| Command | Description |
|---------|-------------|
| `/nick` | Open the nickname editor UI |
| `/nick ` | Set a nickname via command |
| `/nick reset` | Reset to your original username |

## Installation

1. Place `NickNameChanger-x.x.x.jar` into `Hytale\UserData\Mods`
2. Launch the game and open world settings
3. Enable the mod in the Mods section
4. Load the world

## Permissions

All permissions are **allowed by default** — the mod works out of the box with no configuration.

| Permission | Description | Default |
|---|---|---|
| `nickname.use` | Access to `/nick` command | ✅ Allowed |
| `nickname.format` | Use colors, gradients, bold/italic/underline | ✅ Allowed |

To **deny** a permission, use the `-` prefix:

**With LuckPerms:**
```
/lp group default permission set -nickname.format true # deny formatting for default group
/lp user Steve permission set -nickname.use true # deny /nick for specific player
```

**Without LuckPerms** (`permissions.json`):
```json
{
"groups": {
"Default": ["-nickname.format"],
"VIP": ["nickname.format"]
}
}
```

## Optional Dependencies

- **[LuckPerms](https://luckperms.net/)** — If installed:
- Nicknames sync to LuckPerms `display-name` meta
- Chat displays LuckPerms prefix/suffix alongside the nickname
- Permissions can be managed through LuckPerms

## Limitations

- **Inventory header** — Cannot be changed as it is rendered client-side

## Localization

- English (en-US)
- Russian (ru-RU)

## Credits

- **Author:** Morgott