https://github.com/vjh0107/plugin-jar
A Gradle plugin that streamlines the process of creating a plugin JAR.
https://github.com/vjh0107/plugin-jar
bukkit gradle gradle-plugin gradle-plugin-kotlin kotlin-dsl papermc spigot
Last synced: 3 months ago
JSON representation
A Gradle plugin that streamlines the process of creating a plugin JAR.
- Host: GitHub
- URL: https://github.com/vjh0107/plugin-jar
- Owner: vjh0107
- License: apache-2.0
- Created: 2024-08-30T00:37:00.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T14:53:41.000Z (8 months ago)
- Last Synced: 2024-09-27T12:41:53.751Z (8 months ago)
- Topics: bukkit, gradle, gradle-plugin, gradle-plugin-kotlin, kotlin-dsl, papermc, spigot
- Language: Kotlin
- Homepage:
- Size: 107 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PluginJar
[](https://github.com/vjh0107/plugin-jar/actions/workflows/gradle.yml?query=branch:main+event:push)
PluginJar is a Gradle plugin designed to simplify the creation of plugin.yml files for Minecraft plugins.
By using this plugin, there is no need to use ShadowJar to merge projects in a Gradle multi-project environment.
This plugin is specifically designed to avoid the creation of fatjars in Minecraft plugin development.
## Getting Started
1. Add the following to your `build.gradle.kts` file.
```kotlin
plugins {
id("kr.junhyung.pluginjar") version "0.0.4"
}
```
2. Annotate your main plugin class with @Plugin annotation.
```java
@Plugin
public class ExamplePlugin extends JavaPlugin {
@Override
public void onEnable() {
System.out.println("Hello, PluginJar!");
}
}
```
3. Build your project by running the following task.
```
./gradlew pluginJar
```
## Property sources
| Property | Source |
|------------|------------------------------|
| name | Root project name. |
| main | Fully qualified name of the class with @Plugin annotation, auto-detected. |
| version | Project version. |
| api-version | Automatically determined from Bukkit API implementation dependency in the compileClasspath. |
| description | Project description. |
| libraries | Dependencies collected from the runtimeClasspath. If the project depends on other projects at runtime, their dependencies are also included. |
## Manual declaration
There are some properties in `plugin.yml` that you need or want to manually declare. You can declare properties like this:
```kotlin
pluginJar {
depend = listOf("Vault", "ProtocolLib")
softDepend = listOf("PlaceholderAPI")
}
```
## License
Licensed under the Apache License, Version 2.0