Skip to content

carbon-host/carbon-plugin

 
 

Repository files navigation

Multi-Module Plugin Template

This is a template repository for creating Minecraft plugins using Kotlin for Paper, Bungee and Velocity. 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

  • 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.
  • 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:

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
  1. Open the project in your preferred Kotlin-compatible IDE (e.g., IntelliJ IDEA).
  2. Customize the project information in all the build files and modules

Building your plugin

You can build all of your modules using Gradle:

./gradlew build

This command will compile all your code into one plugin and place it in the /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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages

  • Kotlin 100.0%