OR-Lib
Активный0.0
Установок
Последнее обновление
Версии
OR-LIB – Библиотека для отрисовки носимых предметов (Fabric)
OR-LIB представляет собой небольшую библиотеку для Fabric, цель которой — упростить и стандартизировать работу с носимой экипировкой (кольца, амулеты, обереги и прочее), а также её визуализацию как от первого лица, так и от третьего. Разработана она для того, чтобы несколько модов в одном сборнике могли легко ей воспользоваться, и не приходилось каждый раз переписывать один и тот же код для поз, трансформаций и специальных слотов.
Основное предназначение
- Предоставить понятный набор инструментов для создания носимых предметов с особыми свойствами.
- Объединить логику регистрации, отрисовки и трансформации таких предметов в одном месте.
- Обеспечить лёгкую интеграцию со сторонними системами слотов (например, подобными Trinkets), не навязывая модам конкретных архитектурных решений.
Необходимые требования
- Модлоадер: Fabric.
- Мод Trinkets (рекомендуется для полноценной работы).
Библиотека особенно полезна в сочетании с контентными модами, которые добавляют в игру украшения, обереги или другие носимые предметы.
Важное замечание
Проект пока находится в активной разработке, поэтому некоторые функции могут работать не совсем так, как ожидается.
Ключевые возможности
- API для носимых предметов – готовые классы и интерфейсы для создания WearableItem, определения типов WearableType и задания связанных свойств, с поддержкой builder-style настройки атрибутов, бонусов и поведения.
- Централизованные реестры – система реестров WearablesRegistry и WearableContentRegistry для единого хранения контента, а также вспомогательные теги и классы для удобной интеграции.
- Продвинутая система отрисовки – готовая базовая отрисовка SimpleWearableRenderer для простых случаев, и гибкая система поз и трансформаций с использованием SlotTransform, BodyAnchor, WearablePoseContext и других компонентов, включая синхронизацию моделей в первом лице (FirstPersonWearableRenderer).
- Интеграции и хуки – клиентские интеграции для загрузки моделей и рендеринга предметов на персонаже, а также централизованная инициализация системы отрисовки через WearableRenderingBootstrap.
- Совместимость со слотами – утилиты для упрощённого взаимодействия с различными системами слотов в духе Trinkets, позволяющие разработчику сосредоточиться на функционале и внешнем виде предметов, а не на повторяющемся коде.
Для разработчиков модов
- Добавьте OR-LIB как зависимость в свой проект.
- Создайте свой носимый предмет, расширив или реализовав предоставленные базовые классы (например, WearableItem), настроив его через builder.
- Зарегистрируйте предмет в реестрах библиотеки.
- При необходимости подключите кастомный рендерер через клиентское API для продвинутой графики.
- Воспользуйтесь утилитами OR-LIB для работы с дополнительными системами слотов, вместо написания своего интеграционного кода.
Архитектура и расширяемость
Библиотека OR-LIB — это фундаментальный слой, предназначенный для облегчения работы с носимой экипировкой в среде Fabric. Сама по себе она не добавляет контента, а предоставляет только мощный API, реестры, вспомогательные утилиты и систему рендеринга.