SimpleCloud Api Plugin

Cloud API

![Banner][banner]

> All information about this project can be found in our detailed [documentation][docs-thisproject].

This Project aims to provide very easy API access. This project fixes all dependency issues that were present before. Just include the platform jar as a plugin 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 access: Just add the plugin to your server and include the api as a provided artifact. - [x] Easy API access: Supports Spigot & Forks, BungeeCord and Velocity. - [ ] Easy API access: Use every api method we provide, just from one interface.

Usage

1. Depend on `simplecloud-api`

2. Use APIs

> For always up-to-date artifacts visit [dev artifacts][dev-artifacts] or [artifacts][artifacts].

> Note: If you want to use the dev version, you have to use the [snapshot repository][snapshots].

Gradle Kotlin

```kt // Use Controller API if you want compileOnly("app.simplecloud.controller:controller-api:VERSION") // Use Player API if you want compileOnly("app.simplecloud.controller:controller-api:VERSION") ```

Gradle Groovy

```groovy // Use Controller API if you want compileOnly 'app.simplecloud.controller:controller-api:VERSION' // Use Player API if you want compileOnly 'app.simplecloud.controller:controller-api:VERSION' ```

Maven

```xml <dependencies> <dependency> <groupId>app.simplecloud.controller</groupId> <artifactId>controller-api</artifactId> <version>VERSION</version> <scope>provided</scope> </dependency> <dependency> <groupId>app.simplecloud.droplet.player</groupId> <artifactId>player-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][docs-contribute].

License

This repository is licensed under [Apache 2.0][license].

[banner]: https://simplecloud.app/api/banner/Cloud%20API

[issue-bug-report]: https://github.com/simplecloudapp/cloud-api/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E

[issue-feature-request]: https://github.com/simplecloudapp/cloud-api/discussions/new?category=ideas

[docs-thisproject]: https://docs.simplecloud.app/api

[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

[dev]: https://repo.simplecloud.app/#/snapshots/app/simplecloud/cloud-api

[artifacts]: https://repo.simplecloud.app/#/snapshots/app/simplecloud/api/cloud-api

[dev-artifacts]: https://repo.simplecloud.app/#/snapshots/app/simplecloud/cloud-api

[badge-maven-central]: https://img.shields.io/maven-central/v/app.simplecloud.api/cloud-api?labelColor=18181b&style=flat-square&color=65a30d&label=Release

[badge-dev]: https://repo.simplecloud.app/api/badge/latest/snapshots/app/simplecloud/api/cloud-api?name=Dev&style=flat-square&color=0ea5e9

[license]: https://opensource.org/licenses/Apache-2.0

[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp

[social-bluesky]: https://bsky.app/profile/simplecloud.app

[social-youtube]: https://www.youtube.com/@thesimplecloud9075

[social-discord]: https://discord.simplecloud.app

[badge-modrinth]: https://img.shields.io/badge/modrinth-18181b.svg?style=flat-square&logo=modrinth

[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48

[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a

[badge-x]: https://img.shields.io/badge/[email protected]?style=flat-square&logo=x&color=27272a

[badge-bluesky]: https://img.shields.io/badge/[email protected]?style=flat-square&logo=bluesky&color=27272a

[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a