Description
# Simple Nicknames
A straightforward nickname system for your Minecraft server that allows players to customize their display names across the game.
## Beta Notice
This mod is currently in beta. While it's functional, you may encounter bugs or unexpected behavior. Please report any issues you find so I can continue improving the mod!
## Installation
**Both client and server installations are required.**
Make sure to install the mod on both sides for it to work properly.
**!!! The Fabric version also requires the [Fabric API](https://modrinth.com/mod/fabric-api) and the [Cloth Config API](https://modrinth.com/mod/cloth-config) on both sides !!!**
## Usage
Set your nickname with a simple command:
```
/nick
```
Example:
```
/nick Leo
```
To remove your nickname and return to your original name:
```
/unnick
```
Admins are able to set nicknames for other users or assign random nicks:
```
/setnick Donutello396 Leo
/randomnick @a
```
They can also unnick other users as well as list all nicked users:
```
/unnick username Donutello396
/unnick nickname Leo
/listnicknames
```
## Features
### Display Name Changes
Simple Nicknames changes your display name in the following locations:
* **Nametag** - The name displayed above your character
* **Chat** - Your name in chat messages
* **Tab List** - The player list accessible via Tab key
* **Scoreboard** - Your name on any scoreboards
You can configure how and where your name appears in the config file.
If you notice your nickname not appearing somewhere it should, please report it so I can add support!
### Customization
Your nickname will still respect existing formatting, such as team colors set for members. Additionally, you can customize various aspects of the mod through the config file to suit your server's needs.
## Known incompatibilities
* **Entity Culling** - When viewing players through walls, sometimes their normal username appears as their nametag. To fix this, disable Entity Culling for minecraft:player in the configs.
## Support
Found a bug or have a feature request? You can reach out through:
* Discord: donutello\_
**Please make sure you have read this modpage and the config file before reporting!**
Please include as much detail as possible when reporting issues!
