Paper Plugin Template

Example project to get started with Paper plugin development and publication.

1. Gradle tasks

This project includes a build.gradle.kts configuration with useful tasks :

• Running a local Paper Minecraft server :

  • runDevBundleServer - Run a local Paper Minecraft server (source : https://github.com/jpenilla/run-task)
  • buildPluginAndRunServer - Run a local Paper Minecraft server with a new build of the plugin

• Plugin versioning :

  • incrementMajorVersion - Update the first digit of the project version
  • incrementMinorVersion - Update the second digit of the project version
  • incrementPatchVersion - Update the last digit of the project version

2. GitHub Action workflow

This project also includes a release.yml file for publishing new versions of your plugin on CurseForge, Modrinth and GitHub. Secrets and variables must be defined in the repository Security settings :

1. Secrets :
   • CURSEFORGE_TOKEN - CurseForge API token
   • MODRINTH_TOKEN - Modrinth Personal access token (with Write projects and Create versions permissions)
2. Variables :
   • CURSEFORGE_PROJECT_ID - CurseForge public project ID
   • MODRINTH_PROJECT_ID - Modrinth public project ID

If your prefer to store all your variables in gradle.properties (NOT YOUR SECRETS), or store them in GitHub variables, do not forget to update release.yml in accordingly.