SimpleCloud API Plugin

Cloud API

Всю информацию об этом проекте можно найти в нашей подробной документации. Цель этого проекта — предоставить очень простой доступ к API. Проект исправляет все проблемы с зависимостями, которые были раньше. Установите JAR платформы на сервер и используйте зависимость, как описано ниже. [!CAUTION] API, специфичный для Paper, очень экспериментальный и нестабильный. Если вы используете Paper, применяйте Spigot API!

Возможности

• [x] Простое использование API: просто добавьте плагин на сервер и подключите api как provided-артефакт.
• [x] Поддерживаемое серверное ПО: поддерживает Spigot и его форки, Paper, Folia, BungeeCord, Velocity, Fabric, Quilt и NeoForge.
• [ ] Простой доступ к API: используйте любой метод api, который мы предоставляем, через единый интерфейс.

Установка на сервер

• Поместите JAR для Spigot, Paper, Folia, BungeeCord и Velocity в каталог plugins сервера.
• Поместите JAR для Fabric/Quilt или NeoForge в каталог mods сервера.
• Общая сборка для Fabric/Quilt требует Fabric API.
• Поддержка Fabric, Quilt и NeoForge работает только на стороне сервера, рассчитана на Minecraft 26.2 и не требует установки мода на клиентах.

Использование

Go

Отдельный Go SDK находится в go/. Он включает полный REST API Controller, а также типизированные события NATS и не требует среды выполнения плагина Minecraft.

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

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

Установку, настройку, события и прямой доступ к эндпоинтам см. в [Go API README](go/README.md).
### 1. Подключите зависимость `simplecloud-api`
### 2. Используйте API
> Актуальные артефакты смотрите в [dev-артефактах][dev-artifacts] или [артефактах][artifacts].
> Примечание: если вы хотите использовать dev-версию, нужно подключить [snapshot-репозиторий][snapshots].
#### Gradle Kotlin
```kt
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>

Участие в разработке

Мы рады и очень признательны за вклад в SimpleCloud. Однако, прежде чем приступить, просим прочитать наш гайд по участию.

Лицензия

Этот репозиторий распространяется под лицензией Apache 2.0.