PaperMC Kotlin Template

Warning

This is a personal project created for fun and to help me quickly bootstrap new plugin projects. It's not recommended for serious/production use and likely contains bugs. Use at your own risk!

A modern, feature-rich template for creating Minecraft plugins using PaperMC and Kotlin. This template provides a foundation for developing high-performance, maintainable plugins with the latest tools and best practices.

Features

• Modern PaperMC API
  • Uses Loaders instead of ShadowJars.
• Gradle with Kotlin DSL
  • Includes Paperweight for NMS access.
• CommandAPI for streamlined command creation.
• Configurate for flexible and powerful configuration management.
• run-task for easily running the development server.
• CI/CD (GitHub Actions)
  • Automated code formatting with Spotless
• Ready to use utilities
  • Logger
• Bootstrapper script (bootstrap.py) to quickly customize and initialize your project.
• Database support using HikariCP
• Metrics using bStats

Usage

Bootstraping

Requirements:

• Python 3.10+
• Git (optional - you can download files directly from GitHub)

git clone https://github.com/feenko/PaperMC-Kotlin-Template.git PluginName
cd PluginName
python bootstrap.py

After running the bootstrapper, you will be asked to fill in some information about your plugin.

Development

Requirements:

• JDK 21
• Gradle

Running the development server

gradle runServer

Formatting the code

gradle spotlessApply

Building the plugin

gradle build

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Before submitting a pull request, please search for existing issues or create a new one to discuss your proposed changes.