HytaleLoader

HytaleLoader is a Java library designed to simplify the development of mods for the Hytale server. It provides an abstraction layer inspired by the Bukkit/Spigot API, allowing developers to create mods using annotations for event handling and command registration and much more!

⚠️ Disclaimer

This is an unofficial modding tool for Hytale. Hytale is in alpha and APIs may change.

Hytale Version Compatibility

Note: HytaleLoader can be incomaptible if you don't download the correct version for your Hytale version. You can find the correct version in the releases page.

HytaleLoader Version	Hytale Version
1.0.7 (Unreleased)	2026.01.17
1.0.6	1.0.0 (2026.01.13)
1.0.5	1.0.0 (2026.01.13)
1.0.4	1.0.0 (2026.01.13)
1.0.3	1.0.0 (2026.01.13)
1.0.2	1.0.0 (2026.01.13)
1.0.1	1.0.0 (2026.01.13)
1.0.0	1.0.0 (2026.01.13)

Installation (Gradle)

Building locally

git clone https://github.com/Program132/HL.git
cd HL
./gradlew build

Adding dependency

Add the following to your build.gradle:

repositories {
    mavenLocal()
    // ...
}

dependencies {
    compileOnly 'com.hypixel.hytale:HytaleServer:2026.01.17'
    implementation 'fr.hytale.loader:HytaleLoader:1.0.7'
}

Installation (Maven)

Building locally

git clone https://github.com/Program132/HL.git
cd HL/HytaleLoader
mvn clean install

Adding dependency

Add the following to your pom.xml:

<dependency>
    <groupId>fr.hytale.loader</groupId>
    <artifactId>HytaleLoader</artifactId>
    <version>1.0.7</version>
    <scope>provided</scope>
</dependency>

Quick Start

Basic Plugin

public class MyMod extends SimplePlugin {

    public MyMod(JavaPluginInit init) {
        super(init);
    }

    @Override
    public void onEnable() {
        getLogger().info("MyMod enabled!");
    }

    @EventHandler
    public void onPlayerJoin(PlayerJoinEvent event) {
        Player player = event.getPlayer();
        player.sendMessage("Welcome " + player.getName() + "!");
        
        // Get player location
        Location loc = player.getLocation();
        player.sendMessage("You are at: " + loc.getX() + ", " + loc.getY() + ", " + loc.getZ());
    }

    @Command(name = "hello", description = "Says hello")
    public void onHello(CommandContext ctx) {
        ctx.sender().sendMessage(Message.raw("Hello World!"));
    }
}

Documentation

Comprehensive documentation is available in the doc/ directory:

Getting Started

• 📖 README - Complete documentation overview
• 🚀 Getting Started - Installation and first plugin
• 📝 Changelog - Version history

Core APIs

• 👤 Player API - Player management
• 🌍 World API - World manipulation
• 🧱 Block API - Block operations
• 📍 Location API - Position and rotation
• 👾 Entity API - Entity management
• 📊 Player Stats API - Health, stamina, mana

Data Storage

• 🔴 Redis API - Redis database
• 🐬 MySQL API - MySQL database

Systems

• 🎪 Event System - Event handling
• ⚔️ Command System - Command registration
• 🕐 Scheduler API - Task scheduling
• 🔐 Permission API - Permissions
• 🛠️ Command Utils - Command helpers
• 📝 Config API - Configuration system

Reference

• 📦 Standard Events - Available events
• JavaDoc - Full API reference

Development Workflow

Project Structure

HL/
├── HytaleLoader/              # Core library
│   ├── src/main/java/fr/hytale/loader/
│   │   ├── api/               # Public API
│   │   │   ├── inventory/     # Inventory classes
│   │   │   ├── ui/            # UI classes
│   │   │   ├── Block.java     # Block wrapper
│   │   │   ├── ChatColor.java # Chat color enums
│   │   │   ├── Entity.java    # Entity wrapper
│   │   │   ├── GameMode.java  # GameMode enum
│   │   │   ├── Item.java      # Item wrapper
│   │   │   ├── Location.java  # Location wrapper
│   │   │   ├── Player.java    # Player wrapper
│   │   │   ├── Server.java    # Server wrapper
│   │   │   ├── SoundCategory.java # Sound categories
│   │   │   ├── Time.java      # Time wrapper
│   │   │   ├── WeatherType.java # Weather types
│   │   │   └── World.java     # World wrapper
│   │   ├── command/           # Command system
│   │   ├── config/            # Configuration system
│   │   ├── datastorage/       # Data storage
│   │   ├── event/             # Event system
│   │   ├── internal/          # Internal dispatchers
│   │   ├── permission/        # Permission system
│   │   ├── plugin/            # Plugin base classes
│   │   ├── scheduler/         # Task scheduling
│   │   └── utils/             # Utilities
└── TestMod/                   # Example mod

Contributing

Contributions are welcome! Feel free to:

• Open issues for bugs or feature requests
• Submit pull requests
• Improve documentation
• Share your plugins made with HytaleLoader

See CHANGELOG.md for detailed version history.

Support

For support, questions, or to showcase your plugins:

• Open an issue on GitHub
• Check the documentation in doc/

---

Made with ❤️ for the Hytale modding community