Cloud API

Report a Bug · Request a Feature

🌟 Give us a star — your support means the world to us!

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

The official SDK for the SimpleCloud controller. Manage groups, servers, persistent servers and players and listen to events.

Features

• Easy API Use: Just add the plugin to your server and include the api as a provided artifact.
• Supported Server Software: Supports every major platform.
• Easy API access: Use every api method we provide, just from one interface.
• Go SDK: A standalone Go SDK for use outside of Minecraft servers.

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 to 26.3, and does not require clients to install the mod.

Usage

Java & Kotlin

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>

Go

The standalone Go SDK lives in go/. See the Go SDK README for installation and usage.

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.

License

This repository is licensed under Apache 2.0.