Multi-Module Plugin Template

This is a template repository for creating Minecraft plugins using Kotlin for the Paper server software. It provides a multi-module structure using Gradle, perfect for developers looking to add modularity to their servers/plugins.

Note

Looking for a single-module template? Click here to check it out!

Table of Contents

• Features
• Prerequisites
• Getting started
  • Using the template
  • Building your project
  • Running the server
• Side-notes
• License

Features

• A pre-configured Gradle setup for building Paper plugins with Kotlin. The built-in libraries contains:
  • shadowJar: to shade your dependencies into the plugin.
  • Lamp: a simple to use commands annotation framework with Brigadier built into it.
  • Twilight: an API for developers creating plugins.
• A basic plugin template with sample code to get you started.
• Integration with Paper API for Minecraft plugin development.
• A well-organized project structure to keep your code clean and maintainable.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Java Development Kit (JDK) 8 or later
• Gradle or the built-in wrapper
• Paper server software (I'd assume you want to test your code...)

Getting started

To get started with this template, follow these steps:

Using the template

1. Click on the "Use this template" button at the top of this repository to create a new repository based on this template.
2. Clone your new repository to your local machine using Git:

git clone https://github.com/your-username/repository-name.git

3. Open the project in your preferred Kotlin-compatible IDE (e.g., IntelliJ IDEA).
4. Customize the project information in the <moduleName>/build.gradle.kts file.
5. Modify the <moduleName>/src/main/kotlin/com/example/pluginName/PluginName.kt file to start building your plugin.

Building your plugin

You can build all of your modules using Gradle:

./gradlew shadowJar

This command will compile your code, package it into a JAR file, and place it in the <moduleName>/build/libs/ directory. Each module has its own build folder.

Side-notes

• You can add more modules by clicking File → New → Project → Module and select your settings.
• Remember to change the plugin's package and information on the <moduleName>/src/main/kotlin/resources/plugin.yml file.
• You can learn more about Lamp by clicking here.
• We have a great community at learnspigot.com. You should definitely check it out! #notsponsored
• Feel free to implement anything you need and wish! The code is all yours.

License

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