{"id":14969635,"url":"https://github.com/crimsonwarpedcraft/plugin-template","last_synced_at":"2025-08-12T21:03:38.948Z","repository":{"id":37955910,"uuid":"283418046","full_name":"CrimsonWarpedcraft/plugin-template","owner":"CrimsonWarpedcraft","description":"A template for building PaperMC Minecraft server plugins","archived":false,"fork":false,"pushed_at":"2025-07-22T03:06:33.000Z","size":817,"stargazers_count":52,"open_issues_count":2,"forks_count":14,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-22T05:22:39.717Z","etag":null,"topics":["checkstyle","dependabot","gitops","gradle","issue-templates","java","junit5","minecraft","papermc","shadowjar","spotbugs","stale-bot","workflows"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CrimsonWarpedcraft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"leviem1"}},"created_at":"2020-07-29T06:30:00.000Z","updated_at":"2025-07-22T02:53:59.000Z","dependencies_parsed_at":"2023-12-19T07:02:54.471Z","dependency_job_id":"f84a206b-5adc-4bda-bbd5-a93e57cf4890","html_url":"https://github.com/CrimsonWarpedcraft/plugin-template","commit_stats":{"total_commits":334,"total_committers":3,"mean_commits":"111.33333333333333","dds":0.3682634730538922,"last_synced_commit":"c08c30852c7df4be2656a647cffb1113b5ea6ada"},"previous_names":[],"tags_count":96,"template":true,"template_full_name":null,"purl":"pkg:github/CrimsonWarpedcraft/plugin-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrimsonWarpedcraft%2Fplugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrimsonWarpedcraft%2Fplugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrimsonWarpedcraft%2Fplugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrimsonWarpedcraft%2Fplugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrimsonWarpedcraft","download_url":"https://codeload.github.com/CrimsonWarpedcraft/plugin-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrimsonWarpedcraft%2Fplugin-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270134963,"owners_count":24533191,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-12T02:00:09.011Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checkstyle","dependabot","gitops","gradle","issue-templates","java","junit5","minecraft","papermc","shadowjar","spotbugs","stale-bot","workflows"],"created_at":"2024-09-24T13:42:09.066Z","updated_at":"2025-08-12T21:03:38.934Z","avatar_url":"https://github.com/CrimsonWarpedcraft.png","language":"Java","funding_links":["https://github.com/sponsors/leviem1"],"categories":[],"sub_categories":[],"readme":"# PaperMC/Spigot Minecraft Server Plugin Template\nA template for building PaperMC/Spigot Minecraft server plugins!\n\n\u003c!-- TODO: CHANGE ME --\u003e\n[![Test and Release](https://github.com/CrimsonWarpedcraft/plugin-template/actions/workflows/main.yml/badge.svg)](https://github.com/CrimsonWarpedcraft/plugin-template/actions/workflows/main.yml)\n\n\u003c!-- TODO: CHANGE ME --\u003e\n[![](https://dcbadge.limes.pink/api/server/5XMmeV6EtJ)](https://discord.gg/5XMmeV6EtJ)\n\n## Features\n### Github Actions 🎬\n* Automated builds, testing, and release drafting\n* [Discord notifcations](https://github.com/marketplace/actions/discord-message-notify) for snapshots and releases\n\n### Bots 🤖\n* **Probot: Stale**\n    * Mark issues stale after 30 days\n* **Dependabot**\n    * Update GitHub Actions workflows\n    * Update Gradle dependencies\n\n### Issue Templates 📋\n* Bug report template\n* Feature request template\n\n### Gradle Builds 🏗\n* Shadowed [PaperLib](https://github.com/PaperMC/PaperLib) build\n* [Checkstyle](https://checkstyle.org/) Google standard style check\n* [SpotBugs](https://spotbugs.github.io/) code analysis\n* [JUnit](https://junit.org/) testing\n\n### Config Files 📁\n* Sample plugin.yml with autofill name, version, and main class.\n* Empty config.yml (just to make life \\*that\\* much easier)\n* Gradle build config\n* Simple .gitignore for common Gradle files\n\n## Usage\nIn order to use this template for yourself, there are a few things that you will need to keep in mind.\n\n### Release Info\n#### PaperMC Version Mapping\nHere's a list of the PaperMC versions and the versions of this latest compatible version.\n\n| PaperMC | ExamplePlugin |\n|---------|---------------|\n| 1.21.7  | 4.0.15+       |\n| 1.21.6  | 4.0.14        |\n| 1.21.5  | 4.0.12        |\n| 1.21.4  | 4.0.7         |        \n| 1.21.3  | 4.0.3         |\n| 1.21.1  | 4.0.2         |\n| 1.21    | 3.12.1        |\n| 1.20.6  | 3.11.0        |\n| 1.19.4  | 3.2.1         |\n| 1.18.2  | 3.0.2         |\n| 1.17.1  | 2.2.0         |\n| 1.16.5  | 2.1.2         |\n\nThis chart would make more sense if this plugin actually did anything and people would have a reason\nto be looking for older releases to run on older servers.\n\nTo use this as a template, just use the latest version of this project and update the PaperMC\nversion as needed. See more info on release stability below.\n\n#### Release and Versioning Strategy\nStable versions of this repo are tagged `vX.Y.Z` and have an associated [release](https://github.com/CrimsonWarpedcraft/plugin-template/releases).\n\nTesting versions of this repo are tagged `vX.Y.Z-RC-N` and have an associated [pre-release](https://github.com/CrimsonWarpedcraft/plugin-template/releases).\n\nDevelopment versions of this repo are pushed to the master branch and are **not** tagged.\n\n| Event             | Plugin Version Format | CI Action                        | GitHub Release Draft? |\n|-------------------|-----------------------|----------------------------------|-----------------------|\n| PR                | yyMMdd-HHmm-SNAPSHOT  | Build and test                   | No                    |\n| Cron              | yyMMdd-HHmm-SNAPSHOT  | Build, test, and notify          | No                    |\n| Push to `main`    | 0.0.0-SNAPSHOT        | Build, test, release, and notify | No                    |\n| Tag `vX.Y.Z-RC-N` | X.Y.Z-SNAPSHOT        | Build, test, release, and notify | Pre-release           |\n| Tag `vX.Y.Z`      | X.Y.Z                 | Build, test, release, and notify | Release               |\n\n### Discord Notifications\nIn order to use Discord notifications, you will need to create two GitHub secrets. `DISCORD_WEBHOOK_ID` \nshould be set to the id of your Discord webhook. `DISCORD_WEBHOOK_TOKEN` will be the token for the webhook.\n\nYou can find these values by copying the Discord Webhook URL:  \n`https://discord.com/api/webhooks/\u003cDISCORD_WEBHOOK_ID\u003e/\u003cDISCORD_WEBHOOK_TOKEN\u003e`\n\nOptionally, you can also configure `DISCORD_RELEASE_WEBHOOK_ID` and `DISCORD_RELEASE_WEBHOOK_TOKEN`\nto send release announcements to a separate channel.\n\nFor more information, see [Discord Message Notify](https://github.com/marketplace/actions/discord-message-notify).\n\n---\n\n**I've broken the rest of the changes up by their files to make things a bit easier to find.**\n\n---\n\n### settings.gradle\nUpdate the line below with the name of your plugin.\n\n```groovy\nrootProject.name = 'ExamplePlugin'\n```\n\n### build.gradle\nMake sure to update the `group` to your package's name in the following section.\n\n```groovy\ngroup = \"com.crimsonwarpedcraft.exampleplugin\"\n```\n\nAdd any required repositories for your dependencies in the following section.\n\n```groovy\nrepositories {\n    maven {\n        name 'papermc'\n        url 'https://papermc.io/repo/repository/maven-public/'\n        content {\n            includeModule(\"io.papermc.paper\", \"paper-api\")\n            includeModule(\"io.papermc\", \"paperlib\")\n            includeModule(\"net.md-5\", \"bungeecord-chat\")\n        }\n    }\n\n    mavenCentral()\n}\n```\n\nAlso, update your dependencies as needed (of course).\n\n```groovy\ndependencies {\n    compileOnly 'io.papermc.paper:paper-api:1.21.6-R0.1-SNAPSHOT'\n    compileOnly 'com.github.spotbugs:spotbugs-annotations:4.9.3'\n    implementation 'io.papermc:paperlib:1.0.8'\n    spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.14.0'\n    testCompileOnly 'com.github.spotbugs:spotbugs-annotations:4.9.3'\n    testImplementation 'io.papermc.paper:paper-api:1.21.6-R0.1-SNAPSHOT'\n    testImplementation 'org.junit.jupiter:junit-jupiter:5.13.1'\n    testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.13.1'\n}\n```\n\n### src/main/resources/plugin.yml\nFirst, update the following with your information.\n\n```yaml\nauthor: AUTHOR\ndescription: DESCRIPTION\n```\n\nNext, the `commands` and `permissions` sections below should be updated as needed.\n\n```yaml\ncommands:\n  ex:\n    description: Base command for EXAMPLE\n    usage: \"For a list of commands, type /ex help\"\n    aliases: example\npermissions:\n  example.test:\n    description: DESCRIPTION\n    default: true\n  example.*:\n    description: Grants all other permissions\n    default: false\n    children:\n      example.test: true\n```\n\n### .github/dependabot.yml\nYou will need to replace all instances of `leviem1`, such as the one below, with your GitHub\nusername.\n\n```yaml\nreviewers:\n  - \"leviem1\"\n```\n\n### .github/CODEOWNERS\nYou will need to replace `leviem1`, with your GitHub username.\n\n```text\n*   @leviem1\n```\n\n### .github/FUNDING.yml\nUpdate or delete this file, whatever applies to you.\n\n```yaml\ngithub: leviem1\n```\n\nFor more information see: [Displaying a sponsor button in your repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)\n\n### CODE_OF_CONDUCT.md\nIf you chose to adopt a Code of Conduct for your project, please update line 63 with your preferred\ncontact method.\n\n## Creating a Release\nBelow are the steps you should follow to create a release.\n\n1. Create a tag on `main` using semantic versioning (e.g. v0.1.0)\n2. Push the tag and get some coffee while the workflows run\n3. Publish the release draft once it's been automatically created\n\n## Building locally\nThanks to [Gradle](https://gradle.org/), building locally is easy no matter what platform you're on. Simply run the following command:\n\n```text\n./gradlew build\n```\n\nThis build step will also run all checks and tests, making sure your code is clean.\n\nJARs can be found in `build/libs/`.\n\n## Contributing\nSee [CONTRIBUTING.md](https://github.com/CrimsonWarpedcraft/plugin-template/blob/main/CONTRIBUTING.md).\n\n---\n\nI think that's all... phew! Oh, and update this README! ;)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrimsonwarpedcraft%2Fplugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrimsonwarpedcraft%2Fplugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrimsonwarpedcraft%2Fplugin-template/lists"}