Lio's Player Animator API

Lio's Player Animator API - библиотека для Майнкрафт, которая позволяет запускать кастомные анимации модели игрока прямо со стороны сервера. Это форк известного PlayerAnimator от ZigyTheBird, той самой библиотеки, на которой держатся эмоции в Emotecraft и анимации боя в Better Combat. Форк создавался под нужды мода AnimationJS, и его главное отличие от оригинала в том, что анимации триггерятся сервером: командой или через Java-реализацию.

Зачем это вообще нужно? В ванильном Minecraft анимации игрока примитивные до боли: взмах руки при ударе, поза сидя и пара движений при использовании предметов. PlayerAnimator решает эту проблему, позволяя проигрывать на модели игрока полноценные анимации в третьем лице. Но оригинальная библиотека заточена под клиентскую сторону, а здесь контроль отдан серверу. Это значит, что анимацию у конкретного игрока может запустить сам сервер, например во время ивента, квеста или после введённой команды, и все участники увидят одно и то же действие синхронно. Для серверных проектов с кастомным контентом это прямо находка.

Что умеет Lio's Player Animator API

• Серверные анимации. Главная фишка форка. Анимацию можно вызвать командой или из кода на стороне сервера, что открывает двери для скриптовых сценариев, квестовых сценок и серверных эмоций.
• Опциональная поддержка LioLib. LioLib - это форк GeckoLib 4, поэтому на игроке можно крутить анимации в формате GeckoLib, том самом, в котором сделаны модели мобов и боссов в большинстве популярных модов. Зависимость не обязательна, без LioLib библиотека тоже работает.
• Встроенный мультилоадер API. Форк сохранил наработки Zigy по мультизагрузчику, так что интеграция с другими модами проходит без боли, а сама библиотека не привязана жёстко к одному загрузчику.

Кому нужен этот мод

Сразу честно: обычному игроку сама по себе эта библиотека ничего не даст. Это API, зависимость, которая нужна другим модам. Ставить её имеет смысл в трёх случаях:

1. Вы используете мод AnimationJS, ради которого форк и создавался.
2. Вы разработчик и хотите добавить в свой мод проигрывание анимаций игрока с серверной логикой.
3. Вы собираете сборку модов для сервера, где нужны синхронные анимации, видимые всем игрокам.

Подключение через Gradle

Для разработчиков автор выложил библиотеку в maven-репозиторий. Чтобы подтянуть Lio's Player Animator API в свой проект, добавьте в build.gradle репозитории:

repositories {
    maven { url "https://dl.cloudsmith.io/public/lio/liosplayeranimationapi/maven/" }
    maven { url "https://dl.cloudsmith.io/public/lio/multiloaderutils/maven/" }
}

И зависимости, пример ниже дан для Forge:

dependencies {
    implementation fg.deobf('lio.liosmultiloaderutils:liosmultiloaderutils-forge-${minecraft_version}-${multiloader_version}:${multiloader_version}')
    implementation fg.deobf("lio.playeranimatorapi:liosplayeranimatorapi-forge-${minecraft_version}-${liosAPI_version}:${liosAPI_version}")
}

Обратите внимание, что помимо самого API подключается ещё и Lio's Multiloader Utils - без него библиотека не соберётся.

Поддерживаемые версии

Minecraft	Версия библиотеки
1.19.2	1.2.3
1.20.1	1.2.3

Список небольшой, но для серверных сборок на 1.20.1, а это сейчас самая ходовая версия для модов, его хватает с головой.

Важные нюансы

• Это форк, а не дополнение к оригиналу. Если в вашей сборке уже стоит PlayerAnimator от ZigyTheBird, сначала проверьте совместимость: две библиотеки на одной кодовой базе могут конфликтовать.
• Проект распространяется под лицензией MIT, так что его можно свободно использовать в собственных модах и модпаках без лишних разрешений.
• Подробная документация по самому API лежит на вики Zigy, автор форка менял в первую очередь серверную часть, базовые методы работают так же.

Скачать Lio's Player Animator API стоит в первую очередь тем, кто запускает сервер с AnimationJS или пишет собственные моды под Minecraft 1.19.2 и 1.20.1. Если вы просто играете и ищете эмоции для персонажа, смотрите в сторону Emotecraft, а вот если нужны управляемые сервером анимации - это как раз тот случай.