Guides

Documentation

Docs/HuskHomes/

API

HuskHomes banner

HuskHomes API v3

JitPack API

The API is distributed via JitPack. Please note that HuskHomes API v1 and v2 are not compatible. (Some) javadocs are also available to view on Jitpack here.

Table of contents

  1. Adding the API to your project
  2. Adding HuskHomes 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.
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
  • Add the dependency to your pom.xml as per below. Replace version with the latest version of HuskHomes.
<dependency>
    <groupId>net.william278</groupId>
    <artifactId>HuskHomes2</artifactId>
    <version>version</version>
    <scope>provided</scope>
</dependency>

1.2 Setup with Gradle

Gradle setup information
  • Add the dependency like so to your build.gradle:
allprojects {
	repositories {
		maven { url 'https://jitpack.io' }
	}
}
  • Add the dependency as per below. Replace version with the latest version of HuskHomes.
dependencies {
    compileOnly 'net.william278:HuskHomes2:version'
}

2. Adding HuskHomes as a dependency

  • Add HuskHomes to your softdepend (if you want to optionally use HuskHomes) or depend (if your plugin relies on HuskHomes) 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 HuskHomes API!'
softdepend: # Or, use 'depend' here
  - HuskHomes

3. Next Steps

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