-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🎨 Refactored packages, improved readme, removed version property from…
… annotations
- Loading branch information
Showing
8 changed files
with
32 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,193 +1,35 @@ | ||
| [](https://jitpack.io/#de.itsTyrion/PluginAnnotationProcessor) | ||
| # Plugin Annotation Processor | ||
|
|
||
| A Bukkit/Spigot or BungeeCord plugin that simplifies the generation of `plugin.yml` file using annotations. | ||
| A toolkit that simplifies the generation of Minecraft server plugin meta files using annotations. | ||
|
|
||
| ## Overview | ||
|
|
||
| This tool provides a convenient way to generate the `plugin.yml` file for your Spigot/Paper/BungeeCord/Waterfall plugin. | ||
| It utilizes annotations to define essential information directly in your code. | ||
| This tool provides a convenient way to generate the `plugin.yml`/`bungee.yml`/`velocity-plugin.json` file for your plugin. | ||
| It utilizes annotations to define the required information directly in your code and fill in the version automatically. | ||
|
|
||
| ## Prerequisites | ||
| - Java 8 or higher | ||
| - Bukkit/Spigot/Paper latest recommended but should work down to 1.7 | ||
| - BungeeCord/Waterfall latest - it supports down to MC 1.8 as of 2023 | ||
| - Bukkit/Spigot/Paper/Pufferfish/Purpur - latest version recommended but should down to 1.8 and further | ||
| - BungeeCord/Waterfall latest - it supports down to MC 1.8 as of 2024 | ||
| - Velocity latest (but any 3.x should work) - it supports down to MC 1.8 as of 2024 | ||
|
|
||
| ## Features | ||
| - **Annotation-based Configuration**: Use the `@Plugin` and `@BungeePlugin` annotations to define plugin information directly in your Java/Kotlin code. | ||
| - **Cross-Compatibility**: Works with Bukkit, Spigot, Paper, BungeeCord, and Waterfall. | ||
| - **Annotation-based Configuration**: Use the `@BukkitPlugin`/`@BungeePlugin`/`@VelocityPlugin` annotations to define plugin information directly in your Java/Kotlin code. | ||
| - **Cross-Compatibility**: Works with Bukkit, Spigot, Paper, Pufferfish, Purpur, BungeeCord, Waterfall and Velocity. | ||
| - **Versioning**: Version number is derived from the Gradle/Maven project version. (Optional) | ||
|
|
||
| --- | ||
| ## Usage | ||
| Moved to [the wiki](https://github.com/itsTyrion/PluginAnnotationProcessor/wiki) | ||
|
|
||
| ### Bukkit/Spigot/Paper | ||
| (This example does not show all properties) | ||
| ```java | ||
| import org.bukkit.plugin.java.JavaPlugin; | ||
|
|
||
| import de.itsTyrion.pluginAnnotation.Plugin; | ||
|
|
||
| @Plugin( | ||
| name = "MyPlugin", | ||
| description = "Awesome Bukkit plugin", | ||
| authors = {"Your Name"}, | ||
| depend = {"aDependency"} | ||
| ) | ||
| public class MyPlugin extends JavaPlugin { | ||
| // Your plugin code here | ||
| } | ||
| ``` | ||
|
|
||
| ### BungeeCord/Waterfall | ||
| ```java | ||
| import net.md_5.bungee.api.plugin.Plugin; | ||
|
|
||
| import de.itsTyrion.pluginAnnotation.BungeePlugin; | ||
|
|
||
| @Plugin( | ||
| name = "MyPlugin", | ||
| description = "Awesome Bungee/Waterfall plugin", | ||
| author = "Your Name", | ||
| depends = {"aDependency"} | ||
| ) | ||
| public class MyBungeePlugin extends Plugin { | ||
| // Your plugin code here | ||
| } | ||
| ``` | ||
| ### Custom version/version format (all platforms): | ||
| Set the `version` parameter to either something completely different (why?) or e.g. `"aPrefix-%mcPluginVersion%-aSuffix"` | ||
| ## Gradle | ||
| #### Add the Jitpack repo if you haven't already: | ||
| ```groovy | ||
| repositories { | ||
| // Add your other repositories here | ||
| maven { url 'https://jitpack.io' } | ||
| } | ||
| ``` | ||
| --- | ||
| If you want to use the Spigot Library Loader (plugin.yml `libraries` section), create a new dependency config like so: | ||
| (The name is up to you, I used `spigotLib` here) | ||
| **Keep in mind it can only load from Maven Central!** | ||
| ```groovy | ||
| configurations { | ||
| spigotLib | ||
| compileOnly { extendsFrom spigotLib } | ||
| } | ||
| // Change the dependency scope from `implementation`/`compileOnly` to the config name of your choice. Example: | ||
| spigotLib 'com.google.inject:guice:7.0.0' // example dependency | ||
| ``` | ||
| Then, pass the list to the compiler/annotation processor according to the sections below. | ||
|
|
||
| --- | ||
| #### For Java sources: | ||
| ```groovy | ||
| dependencies { | ||
| // Add your other dependencies here | ||
| compileOnly 'de.itsTyrion:PluginAnnotationProcessor:1.1' | ||
| annotationProcessor 'de.itsTyrion:PluginAnnotationProcessor:1.1' | ||
| } | ||
| tasks.withType(JavaCompile).configureEach { | ||
| // Add other annotation processor arguments as/if needed or use different values, this is just what I use. | ||
| options.compilerArgs += | ||
| "-AmcPluginVersion=${"$version".contains("SNAPSHOT") ? (version + new Date().format('yyyyMMdd_HHmm')) : version}" | ||
| // This is only needed if you use the Spigot Library Loader. If you use a different name, replace `spigotLib` with it. | ||
| options.compilerArgs += | ||
| "-AspigotLibraries=${configurations.spigotLib.dependencies.collect { "$it.group:$it.name:$it.version" }.join(' ')}" | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| #### For Kotlin sources: | ||
| ```groovy | ||
| plugins { | ||
| // Add your other gradle plugins here | ||
| id 'org.jetbrains.kotlin.kapt' version 'current.kotlin.version' | ||
| } | ||
| dependencies { | ||
| // Add your other dependencies here | ||
| compileOnly 'de.itsTyrion:PluginAnnotationProcessor:1.1' | ||
| kapt 'de.itsTyrion:PluginAnnotationProcessor:1.1' | ||
| } | ||
| kapt.arguments { | ||
| // Add other annotation processor arguments as/if needed or use different values, this is just what I use. | ||
| arg 'mcPluginVersion', version.contains("SNAPSHOT") ? (version + new Date().format('yyyyMMdd_HHmm')) : version | ||
| // This is only needed if you use the Spigot Library Loader. If you use a different name, replace `spigotLib` with it. | ||
| arg 'spigotLibraries', configurations.spigotLib.dependencies.collect { "$it.group:$it.name:$it.version" }.join(';') | ||
| } | ||
| ``` | ||
|
|
||
| ## Maven | ||
| Hint: I have no idea how to do the `libraries` part with maven, tips or a PR are welcome. | ||
| #### Add the Jitpack repo if you haven't already: | ||
| ```xml | ||
| <repository> | ||
| <id>jitpack.io</id> | ||
| <url>https://jitpack.io</url> | ||
| </repository> | ||
| ``` | ||
| #### For Java sources: | ||
| ```xml | ||
| <dependency> | ||
| <groupId>de.itsTyrion</groupId> | ||
| <artifactId>PluginAnnotationProcessor</artifactId> | ||
| <version>1.1</version> | ||
| </dependency> | ||
| ``` | ||
| ```xml | ||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-compiler-plugin</artifactId> | ||
| <version>3.11.0</version> | ||
| <configuration> | ||
| <source>17</source> | ||
| <target>17</target> | ||
| <!-- Pass the project version as an argument to the compiler --> | ||
| <compilerArgs> | ||
| <arg>-Aproject.version=${project.version}</arg> | ||
| </compilerArgs> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| ``` | ||
| #### For Kotlin sources (I recommend you use Gradle): | ||
| (Copied from [the docs](https://kotlinlang.org/docs/kapt.html#use-in-maven)) | ||
| Add an execution of the kapt goal from kotlin-maven-plugin before compile: | ||
| ```xml | ||
| <execution> | ||
| <id>kapt</id> | ||
| <goals> | ||
| <goal>kapt</goal> <!-- You can skip the <goals> element | ||
| if you enable extensions for the plugin --> | ||
| </goals> | ||
| <configuration> | ||
| <sourceDirs> | ||
| <sourceDir>src/main/kotlin</sourceDir> | ||
| <sourceDir>src/main/java</sourceDir> | ||
| </sourceDirs> | ||
| <annotationProcessorPaths> | ||
| <annotationProcessorPath> | ||
| <groupId>de.itsTyrion</groupId> | ||
| <artifactId>PluginAnnotationProcessor</artifactId> | ||
| <version>1.1</version> | ||
| </annotationProcessorPath> | ||
| </annotationProcessorPaths> | ||
| </configuration> | ||
| </execution> | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| Feel free to contribute to the development of this plugin by opening issues or submitting pull requests. | ||
|
|
||
| ## API Reference | ||
| Just add it to the plugin's main class | ||
| Parameter names match plugin.yml/bungee.yml | ||
| Parameter names match plugin.yml/bungee.yml and Velocity's own `@Plugin` annotation | ||
|
|
||
| ## License | ||
| This project is licensed under the MIT License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...sTyrion/pluginAnnotation/CommandInfo.java → .../pluginAnnotation/bukkit/CommandInfo.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters