Getting Started

Here we explain how to use the Wale API correctly.

How do I import the API?

To integrate the Wale API into your project, we recommend using Gradle or Maven. Do not shade it.

1. First, you need to register the repository server by using the following URL:

Gradle (Groovy)

maven {
    name "waleRepositoryReleases"
    url "https://repo.walecloud.com/releases"
}

Maven

<repositories>
    <repository>
        <id>waleRepositoryReleases</id>
        <name>waleRepositoryReleases</name>
        <url>https://repo.walecloud.com/releases</url>
    </repository>
</repositories>

2. After that, add the dependency to your project.

You can always check the latest version on the repository server. For this documentation, version 1.5.8 is used.

Gradle (Groovy)

dependencies {
    compileOnly "at.stefan:wale-api:VERSION"
}

Maven

<dependencies>
    <dependency>
        <groupId>at.stefan</groupId>
        <artifactId>wale-api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Important: Do not shade the API yourself; depend on the Wale plugin, which always includes the latest API version.

How do I now use the API in my project?

Create only one instance per plugin. If you have multiple plugins using the API, try to create only one instance and centralize it, as it can save on traffic.

// An example of how to initialize the API
public class Test extends JavaPlugin {
    
    @Getter
    private WaleAPI waleAPI;
    
    @Override
    public void onEnable() {
        waleAPI = new WaleAPI();
    }
}