Hat Cosmetics

🔍 About

HatCosmetics is a plugin that provides a simple and user-friendly way to implement custom hat models on your server.

🌟 How is HatCosmetics Different?

HatCosmetics works with no interaction (just toggling resourcepacks) from the end users. Distribution of hats is handled fully server-side, meaning compatiblity and reproducability with any client. This is a key difference from mods, which require additional setup for each client.

🚀 Features

Hat Selection GUI

• A customisable GUI that serves as the main menu for players to browse and select hats to equip.
• Players can view all available hats, but can only equip the ones they have permissions for.

Permissions and Access Control

• Granular permission system to control which players can access and equip specific hats.
• Out of the box support for a wide range of permissions plugins.

Customisation and Extensibility

• Easily add or remove hats by modifying the plugin's configuration files.
• Designed with easy design, allowing easy creation and implementation of custom hats.

🎯 Work In Progress Features

• Player Locality: Translation for HatCosmetics commands and GUIs.
• Hat Overlays: The ability to overlay a hat on top of a piece of armour, without affecting the stats.
• Adding Hat Simplification: Further improvements to streamline and make adding hats simpler.

📥 Installation

🏷️ Releases

Caution

Do not download HatCosmetics from any other source than the ones listed below.

1. Download the latest release for your server version using one of the above options.
2. Download the latest release of NBT API.
3. Drop the JAR files into the plugins folder of your Minecraft server.
4. Restart the server.

📜 Building from Source

1. Clone the repository.
2. Run gradlew build in the root directory of the repository.
3. The JAR file will be located in build/libs/.
4. Drop the JAR file into the plugins folder of your Minecraft server.

Note

You will need to download or build the latest release of NBT API and drop it into the plugins folder of your server.

5. Restart the server.

📚 Wikipedia

A wiki page detailing usage, commands and permissiosn can be found here.

🤝 Contributing

✏️ Contributing Guide

Anyone and everyone is welcome to contribute and help out with the project! If you have any problems, please help track it by opening an issue. Feel free to open a PR and look at any potential issues.

👥 Contributors

⚖️ Licence

HatCosmetics is licensed under the MIT License.