fairy-hytale-template

A Hytale server plugin template using the Fairy framework.

Getting Started

Prerequisites

• Java 21 or higher
• Hytale Server (will be downloaded automatically)
• Valid Hytale credentials for authenticated mode

Building

./gradlew shadowJar

The compiled plugin JAR will be in build/libs/.

Running the Development Server

./gradlew runHytaleServer

This will:

1. Download and prepare the Hytale server
2. Generate necessary manifest files
3. Start the server with your plugin loaded

Configuration

Edit gradle.properties to customize:

• group - Your project's group ID
• name - Plugin name
• version - Plugin version
• package - Main package for your classes

Edit build.gradle.kts to configure the server runner:

• bindAddress - Server bind address (default: 127.0.0.1:7777)
• authMode - Authentication mode: authenticated, unauthenticated, or mixed
• allowOp - Allow OP commands
• disableSentry - Disable Sentry error reporting

Project Structure

src/main/java/org/example/template/
    HytaleTemplatePlugin.java    # Main plugin class
src/main/resources/
    Common/UI/Custom/            # Custom UI files (.ui)

Adding Dependencies

Add Fairy modules in build.gradle.kts:

dependencies {
    api("io.fairyproject:hytale-command")
    api("io.fairyproject:core-config")
    // Add more modules as needed
}

Documentation

• Fairy Framework Documentation
• Hytale Server Modding