https://github.com/thehale/papermc-plugin-template

A beginner-friendly template for creating your first Minecraft plugin!
https://github.com/thehale/papermc-plugin-template

beginner-friendly minecraft minecraft-plugin minecraft-plugin-template papermc papermc-plugin papermc-plugin-template

Last synced: about 1 month ago
JSON representation

A beginner-friendly template for creating your first Minecraft plugin!

• Host: GitHub
• URL: https://github.com/thehale/papermc-plugin-template
• Owner: thehale
• License: mpl-2.0
• Created: 2024-01-18T05:02:59.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2026-03-31T17:26:02.000Z (3 months ago)
• Last Synced: 2026-03-31T18:44:33.587Z (3 months ago)
• Topics: beginner-friendly, minecraft, minecraft-plugin, minecraft-plugin-template, papermc, papermc-plugin, papermc-plugin-template
• Language: Java
• Homepage:
• Size: 98.6 KB
• Stars: 0
• Watchers: 2
• Forks: 3
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          




# PaperMC Plugin Template

A template for developing custom plugins for PaperMC Minecraft Servers

[![Joseph Hale's software engineering blog](https://img.shields.io/badge/jhale.dev-black.svg?style=plastic&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNCIgaGVpZ2h0PSI0IiB2aWV3Qm94PSIwIDAgMS4wNTggMS4wNTgiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PGcgY29sb3I9IiMwMDAiIHBhaW50LW9yZGVyPSJmaWxsIG1hcmtlcnMgc3Ryb2tlIj48cGF0aCBkPSJNLjY0My43NTJhLjE1Ni4xNTYgMCAwMC0uMTMuMDU5Qy40NzYuODUuNDcuOTE3LjQ2OS45M2EuMDI1LjAyNSAwIDAwLjAyNi4wMjhoLjA2NmEuMDI1LjAyNSAwIDAwLjAyNC0uMDIuMTIuMTIgMCAwMS4wMi0uMDUyQy42MTguODcuNjMyLjg2OS42NTUuODY5aC4xMjJjMC0uMDAyLjA3Ni4wMDcuMTI5LS4wNUEuMTQzLjE0MyAwIDAwLjkyOC43ODcuMDI1LjAyNSAwIDAwLjkwNi43NTJILjY0M3oiIGZpbGw9IiMwNTAiLz48cGF0aCBkPSJNLjM5My40MWEuMDIuMDIgMCAwMC0uMDIuMDJ2LjI2YzAgLjAxMi4wMDEuMDI5LS4wMTQuMDQ0Qy4zMy43NTkuMjgyLjc1LjI2Ny43MzYuMjU3LjcyOC4yNS43MTMuMjQ0LjY4N0EuMDI1LjAyNSAwIDAwLjIyLjY3SC4xNTNhLjAyNC4wMjQgMCAwMC0uMDI1LjAyNmMuMDA0LjA1Mi4wMjUuMDkuMDUxLjExOWEuMTY3LjE2NyAwIDAwLjExMy4wNTJoLjAzNWEuMTg0LjE4NCAwIDAwLjExNS0uMDVBLjE4Mi4xODIgMCAwMC40OS42OTRWLjQzMUEuMDIuMDIgMCAwMC40Ny40MXpNLjc4Ny4zOWEuMDIuMDIgMCAwMC0uMDIuMDJ2LjI0MmMwIC4wMTEuMDA5LjAyLjAyLjAyaC4wNzdhLjAyLjAyIDAgMDAuMDItLjAyVi40MTFhLjAyLjAyIDAgMDAtLjAyLS4wMnpNLjM5My4yMThhLjAyLjAyIDAgMDAtLjAyLjAydi4wNzdjMCAuMDExLjAwOC4wMi4wMi4wMkguNDdhLjAyLjAyIDAgMDAuMDItLjAyVi4yMzhhLjAyLjAyIDAgMDAtLjAyLS4wMnpNLjU5LjFhLjAyLjAyIDAgMDAtLjAyLjAydi41MzJjMCAuMDExLjAwOS4wMi4wMi4wMmguMDc3YS4wMi4wMiAwIDAwLjAyLS4wMlYuMTJBLjAyLjAyIDAgMDAuNjY3LjF6IiBmaWxsPSIjMDBkNDAwIi8+PC9nPjwvc3ZnPg==)](https://jhale.dev)



## How to Use this Template

1. Make a copy of this repository.

   - On GitHub, press the **Use this template** button.

   - Or you can clone a copy: `git clone https://github.com/thehale/papermc-plugin-template`

2. Choose a name for your plugin (e.g. `my-plugin`).

   - Rename the repository.

   - Run `./gradlew renamePlugin -PnewAuthor=YOUR_GITHUB_USERNAME -PnewPluginName=YOUR_PLUGIN_NAME`

## Contributing

Please read the [Contributing Guide](./CONTRIBUTING.md)

## License

Copyright (c) 2023 Joseph Hale. All Rights Reserved

Licensed under the terms of the [Mozilla Public License version 2.0](./LICENSE).

> TL;DR *(not legal advice)*

> - New files of code of your own authorship can carry any license, open-source

>   or proprietary.

> - Changes to existing files (or files into which you copy code from this

>   project) must be released as open-source code under the terms of the MPL-2.0.