Ratatouille

Ratatouille представляет собой многофункциональную библиотеку, созданную разработчиком doctor4t для своих модов и косметических элементов для поддержавших проект пользователей.

Основные возможности

Библиотечные функции

• Утилиты рендеринга: Включают инструменты для работы с графикой, основанные на решениях из Lodestone (автор Sammy).
• Настройка косметики: Универсальная система для кастомизации внешнего вида персонажей, изначально созданная для косметики поддержки, но подходящая и для других косметических модов.
• Пользовательские звуки и частицы для предметов: Возможность настройки звуковых эффектов и визуальных частиц при использовании предметов.
• Рендеринг в режиме от первого лица: Инструмент для добавления элементов, отображающихся на руке игрока в первом лице через реализацию интерфейса RendersArmInFirstPerson.
• Броня с кастомными моделями: Упрощённая система регистрации броневых наборов с уникальными моделями, исключающая необходимость создания слоёв моделей, рендереров функций и сложных условий отображения.

Дополнительные функции

• Плюшевые игрушки RAT: Включают персонажей Rat Maid, Folly и Mauve, которые издают звуки при взаимодействии и могут использоваться с нотными блоками для воспроизведения этих звуков.
• Инвентарь мобов: В творческом режиме можно выдавать мобам предметы и броню, удерживая Shift и взаимодействуя с ними. Удар по мобу с пустой рукой в том же режиме заставляет его выбросить все экипированные предметы.

Косметика для поддержавших проект

• Для участников Ko-Fi или YouTube: отображается значок рядом с именем и цветное имя.
• Плюшевые игрушки на голове: чтобы открыть экран косметики, нужно присесть и использовать любой плюшевый предмет, не направляя курсор на блок.

Галерея

Документация

Настройка (build.gradle)

repositories {
    maven {
        name = 'Ladysnake Mods'
        url = 'https://maven.ladysnake.org/releases'
}

dependencies {
    modImplementation "dev.doctor4t:ratatouille:${project.ratatouille_version}"
}

Утилита для брони с кастомными моделями

Эта утилита позволяет легко регистрировать новые наборы брони с пользовательскими моделями с помощью одного вызова метода.

Шаг 1: Определение модели

Перед добавлением кастомной брони необходима модель, соответствующая определённым правилам. В репозитории доступны шаблоны моделей и текстур. Существующие группы важны для корректного отображения:

• helmet отображается при экипировке шлема
• body_chestplate, right_arm_chestplate и left_arm_chestplate отображаются при экипировке нагрудника
• body_leggings, right_leg_leggings и left_leg_leggings отображаются при экипировке поножей
• right_leg_boot и left_leg_boot отображаются при экипировке ботинок

После создания модели экспортируйте её через Blockbench и скопируйте соответствующий код в класс, расширяющий CustomArmorModelDefinition.

Шаг 2: Регистрация брони

Вызовите CustomModelArmorUtil.registerCustomArmor в клиентском инициализаторе с параметрами:

• Identifier id: уникальный идентификатор брони
• ArmorDisplayConditions displayConditions: условия отображения элементов брони
• CustomArmorModelDefinition armorModelDefinition: определение модели
• int textureWidth, int textureHeight: размеры текстуры

Утилита атмосферных звуков

Эта утилита позволяет регистрировать фоновые звуковые циклы и звуки, связанные с блочными сущностями.

Регистрация фоновых звуков

Вызовите AmbienceUtil.registerBackgroundAmbience с объектом BackgroundAmbience, содержащим:

• SoundEvent soundEvent: звуковое событие
• SoundCategory soundCategory: категория звука
• PlayPredicate predicate: условие воспроизведения
• int fadeIn, int fadeOut: время плавного появления и исчезновения звука

Регистрация звуков блочных сущностей

Вызовите AmbienceUtil.registerBlockEntityAmbience с типом блочной сущности и объектом BlockEntityAmbience с аналогичными параметрами.