https://github.com/thegatesdev/paper-plugin-gradle
Overengineered Paper plugin template
https://github.com/thegatesdev/paper-plugin-gradle
minecraft minecraft-plugin paper-plugin papermc template
Last synced: 8 months ago
JSON representation
Overengineered Paper plugin template
- Host: GitHub
- URL: https://github.com/thegatesdev/paper-plugin-gradle
- Owner: thegatesdev
- License: apache-2.0
- Created: 2025-04-25T20:19:11.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-06T19:18:42.000Z (8 months ago)
- Last Synced: 2025-08-06T21:12:29.456Z (8 months ago)
- Topics: minecraft, minecraft-plugin, paper-plugin, papermc, template
- Language: Java
- Homepage:
- Size: 120 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Paper plugin Gradle template
Template code for setting up a `1.21.8` Paper plugin with Gradle.
I use this for my personal work.
You may use it too, if you find it useful.
Keep in mind this is an overengineered template.
Consider only using this as inspiration.
A simple Maven setup will often suffice.
## Contents
- Bootstrapper setup
- Brigadier command setup
- Auto generate `paper-plugin.yml`
- Run Paper server with Gradle
- Build options configured with `gradle.properties`
- Dependencies configured with `libs.versions.toml`
- Build logic stuffed away in convention plugins
## Rebrand
Files to insert your plugin's branding:
| Location | Edit |
|-------------------------|--------------------|
| `./settings.gradle.kts` | `rootProject.name` |
| `./gradle.properties` | All properties |
| `./paper/src/main/java` | Package name |
## Thanks to
[PaperMC](https://github.com/PaperMC) for the [Paper](https://github.com/PaperMC/Paper) server software.
[jpenilla](https://github.com/jpenilla) for [resource-factory](https://github.com/jpenilla/resource-factory) and [run-task](https://github.com/jpenilla/run-task).
[radoslaw-panuszewski](https://github.com/radoslaw-panuszewski) for [typesafe-conventions](https://github.com/radoslaw-panuszewski/typesafe-conventions-gradle-plugin).