Skip to content

ArchipelagoMW/Java-Client

Repository files navigation

Archipelago Java Client

Maven Central Version

A java client Library to connect to an Archipelago Server.

Getting Started

Use the following Code snippits to add this library to your project using the following.

Maven

To use maven add this dependency to your pom.xml:

<dependency>
    <groupId>dev.koifysh</groupId>
    <artifactId>archipelago-client</artifactId>
    <version>0.1.19</version>
</dependency>

Gradle

To use Gradle add the maven central repository to your repositories list: then add this to your dependancy section

implementation 'dev.koifysh:archipelago-client:0.1.19'

Using Snapshots

This repository is setup to publish snapshots when new commits hit main. If you want to use the snapshot version you will need to do the following:

Maven

From Maven Central Documentation

Configure your pom.xml file with the following section:

<repositories>
    <repository>
        <name>Central Portal Snapshots</name>
        <id>central-portal-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

And add the snapshot version into your dependencies:

<dependency>
    <groupId>io.github.archipelagomw</groupId>
    <artifactId>Java-Client</artifactId>
    <version>0.1.20-SNAPSHOT</version>
</dependency>

Gradle

From Maven Central Documentation

Configure your build.gradle with the following:

repositories {
  maven {
    name = 'Central Portal Snapshots'
    url = 'https://central.sonatype.com/repository/maven-snapshots/'

    // Only search this repository for the specific dependency
    content {
      includeModule("io.github.archipelagomw", "Java-Client")
    }
  }
  mavenCentral()
}

And add the snapshot version into your dependencies:

implementation 'io.github.archipelagomw:Java-Client:0.1.20-SNAPSHOT'

About

A Client library written in Java for use with the Archipelago software.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6

Languages