# HyCore - Essential Server Plugin for Hytale
**The all-in-one essentials plugin your Hytale server needs.**
HyCore provides a complete suite of essential features for running a community Hytale server. From economy and teleportation to moderation tools and permissions - everything you need in one lightweight package.
---
## Features
### Economy System
- Player balances with persistent storage
- `/pay` - Send money to other players
- `/balance` - Check your current balance
- `/baltop` - Leaderboard of richest players
- Admin commands to give, take, and set balances
### Teleportation
- **Homes** - Set multiple personal home locations
- **Warps** - Server-wide warp points for all players
- **Spawn** - Central spawn point teleportation
- **TPA** - Request to teleport to other players
- **Back** - Return to your previous location
- Teleport warmup with movement cancellation
### Moderation Tools
- `/ban` & `/unban` - Ban management with reasons
- `/kick` - Remove players from the server
- `/mute` & `/unmute` - Chat moderation
- All actions logged with staff name and reason
### Permission System
- Create custom permission groups
- Assign players to groups
- Wildcard permission support (`hycore.*`)
- Easy JSON configuration
### Chat Roles
- Custom colored role tags in chat
- Create unlimited roles with hex colors
- Assign roles to players
---
## Commands
### Player Commands
| Command | Description |
|---------|-------------|
| `/balance`, `/bal` | Check your balance |
| `/pay <player> <amount>` | Send money to a player |
| `/baltop` | View richest players |
| `/home [name]` | Teleport to your home |
| `/sethome <name>` | Set a home location |
| `/delhome <name>` | Delete a home |
| `/homes` | List all your homes |
| `/spawn` | Teleport to spawn |
| `/back` | Return to last location |
| `/warp [name]` | Teleport to a warp (no args lists warps) |
| `/tpa <player>` | Request to teleport to a player |
| `/tpahere <player>` | Request a player to teleport to you |
| `/tpaccept` | Accept a teleport request |
| `/tpdeny` | Deny a teleport request |
### Staff Commands
| Command | Permission |
|---------|------------|
| `/kick <player> [reason]` | `hycore.kick` |
| `/ban <player> [reason]` | `hycore.ban` |
| `/unban <player>` | `hycore.unban` |
| `/mute <player> [reason]` | `hycore.mute` |
| `/unmute <player>` | `hycore.unmute` |
### Admin Commands
| Command | Permission |
|---------|------------|
| `/ecogive <player> <amount>` | `hycore.eco` |
| `/ecotake <player> <amount>` | `hycore.eco` |
| `/ecoset <player> <amount>` | `hycore.eco` |
| `/setwarp <name>` | `hycore.setwarp` |
| `/delwarp <name>` | `hycore.setwarp` |
| `/setspawn` | `hycore.setspawn` |
| `/setgroup <player> <group>` | `hycore.setgroup` |
---
## Installation
1. Download `HyCore.jar`
2. Place in your server's `plugins/` folder
3. Restart your server
4. Configure `plugins/HyCore/permissions.json`
---
## Permissions Example
```json
{
"groups": {
"owner": { "permissions": ["hycore.*"] },
"op": { "permissions": ["hycore.*"] },
"admin": { "permissions": ["hycore.kick", "hycore.ban", "hycore.unban", "hycore.mute", "hycore.unmute", "hycore.eco", "hycore.setwarp", "hycore.setspawn", "hycore.setgroup"] },
"moderator": { "permissions": ["hycore.kick", "hycore.ban", "hycore.unban", "hycore.mute", "hycore.unmute"] },
"helper": { "permissions": ["hycore.kick", "hycore.mute", "hycore.unmute"] },
"default": { "permissions": [] }
}
}
```
---
## Why HyCore?
- **Lightweight** - Minimal performance impact
- **All-in-One** - No need for multiple plugins
- **Easy Setup** - Works out of the box
- **Persistent Data** - SQLite database storage
- **Open Source** - Fully customizable
---
## Support
- [GitHub Issues](https://github.com/Galaxyz7/HyCore-Essentials/issues) - Bug reports & feature requests
---
**Made with love for the Hytale community.**
The HyCore - Essentials Team
