Server API
Получайте модели и анимации из BDEngine по ID для своих серверных плагинов и интеграций.
Server API предоставляет доступ к экспортированным данным BDEngine через HTTP. Вы создаёте сцену в редакторе, публикуете её и получаете JSON по выданному ID. Эти данные можно использовать в собственном плагине для Minecraft или другой интеграции.
BDEngine подготавливает данные и описывает их формат. Как создавать объекты в мире, воспроизводить анимацию и хранить полученные модели, определяет ваша интеграция.
Получить данные
Путь от проекта до ответа API состоит из трёх шагов:
- Опубликуйте модель. В редакторе выберите экспорт в Minecraft Сервер.
- Скопируйте ID. После успешной публикации он появится в окне экспорта.
- Выполните HTTP-запрос. Передайте этот ID в API и получите JSON с данными модели.
Чтобы получить и изучить ответ, достаточно уметь выполнять HTTP-запросы и читать JSON. Запускать Minecraft для этого не требуется.
Вместе с ID редактор выдаёт быструю команду: по умолчанию /bde spawn {ID},
с уже подставленным ID публикации. Через «Изменить быструю команду» её можно
настроить под свой плагин. Для выполнения этой команды в Minecraft нужен
серверный плагин, который её обрабатывает. Официального серверного плагина BDEngine нет.
Разобраться в формате
Состав данных зависит от сцены и выбранного режима экспорта. Помимо визуальных частей модели, экспорт может содержать кадры анимации, звуковые события и данные хитбоксов. Поддержку отдельных возможностей и версий Minecraft следует сверять с ограничениями экспорта.
В контракте данных собраны параметры запроса, структура JSON, назначение полей, срок доступности публикации и ошибки API. Обращайтесь к нему, когда нужно понять конкретное поле или проверить, какие данные получит ваша интеграция.