SimpleCloud API Plugin

Cloud API

All information about this project can be found in our detailed documentation.

This Project aims to provide very easy API access. This project fixes all dependency issues that were present before.
Install the platform JAR on the server and use the dependency as described below.

[!CAUTION]

Paper specific API is very experimental and unstable. Use Spigot API if you are running paper!

Features

• [x] Easy API Use: Just add the plugin to your server and include the api as a provided artifact.
• [x] Supported Server Software: Supports Spigot and forks, Paper, Folia, BungeeCord, Velocity, Fabric, Quilt, and NeoForge.
• [ ] Easy API access: Use every api method we provide, just from one interface.

Server Installation

• Put the Spigot, Paper, Folia, BungeeCord, and Velocity JAR in the server’s plugins directory.
• Put the Fabric/Quilt or NeoForge JAR in the server’s mods directory.
• The shared Fabric/Quilt build requires Fabric API.
• Fabric, Quilt, and NeoForge support is server-side only, targets Minecraft 26.2, and does not require clients to install the mod.

Usage

Go

The standalone Go SDK lives in go/. It includes the complete Controller REST API plus typed NATS events and does not require a Minecraft plugin runtime.

client, err := simplecloud.NewClientFromEnv()
if err != nil {
    log.Fatal(err)
}
defer client.Close()

groups, _, err := client.Groups.List(context.Background(), nil)

See the Go API README for installation, configuration, events, and raw endpoint access.

1. Depend on simplecloud-api

2. Use APIs

For always up-to-date artifacts visit dev artifacts or artifacts.

Note: If you want to use the dev version, you have to use the snapshot repository.

Gradle Kotlin

compileOnly("app.simplecloud.api:api:VERSION")

Gradle Groovy

compileOnly 'app.simplecloud.api:api:VERSION'

Maven

<dependencies>
    <dependency>
        <groupId>app.simplecloud.api</groupId>
        <artifactId>api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Contributing

Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like
you to read our Contribution Guide.

NATS integration tests

With an isolated NATS broker running, use NATS_TEST_URL=nats://127.0.0.1:4222 ./gradlew :api:test --rerun-tasks to test request inboxes before and after reconnecting. The broker test is skipped when the variable is unset. The Go SDK README describes the equivalent Go tests.

License

This repository is licensed under Apache 2.0.