https://github.com/ghostrider584/hytale-gradle-plugin
A Gradle plugin to streamline Hytale plugin development.
https://github.com/ghostrider584/hytale-gradle-plugin
hytale hytale-mod hytale-modding hytale-plugin hytale-server java
Last synced: 5 months ago
JSON representation
A Gradle plugin to streamline Hytale plugin development.
- Host: GitHub
- URL: https://github.com/ghostrider584/hytale-gradle-plugin
- Owner: GhostRider584
- License: mit
- Created: 2026-01-15T22:50:21.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2026-01-20T03:37:44.000Z (5 months ago)
- Last Synced: 2026-01-20T18:36:34.016Z (5 months ago)
- Topics: hytale, hytale-mod, hytale-modding, hytale-plugin, hytale-server, java
- Language: Kotlin
- Homepage:
- Size: 68.4 KB
- Stars: 17
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hytale Gradle Plugin
A Gradle plugin to streamline Hytale plugin development.
## Usage
### 1. Configure Plugin Repository
Since this plugin is hosted on the Smolder repository, you must tell Gradle where to find it.
Add this to your `settings.gradle.kts` file:
```kotlin
pluginManagement {
repositories {
maven("https://repo.smolder.fr/public/")
gradlePluginPortal()
}
}
```
### 2. Apply the Plugin
In your `build.gradle.kts`:
```kotlin
plugins {
id("fr.smolder.hytale.dev") version "0.0.4"
}
```
### Configuration
Configure the plugin using the `hytale` block:
```kotlin
hytale {
// Optional: Override Hytale installation path (defaults to OS-specific standard location)
// hytalePath.set("...")
// Optional: patch line (defaults to "release")
patchLine.set("release")
// Optional: game version (defaults to "latest")
gameVersion.set("latest")
// Auto-update manifest.json during build? (defaults to true)
autoUpdateManifest.set(true)
// Memory configuration
minMemory.set("2G")
maxMemory.set("4G")
// Use AOT cache for faster startup (defaults to true)
useAotCache.set(true)
// You can add extra server arguments
serverArgs.add("--your-custom-arg")
// Decompilation settings
vineflowerVersion.set("1.11.2")
decompileFilter.set(listOf("com/hypixel/**"))
decompilerHeapSize.set("6G")
// Automatically attach decompiled sources to IDE (defaults to true)
includeDecompiledSources.set(true)
}
```
### Tasks
- `./gradlew runServer`: Starts the Hytale server with your plugin loaded.
- `./gradlew build`: Builds the project and updates the `manifest.json`.
- `./gradlew decompileServer`: Decompiles the Hytale Server JAR and creates a `-sources.jar`.
## Contributing
Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.
## License
This project is licensed under the MIT License.