https://github.com/jpenilla/run-task
Gradle plugins adding tasks to run Minecraft server and proxy software
https://github.com/jpenilla/run-task
gradle-plugin minecraft-development minecraft-proxy minecraft-server paper papermc plugin-development run-configuration velocity waterfall
Last synced: 14 days ago
JSON representation
Gradle plugins adding tasks to run Minecraft server and proxy software
- Host: GitHub
- URL: https://github.com/jpenilla/run-task
- Owner: jpenilla
- License: apache-2.0
- Created: 2021-05-18T11:57:41.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-01T02:35:59.000Z (about 2 months ago)
- Last Synced: 2025-04-03T22:07:34.340Z (23 days ago)
- Topics: gradle-plugin, minecraft-development, minecraft-proxy, minecraft-server, paper, papermc, plugin-development, run-configuration, velocity, waterfall
- Language: Kotlin
- Homepage:
- Size: 575 KB
- Stars: 276
- Watchers: 2
- Forks: 20
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Run
[](https://github.com/jpenilla/run-task/actions) [](LICENSE)
This repository houses a suite of plugins which add tasks to automatically download and run Minecraft server/proxy
software along with your plugin built by Gradle. This provides a streamlined method of integration testing plugins.
Run Paper
[](https://plugins.gradle.org/plugin/xyz.jpenilla.run-paper)
### Basic Usage
In `build.gradle.kts`:
```kotlin
plugins {
// Apply the plugin
id("xyz.jpenilla.run-paper") version "2.3.1"
}
tasks {
runServer {
// Configure the Minecraft version for our task.
// This is the only required configuration besides applying the plugin.
// Your plugin's jar (or shadowJar if present) will be used automatically.
minecraftVersion("1.21.1")
}
}
```
You can now run a Paper server simply by invoking the `runServer` task!
Run Velocity
[](https://plugins.gradle.org/plugin/xyz.jpenilla.run-velocity)
### Basic Usage
In `build.gradle.kts`:
```kotlin
plugins {
// Apply the plugin
id("xyz.jpenilla.run-velocity") version "2.3.1"
}
tasks {
runVelocity {
// Configure the Velocity version for our task.
// This is the only required configuration besides applying the plugin.
// Your plugin's jar (or shadowJar if present) will be used automatically.
velocityVersion("3.3.0-SNAPSHOT")
}
}
```
You can now run a Velocity proxy simply by invoking the `runVelocity` task!
Run Waterfall
[](https://plugins.gradle.org/plugin/xyz.jpenilla.run-waterfall)
### Basic Usage
In `build.gradle.kts`:
```kotlin
plugins {
// Apply the plugin
id("xyz.jpenilla.run-waterfall") version "2.3.1"
}
tasks {
runWaterfall {
// Configure the Waterfall version for our task.
// This is the only required configuration besides applying the plugin.
// Your plugin's jar (or shadowJar if present) will be used automatically.
waterfallVersion("1.20")
}
}
```
You can now run a Waterfall proxy simply by invoking the `runWaterfall` task!
Check out [the wiki](https://github.com/jpenilla/run-task/wiki) for more detailed usage information.