Nicked

!(https://raw.githubusercontent.com/PharoGames/Nicked/main/images/banner.png)

Packet-level nickname plugin with skin changing, a developer API, and PlaceholderAPI support.

[!(https://img.shields.io/github/actions/workflow/status/PharoGames/Nicked/build.yml?branch=main&label=Build&logo=github)](https://github.com/PharoGames/Nicked/actions/workflows/build.yml) [!(https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/PharoGames/Nicked/blob/main/LICENSE) [!(https://img.shields.io/badge/Java-21-blue.svg)](https://adoptium.net/) [!(https://img.shields.io/badge/Minecraft-1. 20%2B-brightgreen.svg)](https://papermc.io/)

Nicked replaces a player's name and skin with someone else's. Other players see only the new identity. Nicked rewrites it at the packet level, so nobody needs a client mod.

## Features

• Packet-level nicking. Nicked rewrites names inside `PLAYER_INFO_UPDATE` packets before they reach any client. No client mods needed. Runs on Paper, Spigot, Purpur, Folia, and Bukkit 1. 20+.
• Skin changing. Nicked fetches the matching Mojang skin off the main thread and injects it into the same packet. The nicked player sees their own new skin in first-person too, which you can turn off.
• Identity leak protection. Minecraft builds death, join/leave, and advancement broadcasts from the real name, which gives a nicked player away. Nicked can rewrite each of those to use the nick, and can hide the real skin when a nick's skin fails to fetch. Every toggle is separate and starts off.
• Random nicking. Run `/nick` with no arguments to draw a name from your configured pool.
• Persistence. Nicks survive disconnects and full server restarts. Nicked stores them in `plugins/Nicked/nicks.yml` and reapplies them when the player joins.
• Developer API. Other plugins can read nick state, apply or remove nicks, and listen to five nick events (`NickApplyEvent`, `NickRemoveEvent`, `NickChangeEvent`, `NickRandomSelectEvent`, `NickResolveEvent`).
• PlaceholderAPI support. Three placeholders for any chat, scoreboard, or tab-list plugin that reads PlaceholderAPI:
• - `%nicked_displayname%`: the player's current display name (nick or real name)
• - `%nicked_is_nicked%`: `true` / `false`
• - `%nicked_real_name%`: the player's actual username
• Customisable messages. You edit every message in `messages.yml` using (https://docs.advntr.dev/minimessage/format.html). Gradients, hex colours, and hover events all work.

## Compatibility

| Platform | Supported | |---|---| | Paper 1. 20+ | ✅ | | Spigot 1. 20+ | ✅ | | Purpur 1. 20+ | ✅ | | Folia 1. 20+ | ✅ | | Bukkit 1. 20+ | ✅ | | Java | 21+ required |

Optional soft dependency: (https://modrinth.com/plugin/placeholderapi) enables the `%nicked_*%` placeholders.

## Commands

| Command | Description | Permission | |---|---|---| | `/nick ` | Nick yourself (random if no name given); toggle off if already nicked | `nicked.command.nick` | | `/unnick` | Remove your own nick | `nicked.command.unnick` | | `/nickother ` | Nick another player to a specific name | `nicked.command.nickother` | | `/nickall` | Randomly nick all online players | `nicked.command.nickall` | | `/realname ` | Reveal the real username behind a nick | `nicked.command.realname` |

The `nicked.admin` permission covers every command and goes to OPs by default.

## Quick Start

1. Drop `Nicked.jar` into your server's `plugins/` folder. 2. Restart the server. Nicked generates `plugins/Nicked/config.yml` and `messages.yml`. 3. Grant `nicked.admin` to trusted staff (OPs already have it). 4. Run `/nick Dream`. Your name and skin change on the spot. 5. Run `/nick` again with no arguments, or `/unnick`, to revert.

## Developer API

Add Nicked as a compile-only dependency via JitPack:

Gradle (Groovy) ```groovy repositories { maven { url 'https://jitpack.io' } } dependencies { compileOnly 'net.pharogames:Nicked:VERSION:api' } ```

Maven ```xml jitpack.io https://jitpack.io net.pharogames Nicked VERSION api provided ```

Replace `VERSION` with the latest release tag (e.g. `v1. 1. 0`). See the (https://nicked-docs.vercel.app/api/) for the full reference.

| Resource | URL | |---|---| | 📖 Documentation | (https://nicked-docs.vercel.app/) | | 💬 Discord | (https://discord.gg/7eQt8sQ8at) | | 🐛 Issues | (https://github.com/PharoGames/Nicked/issues) | | 💡 Feature Requests | (https://github.com/PharoGames/Nicked/issues/new/choose) | | 🔧 Source Code | (https://github.com/PharoGames/Nicked) |