diff --git a/README.md b/README.md index a4f09b6..f99daa2 100644 --- a/README.md +++ b/README.md @@ -210,14 +210,35 @@ dependencies { ### Configuring Server Testing +**Run Hytale Server** - A Gradle plugin to download and run a Hytale server for development and testing purposes. The server files will be located in the `run/` directory of the project. Before starting the server it will compile (shadowJar task) and copy the plugin jar to the server's `plugins/` folder. + +**Usage:** + Edit `build.gradle.kts`: ```kotlin runHytale { - jarUrl = "https://example.com/hytale-server.jar" // Update when available + jarUrl = "url to hytale server jar" } ``` +Run the server with: + +```bash +# Windows +gradlew.bat runServer + +# Linux/Mac +./gradlew runServer +``` + +**Features:** +- ✅ Automatic server JAR download and caching +- ✅ Compiles and deploys your plugin automatically +- ✅ Starts server with interactive console +- ✅ One-command workflow: `./gradlew runServer` +- ✅ Server files in `run/` directory (gitignored) + ### Implementing Your Plugin **Recommended folder structure:** diff --git a/build.gradle.kts b/build.gradle.kts index 377470e..ecfea96 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -29,7 +29,8 @@ dependencies { // Configure server testing runHytale { // TODO: Update this URL when Hytale server is available - jarUrl = "https://example.com/hytale-server.jar" + // Using Paper server as placeholder for testing the runServer functionality + jarUrl = "https://fill-data.papermc.io/v1/objects/d5f47f6393aa647759f101f02231fa8200e5bccd36081a3ee8b6a5fd96739057/paper-1.21.10-115.jar" } tasks {