Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/majekdev/hexnicks

Nickname plugin with hex color code and gradient support.
https://github.com/majekdev/hexnicks

chat gradient hex minecraft nickname papermc spigot

Last synced: 3 months ago
JSON representation

Nickname plugin with hex color code and gradient support.

Awesome Lists containing this project

README

        

[![build](https://github.com/MajekDev/HexNicks/actions/workflows/build.yml/badge.svg)](https://github.com/MajekDev/HexNicks/actions/workflows/build.yml)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/MajekDev/HexNicks)](https://github.com/MajekDev/HexNicks/releases/latest)
[![chat](https://img.shields.io/discord/753727849860432076?color=%237289da)](https://discord.majek.dev)
[![](https://img.shields.io/spiget/rating/83554?color=%23ff781f&label=Spigot)](https://www.spigotmc.org/resources/83554/)

# HexNicks

HexNicks is a simple nickname plugin that allows players to set their nickname to anything they like containing normal
colors, hex colors, and even gradients! It fully supports **only** Paper, though forks should work as well.
There are only a few commands and permissions to limit what players use what commands. Though the plugin does have
support for MySQL storage, it's mostly intended to be a simple nickname plugin for smaller Spigot/Paper servers.

## Features

- Parsing via [MiniMessage](https://docs.adventure.kyori.net/minimessage) - here's a [handy website](https://webui.adventure.kyori.net/) to practice.
- Optimized support for Paper. Forks should work as well.
- [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) support with the placeholder `%hexnicks_nick%` for player's nicknames.
- MySQL storage support for users on BungeeCord/Velocity.
- Metrics through [bStats](https://bstats.org/plugin/bukkit/HexNicks/8764).
- Active plugin and developer.
- Ability to format chat on its own, no external chat formatter needed.
- Simple [api](https://hexnicks.majek.dev/developers) for developers.
- Full documentation [here](https://hexnicks.majek.dev).

## Support

If you need help with the plugin and can't find the answer here, then the best way to get help is to either join
my [Discord](https://discord.gg/CGgvDUz) or post in [discussions](https://github.com/MajekDev/HexNicks/discussions/categories/q-a).
If you join Discord make sure you read the frequently-asked channel before posting in the bug-reports channel
(if it's a bug)or in the hexnicks channel (for general help).

If you have discovered a bug you can either join my [Discord](https://discord.gg/CGgvDUz) to tell me about it and then
open an issue here on GitHub. An open issue is the quickest way to get me to fix it. Please do not message me on Spigot i
n regard to a bug, there are easier ways to communicate.

## Contributing

HexNicks is open-source and licensed under the [MIT License](https://github.com/MajekDev/HexNicks/blob/main/LICENSE),
so if you want to use any code contained in the plugin or clone the repository and make some changes, go ahead!

If you've found a bug within the plugin and would like to just make the changes to fix it yourself, you're free to do
so and make a pull request here on GitHub. If you make significant contributions to the project, and by significant
I mean one PR to fix a typo doesn't count as significant, you can earn the Contributor role in my [Discord](https://discord.gg/CGgvDUz).

## Donate

I'm a full time college student who makes and supports these plugins in my free time (when I have any). As a long
time supporter of open source, most of my plugins are free. If you enjoy my plugins and would like to support me,
you can buy me coffee over on [PayPal](https://paypal.com/paypalme/majekdor). Donations of any amount are appreciated
and a donation of $10 or more will get you the Supporter role in my [Discord](https://discord.gg/CGgvDUz)!