Installation

Installation

Requirements

• Java 17 or newer
• A Guilded bot token, see Creating bots with JG_API

Dependencies

JG_API only depends on org.json:json (version 20220320) at runtime. If you add the jar by hand, add this to your own pom.xml as well:

<dependency>
    <groupId>org.json</groupId>
    <artifactId>json</artifactId>
    <version>20220320</version>
</dependency>

Building from source

There is no release on Maven Central yet, so for now build the jar yourself:

git clone https://github.com/JGAPI/JG_API.git
cd JG_API
mvn -Prelease clean package

This creates target/JGAPI-<version>.jar (for example target/JGAPI-0.0.1-alpha.dev.jar). Add that jar to the classpath of your project.

The -Prelease (or -Psnapshot) profile is required, without a profile the version is set to INVALID.

To run the library's unit tests use mvn -Prelease test. They don't need a bot token or any network access to Guilded.

Maven importation

TBD - will be added once the first release is published.