shopgui-api

This repository provides an open source library containing basic API for ShopGUI+ spigot plugin.

How to use

Add Maven/Gradle dependency to your project (code snippets are available in the section below)
Add ShopGUIPlus to depend or softdepend section of plugin.yml in your plugin project
You can start adding desired implementation to your plugin

Tips:

Registering of spawner or economy provider must be performed at server startup (inside the onEnable method of your plugin)
You can get ShopGUI+'s main class with ShopGuiPlusApi#getPlugin static method
The API is still very basic and incomplete - we're open for ideas as well as pull requests

Version compatibility matrix

When using this API, make sure you use valid version corresponding to ShopGUI+'s version your plugin is going to be used with.

ShopGUI+ version	API version
1.72.0 - ...	2.3.0
1.58.0 - 1.71.0	2.2.0
1.45.1 - 1.57.0	2.1.1
1.45.0	2.1.0
1.43.0 - 1.44.3	2.0.0
1.42.0 - 1.42.3	1.5.1
1.36.0 - 1.41.0	1.5.0
1.35.0 - 1.35.1	1.4.0
1.33.0 - 1.34.2	1.3.0
1.29.1 - 1.32.1	1.2.0
1.29.0	1.1.0
1.20.3 - 1.28.1	1.0.1
1.20.0 - 1.20.2	1.0.0

Dependencies

Note: It's not recommended to use the latest version tag. Use fixed version from Releases instead.

Maven

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

	<dependency>
	    <groupId>com.github.brcdev-minecraft</groupId>
	    <artifactId>shopgui-api</artifactId>
	    <version>latest</version>
	</dependency>

Gradle

	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

	dependencies {
	        implementation 'com.github.brcdev-minecraft:shopgui-api:latest'
	}

Example implementations

There are some examples of implementing a spawners provider available at our GitHub:

More example plugins showing API possibilities are coming soon.

Contact

You can contact the maintainers at our Discord server - http://discord.brcdev.net/

Drc-DEV/shopgui-api