Hylight

Hylight - A Gradle plugin to simplify creating Hytale plugins.

warning

Hylight is unstable software! There is missing functionality and maybe also bugs.

Usage

We're planning to release a plugin template for Hylight soon. Until then, these instructions should work.

1. Create a new Gradle-based project in your IDE of choice

2. Enable the plugin

   • Add the following to your settings.gradle:
   settings.gradle

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

   • Add the following to your build.gradle:
   build.gradle

   plugins {
       id 'de.nexusrealms.hylight' version "0.1.2"
   }

3. Run the configureDownloader Gradle task

4. Run the addDependency Gradle task

   • On the first run, you will need to authenticate the downloader via OAuth. Wait for links to appear in the console.

5. You are now ready to mod! Add a manifest.json, add your main class, add your code!

6. When you want to run the server with your plugin, run the runServer Gradle task

7. Make sure to add the Hytale Downloader and the .hytale-downloader-credentials.json file to .gitignore

Support

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