Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 1 day 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 (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T08:39:34.000Z (14 days ago)
- Last Synced: 2024-09-19T04:56:02.151Z (7 days ago)
- Topics: gradle-plugin, minecraft-development, minecraft-proxy, minecraft-server, paper, papermc, plugin-development, run-configuration, velocity, waterfall
- Language: Kotlin
- Homepage:
- Size: 578 KB
- Stars: 214
- Watchers: 1
- Forks: 18
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Run
[![build](https://img.shields.io/github/actions/workflow/status/jpenilla/run-task/build.yml?branch=master)](https://github.com/jpenilla/run-task/actions) [![license](https://img.shields.io/badge/license-Apache--2.0-blue)](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
[![latest release](https://img.shields.io/gradle-plugin-portal/v/xyz.jpenilla.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
[![latest release](https://img.shields.io/gradle-plugin-portal/v/xyz.jpenilla.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
[![latest release](https://img.shields.io/gradle-plugin-portal/v/xyz.jpenilla.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.