HyEssentials

Overview

--------

HyEssentials is a lightweight yet powerful plugin designed to provide essential

functionality for any Hytale server. It features a robust Kit system with a

chat-based UI, a custom Prefix manager with color support, and chat formatting.


Features

--------

1. Kit System

- Configurable Kits: Create unlimited kits in config.json.

- User Friendly: Players can type /kit to see a clickable "Available Kits" menu.

- One-Time Claiming: Prevents players from abusing starter kits (saved in claimed.json).

- Custom Commands: Kits run console commands (like giving items or XP).


2. Prefix System

- Custom Ranks/Tags: Set custom prefixes for any player (e.g., [Owner], [VIP]).

- Color Support: Supports colors using '$' or '&' codes (e.g., $c[Admin]).

- Persistence: Prefixes are saved automatically and persist across restarts.


3. Chat Formatting

- Automatic Coloring: Chat messages automatically display player prefixes.

- Clean Format: [Prefix] PlayerName: Message


Commands

--------

-- Kit Commands --

/kit -> Opens the Kit Menu (Clickable Claim buttons!)

/kit claim <name> -> Manually claim a specific kit (e.g., /kit claim starter)


-- Prefix Commands --

/prefix add <player> <text> -> Sets a player's prefix.

Usage: /prefix add Name $c[Admin]

(Use '$' for colors if '&' is stripped)

/prefix remove <player> -> Removes a player's prefix.


Configuration

-------------

The plugin creates a 'mods/HyEssentials' folder containing:


1. config.json

- Customize your kits here.

- Example:

"starter": {

"display_name": "Starter Kit",

"commands": [

"give {player} weapon_sword_wood --quantity=1",

"give {player} plant_fruit_apple --quantity=5"

]

}


2. prefixes.json

- Stores player prefixes (Do not edit manually unless server is off).


3. claimed.json

- Stores who has claimed which kit (Delete specific entries to reset a player's claim).


Installation

------------

1. Drop 'HyEssentials.jar' into your server's 'mods/' folder.

2. Restart the server.

3. Enjoy!


================================================================================