YSM Mapping API

YSM Mapping API

Статус разработки: YSM Mapping API активно разрабатывается. До стабильного релиза возможны ломающие изменения.

YSM Mapping API — это библиотека и мод-зависимость для других модов, которые интегрируются с Yes Steve Model (YSM).

Поскольку внутренние классы, методы и поля YSM обфусцированы, интеграции, основанные на жёстко прописанных именах времени выполнения, могут быть хрупкими. Во время запуска Minecraft YSM Mapping API анализирует структуру байткода установленного JAR-файла YSM и предоставляет зависимым модам проверенные совпадения в виде типизированных семантических символов.

Этот мод не добавляет предметы, блоки, модели, меню или самостоятельные игровые функции. Устанавливайте его, когда другой мод указывает YSM Mapping API как обязательную зависимость. Yes Steve Model требуется отдельно и не входит в комплект.

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

• Только Minecraft 1.20.1

  • Fabric Loader 0.16.0 или новее
  • Forge 47.4.10 или новее
  • Java 17

• Только Minecraft 1.21.1

  • Fabric Loader 0.16.0 или новее
  • NeoForge 21.1.235 или новее
  • Java 21
• Yes Steve Model 2.6.0 или новее требуется для обеих версий.

Файлы привязаны к своей версии Minecraft и загрузчику модов. Используйте только JAR, соответствующий вашей точной среде. Более новая сборка YSM может оставить отдельные символы неразрешёнными, если её структуру не удаётся проверить; API не угадывает неизвестные маппинги.

Локальный кэш и настройки

Следующие файлы создаются автоматически:

config/ysm_mapping_api/
├─ settings.json
└─ mappings.json

mappings.json хранит последние успешно проанализированные маппинги. Он используется повторно, когда YSM и набор запрошенных символов не изменились, и заменяется только после успешного завершения нового анализа.

Для разработчиков модов

Потребляющие моды объявляют нужные им символы в:

META-INF/ysm-mapping-api/requests-v1.json

После инициализации моды могут разрешать типизированные маппинги через YsmMappingApi.resolve(...), использовать подготовленные семантические ключи из YsmSymbols или определять собственные ключи.

Интеграции с Mixin могут использовать предоставленный плагин и обёртку runtime reference-mapper с исходными алиасами. Текущий подготовленный реестр охватывает такие области, как сетевое взаимодействие YSM, синхронизация моделей между клиентом и сервером, доступ к моделям и текстурам, аудиокэши, состояние игрока и анимаций, хуки экипировки, кости и рендереры.

Документация по манифесту и примеры интеграции доступны в репозитории исходного кода. О проблемах можно сообщать через трекер задач.