Skip to content

πŸ“™ πŸ“¦ Maven parent POM containing the default configuration to build Spigot (Bukkit) plugins

License

Notifications You must be signed in to change notification settings

timbru31/bukkit-plugin-parent-pom

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

bukkit-plugin-parent-pom

Build Status Known Vulnerabilities

A maven parent POM for all my Bukkit/Spigot plugins.

What's included

Dependencies

Plugins

  • Checkstyle
  • PMD
  • SpotBugs (+ Find Security Bugs & fb-contrib)

Profiles

  • metrics - this profile shades bStats and the auto updater into the plugin
  • metrics-no-updater - this profile shades bStats into the plugin
  • kotlin - this profile adds the necessary configuration and shading for Kotlin usage

Configuration

Mandatory

  • plugin.name - your desired plugin name (e.g. MyAwesomePlugin)
  • plugin.main - the main class used in the plugin.yml (e.g. com.mydomain.pluginMain)
  • plugin.package - the used plugin package (e.g. com.mydomain)

Optional

  • Spigot API (Bukkit) Version (bukkit.version), default will stick to the latest available one.
  • JDK Version (jdk.version), default is 21
  • Enforced Maven version (enforcer.maven.version), default is [3,9)
  • Checkstyle ruleset (checkstyle.location), default is https://dustplanet.de/checkstyle.xml
  • PMD ruleset (pmd.location), default is https://dustplanet.de/pmd.xml

For further properties, please take a look into the properties section of this pom.xml.

Usage

Include the following in your pom.xml:

  <parent>
    <groupId>de.dustplanet</groupId>
    <artifactId>bukkit-plugin</artifactId>
    <version>9.0.0</version>
    <relativePath />
  </parent>

  <properties>
    <plugin.name>MyPlugin</plugin.name>
    <plugin.main>de.dustplanet.myplugin.MyPlugin</plugin.main>
    <plugin.package>de.dustplanet.myplugin</plugin.package>
  </properties>

  <repositories>
    <repository>
      <id>parent</id>
      <url>https://repo.dustplanet.de/artifactory/bukkit-plugins/</url>
    </repository>
  </repositories>

Built by (c) Tim Brust and contributors. Released under the MIT license.