Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sya-ri/minecraft-server-gradle-plugin
Launch Minecraft servers using Gradle task. For Bukkit, Spigot, Paper, etc..
https://github.com/sya-ri/minecraft-server-gradle-plugin
bukkit bukkit-plugin bungeecord bungeecord-plugin fabric fabric-mod gradle gradle-plugin minecraft minecraft-server mohist mohist-plugin paper paper-plugin spigot spigot-plugin velocity velocity-plugin waterfall waterfall-plugin
Last synced: about 4 hours ago
JSON representation
Launch Minecraft servers using Gradle task. For Bukkit, Spigot, Paper, etc..
- Host: GitHub
- URL: https://github.com/sya-ri/minecraft-server-gradle-plugin
- Owner: sya-ri
- License: mit
- Created: 2021-06-23T13:00:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T19:51:18.000Z (5 days ago)
- Last Synced: 2024-09-21T11:02:54.905Z (4 days ago)
- Topics: bukkit, bukkit-plugin, bungeecord, bungeecord-plugin, fabric, fabric-mod, gradle, gradle-plugin, minecraft, minecraft-server, mohist, mohist-plugin, paper, paper-plugin, spigot, spigot-plugin, velocity, velocity-plugin, waterfall, waterfall-plugin
- Language: Kotlin
- Homepage:
- Size: 294 KB
- Stars: 33
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# minecraft-server-gradle-plugin
[](https://github.com/sya-ri/minecraft-server-gradle-plugin/actions?query=workflow%3A%22Pre+Merge+Checks%22)
[](LICENSE)
[](https://plugins.gradle.org/plugin/dev.s7a.gradle.minecraft.server)
Launch Minecraft servers using Gradle task. For Bukkit, Spigot, Paper, etc..
## Installation
### build.gradle
```groovy
plugins {
id 'dev.s7a.gradle.minecraft.server' version '3.1.0'
}
```
### build.gradle.kts
```kotlin
plugins {
id("dev.s7a.gradle.minecraft.server") version "3.1.0"
}
```
## Options
| Name | Default | Description |
|-----------------|-------------------------|-----------------------------------------------------------------------------------------|
| jarUrl | **Required**️ | URL to Download the .jar |
| jarName | `server.jar` | Jar File Name After Download |
| serverDirectory | `build/MinecraftServer` | Working Directory |
| jvmArgument | `[]` | [Java Options](https://docs.oracle.com/javase/7/docs/technotes/tools/windows/java.html) |
| serverArgument | `[]` | [Server Options](https://www.spigotmc.org/wiki/start-up-parameters/) |
| nogui | `true` | Without Vanilla GUI |
| agreeEula | `false` | Agree to the Minecraft EULA |
## Example
> [!WARNING]
> This plugin doesn't have a default task. So you have to define it yourself.
### Simple usage
#### build.gradle.kts
```kotlin
task("launchMinecraftServer") {
jarUrl.set(JarUrl.Paper("1.19.2"))
agreeEula.set(true)
}
```
### For testing a plugin
#### build.gradle.kts
```kotlin
task("testPlugin") {
dependsOn("build")
doFirst {
copy {
from(buildDir.resolve("libs/${project.name}.jar"))
into(buildDir.resolve("MinecraftServer/plugins"))
}
}
jarUrl.set(JarUrl.Paper("1.19.2"))
agreeEula.set(true)
}
```
### For testing a multi-version supporting plugin
#### build.gradle.kts
```kotlin
listOf(
"8" to "1.8.8",
"9" to "1.9.4",
"10" to "1.10.2",
"11" to "1.11.2",
"12" to "1.12.2",
"13" to "1.13.2",
"14" to "1.14.4",
"15" to "1.15.2",
"16" to "1.16.5",
"17" to "1.17.1",
"18" to "1.18.2",
"19" to "1.19.4",
"20" to "1.20.4"
).forEach { (name, version) ->
task("testPlugin$name") {
dependsOn("build")
doFirst {
copy {
from(buildDir.resolve("libs/${project.name}.jar"))
into(buildDir.resolve("MinecraftServer$name/plugins"))
}
}
serverDirectory.set(buildDir.resolve("MinecraftServer$name").absolutePath)
jarUrl.set(JarUrl.Paper(version))
agreeEula.set(true)
}
}
```
## Supported `JarUrl`
- Paper
- Velocity
- Waterfall
- Fabric
- Mohist
- LocalFile