Skip to main content

Hylight

Hylight is a Gradle plugin designed to simplify creating Hytale plugins.

warning

Hylight is unstable software! There is missing functionality and possibly bugs. Use at your own risk during this early development phase.

Quick Start​

We're planning to release a plugin template for Hylight soon. Until then, follow these instructions to get started.

1. Create a New Project​

Create a new Gradle-based project in your IDE of choice (IntelliJ IDEA, Eclipse, VS Code, etc.).

2. Enable the Plugin​

Add the Nexusrealms Maven repository to your settings.gradle:

settings.gradle
pluginManagement {
    repositories {
        maven {
            name = 'Nexusrealms'
            url = 'https://maven.riftrealms.de/releases'
        }
        mavenCentral()
        gradlePluginPortal()
    }
}

Apply the plugin in your build.gradle:

build.gradle
plugins {
    id 'de.nexusrealms.hylight' version "0.1.0"
}

3. Set Up the Hytale Downloader​

  1. Download the Hytale Downloader CLI
  2. Extract the archive
  3. Copy the appropriate executable for your platform into your project directory

4. Configure the Downloader Path​

Create a gradle.properties file in your project root (if it doesn't exist) and set the path to the downloader:

gradle.properties
# Set this to match your executable filename
hd=hytale-downloader-windows-amd64.exe

Available executables:

  • hytale-downloader-windows-amd64.exe - Windows
  • hytale-downloader-linux-amd64 - Linux

5. Add Dependencies​

Run the addDependency Gradle task:

./gradlew addDependency
note

On the first run, you will need to authenticate the downloader via OAuth. Watch the console for authentication links.

6. Start Modding!​

You're now ready to create your Hytale plugin:

  1. Add a manifest.json to describe your plugin
  2. Create your main plugin class
  3. Write your code!

7. Run Your Plugin​

When you want to test your plugin on a local server, run:

./gradlew runServer

Important Notes​

.gitignore​

Make sure to add the following to your .gitignore:

# Hytale Downloader - use the name you've used
hytale-downloader-windows-amd64.exe
.hytale-downloader-credentials.json

This prevents accidentally committing the downloader executable and your OAuth credentials.

Support​

Need help? Join our Discord server for support and discussions.