HuskSync/docs/API.md

The HuskSync API provides methods for retrieving and updating user data, as well as a number of events for tracking when user data is synced and saved.

Compatibility

The HuskSync API shares version numbering with the plugin itself for consistency and convenience. Please note minor and patch plugin releases may make API additions and deprecations, but will not introduce breaking changes without notice.

API Version	HuskSync Versions	Supported
v2.x	v2.0—Current	✅
v1.x	v1.0—v1.4.1	❌️

Targeting older versions

HuskSync versions prior to v2.2.5 are distributed on JitPack, and you will need to use the https://jitpack.io repository instead.

Table of contents

1. Adding the API to your project
2. Adding HuskSync as a dependency
3. Next steps

API Introduction

1.1 Setup with Maven

Maven setup information

Add the repository to your pom.xml as per below. You can alternatively specify /snapshots for the repository containing the latest development builds (not recommended).

<repositories>
    <repository>
        <id>william278.net</id>
        <url>https://repo.william278.net/releases</url>
    </repository>
</repositories>

Add the dependency to your pom.xml as per below. Replace VERSION with the latest version of HuskSync (without the v):

<dependency>
    <groupId>net.william278</groupId>
    <artifactId>husksync</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>

1.2 Setup with Gradle

Gradle setup information

Add the dependency as per below to your build.gradle. You can alternatively specify /snapshots for the repository containing the latest development builds (not recommended).

allprojects {
	repositories {
		maven { url 'https://repo.william278.net/releases' }
	}
}

Add the dependency as per below. Replace VERSION with the latest version of HuskSync (without the v):

dependencies {
    compileOnly 'net.william278:husksync:VERSION'
}

2. Adding HuskSync as a dependency

• Add HuskSync to your softdepend (if you want to optionally use HuskSync) or depend (if your plugin relies on HuskSync) section in plugin.yml of your project.

name: MyPlugin
version: 1.0
main: net.william278.myplugin.MyPlugin
author: William278
description: 'A plugin that hooks with the HuskSync API!'
softdepend: # Or, use 'depend' here
  - HuskSync

3. Next steps

Now that you've got everything ready, you can start doing stuff with the HuskSync API!

• UserData API — Get data snapshots and update current user data
• API Events — Listen to, cancel and modify the result of data synchronization events