🔌API

Документация для разработчиков клиентских модов.

Пример реализации на Fabric: liteapi-fabric-example

---

Модули

Модуль	Канал	Документация
Feature Control	liteapi:feature-control	feature-control

---

Транспорт

Весь обмен данными происходит через Minecraft Plugin Messaging Channels:

• Клиент отправляет Serverbound Plugin Message (play) пакет на именованный канал.

• Сервер отвечает Clientbound Plugin Message (play) пакетом на тот же канал.

• Содержимое пакета — строка UTF-8 JSON.

Каждый модуль LiteAPI имеет свой канал, например liteapi:feature-control. Канал указан в документации конкретного модуля.

---

Формат пакетов

Запрос (клиент → сервер)

{
  "id":      "<UUID запроса>",
  "method":  "<название метода>",
  "payload": { ... }
}

Поле	Тип	Обязательно	Описание
id	string	да	UUID запроса. Сервер вернёт его в ответе — по нему вы поймёте, на какой именно запрос пришёл ответ.
method	string	да	Название метода, который нужно вызвать.
payload	object	нет	Параметры запроса. Если отсутствует или null — считается пустым объектом. Не может быть массивом или примитивом.

Ответ — успех (сервер → клиент)

{
  "id":      "<UUID запроса>",
  "ok":      true,
  "payload": { ... }
}

Ответ — ошибка (сервер → клиент)

{
  "id":      "<UUID запроса>",
  "ok":      false,
  "error":   "<код ошибки>",
  "message": "<описание, может отсутствовать>"
}

Push-событие (сервер → клиент, без запроса)

{
  "event":   "<название события>",
  "payload": { ... }
}

Push-события не имеют id и ok — они не являются ответами на запросы.

---

Коды ошибок

error	Когда возникает
BAD_REQUEST	Пакет невалидный: не JSON, нет поля id или method, неверный payload
NOT_FOUND	Метод с таким именем не существует
RATE_LIMITED	Превышен лимит запросов
INTERNAL_ERROR	Непредвиденная ошибка на сервере (детали не раскрываются)

Поле message присутствует не всегда: при INTERNAL_ERROR его нет намеренно.

---

Rate limiting

Лимиты настраиваются отдельно для каждого метода и указаны в документации модуля. При превышении сервер отвечает RATE_LIMITED и игнорирует запрос. Лимит считается per player.