Getting Started

Get started using the zAPI API.

Declare zAPI dependency in your build files

Maven

<build>
    <defaultGoal>clean package</defaultGoal>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.5.3</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <relocations>
                            <relocation>
                                <pattern>me.yleoft.zAPI</pattern>
                                <shadedPattern>your.package.shaded.zAPI</shadedPattern>
                            </relocation>
                        </relocations>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<repositories>
    <repository>
        <id>yl3oft-repo</id>
        <url>https://repo.codemc.io/repository/yl3oft/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>me.yleoft</groupId>
        <artifactId>zAPI</artifactId>
        <version>1.4.8</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

maven-shade-plugin from org.apache.maven.plugins is used to relocate the package of the API, you can use it without relocating, but it may cause some incompatibilities.

Gradle

plugins {
    id("com.github.johnrengelman.shadow") version "8.1.1"
}

repositories {
    maven("https://repo.codemc.io/repository/yl3oft/")
}

dependencies {
    implementation("me.yleoft:zAPI:1.4.8")
}

shadowJar {
    relocate 'me.yleoft.zAPI', 'your.package.shaded.zAPI'
}

shadowJar from com.github.johnrengelman.shadow is used to relocate the package of the API, you can use it without relocating, but it may cause some incompatibilities.