https://github.com/timbru31/bukkit-plugin-parent-pom

📙 📦 Maven parent POM containing the default configuration to build Spigot (Bukkit) plugins
https://github.com/timbru31/bukkit-plugin-parent-pom

bstats bukkit bukkit-plugin craftbukkit java kotlin maven paper papermc parent-pom pom spigot spigot-api spigot-plugin spigotmc template

Last synced: 2 months ago
JSON representation

📙 📦 Maven parent POM containing the default configuration to build Spigot (Bukkit) plugins

• Host: GitHub
• URL: https://github.com/timbru31/bukkit-plugin-parent-pom
• Owner: timbru31
• License: mit
• Created: 2017-01-02T20:04:55.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T21:13:03.000Z (3 months ago)
• Last Synced: 2024-09-28T14:22:54.481Z (3 months ago)
• Topics: bstats, bukkit, bukkit-plugin, craftbukkit, java, kotlin, maven, paper, papermc, parent-pom, pom, spigot, spigot-api, spigot-plugin, spigotmc, template
• Homepage: https://repo.dustplanet.de/artifactory/bukkit-plugins/
• Size: 602 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
bukkit-plugin-parent-pom

===

[![Build Status](https://ci.dustplanet.de/job/bukkit-plugin-parent-pom/badge/icon)](https://ci.dustplanet.de/job/bukkit-plugin-parent-pom/)

[![Known Vulnerabilities](https://snyk.io/test/github/timbru31/bukkit-plugin-parent-pom/badge.svg)](https://snyk.io/test/github/timbru31/bukkit-plugin-parent-pom)

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

## What's included

### Dependencies

* Spigot API (Bukkit)

* bStats

* Kotlin

* Lombok

* SpotBugs Annotations

* JUnit 5

* Mockito

* Hoverfly

* updater (https://github.com/timbru31/updater)

### 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`:

```xml

  

    de.dustplanet

    bukkit-plugin

    9.0.0

    

  

  

    MyPlugin

    de.dustplanet.myplugin.MyPlugin

    de.dustplanet.myplugin

  

  

    

      parent

      https://repo.dustplanet.de/artifactory/bukkit-plugins/

    

  

```

---

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