Api
The HuskHomes API provides methods for getting, editing and updating user homes and warps, as well as functionality for building and executing (cross-server) teleports.
The API is distributed via JitPack. Please note that HuskHomes API v1, v2 and v3 are not compatible. (Some) javadocs are also available to view on Jitpack here.
Table of contents
- Adding the API to your project
- Adding HuskHomes as a dependency
- 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 (without the v):
<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 (without the v):
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: MyPluginversion: 1.0main: net.william278.myplugin.MyPluginauthor: William278description: '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!