Home

Spigot Site API

About

Spigot is a fork of the well known Minecraft Server mod called Bukkit. In the past most plugins were uploaded to http://dev.bukkit.org/ but since September 2014 more and more plugins are being uploaded and sold on http://www.spigotmc.org/

This API allows developers to fetch data from the site or even authenticate users. This allows the creating of update checkers or even auto updaters for both normal as premium resources (since authenticated users can download their premium resources).

Despite being mostly aimed for the resource section of Spigot the API will provide support for the forums and user data.

Possiblities

• BukGet alternative for Spigot
• Check for resource updates
• Auto download new resource updates
• Verify premium resources
• Buyer notifications
• Get resource changelogs
• Get user information (badges, post count ,...)

Usage

This is the SpigotSite-API. The actual plugin you will be adding to your server is https://github.com/Maximvdw/SpigotSite however you should not use that as your dependency.

This API with the maven repository provided below gives all functions needed to get or post data from and to the Spigot site.

Maven

Repository:

<repository>
    <id>public</id>
    <name>Public Repositories</name>
    <url>http://repo.mvdw-software.be/content/groups/public/</url>
</repository>

Dependency:

<dependency>
    <groupId>be.maximvdw</groupId>
    <artifactId>spigotsite-api</artifactId>
    <version>0.3.0-SNAPSHOT</version>
</dependency>

You will also need to implementation in order to use the API:

<dependency>
    <groupId>be.maximvdw</groupId>
    <artifactId>spigotsite</artifactId>
    <version>0.3.0-SNAPSHOT</version>
</dependency>

Documentation and Builds

SpigotSite Plugin - http://ci.mvdw-software.be/job/SpigotSite/
SpigotSite API - http://ci.mvdw-software.be/job/SpigotSite-API/
SpigotSite API Javadocs - http://ci.mvdw-software.be/job/SpigotSite-API/javadoc/

Plugin implementation

First thing you should consider is either or not you want your plugin to rely on the plugin or add it as an additional feature.

If you want to use it as a form of authentication for premium resources or if you want to make sure your users have a way of easily downloading and installing the latest updates you should add it as a normal dependency.

If you want to use it as an additional feature and the plugin can work without it you should add it as a soft dependency.