run-task's Introduction

Run <Paper|Velocity|Waterfall>

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

Basic Usage

In build.gradle.kts:

plugins {
  // Apply the plugin
  id("xyz.jpenilla.run-paper") version "2.3.0"
}

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.20.4")
  }
}

You can now run a Paper server simply by invoking the runServer task!

Run Velocity

Basic Usage

In build.gradle.kts:

plugins {
  // Apply the plugin
  id("xyz.jpenilla.run-velocity") version "2.3.0"
}

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

Basic Usage

In build.gradle.kts:

plugins {
  // Apply the plugin
  id("xyz.jpenilla.run-waterfall") version "2.3.0"
}

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")
  }
}