Ratatouille

Особенности

Библиотека

• Утилиты рендеринга, полученные из Lodestone (от Sammy; и Lodestar, удалены в версии 1.21.1)
• Утилита настройки косметики: создана для косметики моих сторонников, но также может быть использована «из коробки» для более общих косметических модов, требующих простой настройки.
• Пользовательский звук удара предмета и использование частиц
• Утилита рендеринга функций от первого лица: позволяет добавлять функции, которые отображаются на руке игрока от первого лица, путем реализации интерфейса RendersArmInFirstPerson в вашем средстве рендеринга функций.
• Утилита пользовательской модели брони: позволяет добавлять броню с помощью пользовательских моделей с помощью одного вызова метода (и пользовательской модели), минуя требования создания слоя модели, средства рендеринга функций, примесей для внедрения указанного средства рендеринга функций в рендеринг игрока и стойки для брони, кодирования условий отображения и т. д., а также автоматически отображать указанную пользовательскую броню на руках игрока от первого лица. Руководство по использованию можно найти ниже.

Дополнительные вкусности

• Крысиные плюшевые игрушки (Крысиная горничная, Фолли и Лиловый)
  • Можно сигналить
  • Блокноты можно разместить сверху, чтобы воспроизводить звуковой сигнал плюша в качестве инструмента.
• Мобам можно давать предметы и броню, взаимодействуя с ними в творческом режиме и прокрадываясь с предметом в руке. Если вы нанесете им творческий удар во время кражи с пустой рукой, они бросят все свои экипированные предметы.

Косметика сторонника

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

Галерея

Развернуть галерею

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

Развернуть документацию

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

Развернуть сведения о Gradle

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

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

Использование пользовательской модели брони

Развернуть подробную информацию о пользовательской модели брони

Эта утилита позволяет вам легко регистрировать новые наборы брони, использующие пользовательскую модель, с помощью одного вызова метода (и эта пользовательская модель, поскольку игра должна знать, что вы хотите отобразить).

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

Прежде чем мы сможем добавить нашу собственную броню, нам нужна модель, которая соответствует нескольким правилам. Модель шаблона брони (файл модели Blockbench) и текстуру вы можете найти в папке RESOURCES репозитория. Хотя вы можете свободно редактировать эту модель и текстуру, чтобы придать форму доспехам своей мечты, обратите внимание, что существующие группы очень важны, и хотя вы можете добавлять к ним новые подгруппы, вы не можете и не должны удалять любую существующую группу, поскольку они позволяют библиотеке знать, что должно отображаться, когда игрок (или подставка для брони, или моб) надевает части брони:

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

После завершения создания модели вы можете экспортировать ее с помощью Blockbench: File -> Export -> Export Java Entity. Откройте сгенерированный класс Java и скопируйте строки между ModelPartData modelPartData = modelData.getRoot(); и строкой прямо перед возвратом (включенной) в getTexturedModelData(). Рататуй добавляет новый тип класса модели, который упрощает определение модели доспехов, под названием CustomArmorModelDefinition; расширьте этот класс и реализуйте метод addModelParts, вставив фрагмент, скопированный из сгенерированного класса модели. Затем реализуйте getTexture(); Самый простой способ сделать это — иметь статический идентификатор для вашей текстуры брони в классе определения модели и возвращать его, но если вы хотите реализовать специальную логику, которая изменяет возвращаемую текстуру, вы, естественно, также можете это сделать.

Шаг 2: Регистрация пользовательской брони в Рататуе

Второй и последний шаг — зарегистрировать собственный рендеринг брони при инициализации клиента. Вызовите CustomModelArmorUtil.registerCustomArmor и задайте ему необходимые параметры:

• Identifier id: идентификатор пользовательской брони. Это используется для автоматического создания и регистрации слоя модели вашей брони, поэтому он должен быть уникальным.
• ArmorDisplayConditions displayConditions: условия отображения, которым необходимо соответствовать для рендеринга частей вашей брони. Если вам нужна простая броня, в которой отображаются ее части для каждого предмета, который вы надеваете, ItemSetDisplayConditions позволяет вам определить элементы шлема, нагрудника, поножей и ботинок и автоматически проверять, какие элементы брони экипированы и должны отображаться, а также предотвратить рендеринг модели ванильных доспехов с отсутствующей текстурой. Если вы хотите иметь собственную логику для отображения различных частей, которая не просто проверяет, носится ли предмет, вы можете реализовать метод ArmorDisplayConditions и четыре его метода shouldDisplay.
• CustomArmorModelDefinition armorModelDefinition: определение модели, которое мы создали на шаге 1, просто создайте его новый экземпляр.
• int textureWidth, int textureHeight: ширина и высота текстуры брони.

Регистрация вашей брони с помощью этого вызова метода позаботится обо всем за вас, например, о создании данных текстурированной модели, слоя модели и добавлении функции к рендере игрока/подставки для брони/моба. Если вам нужен доступ к данным модели или слою модели брони, вы можете найти их в CustomModelArmorUtil.CUSTOM_ARMOR_MODELS HashMap, используя displayConditions брони в качестве ключа.

Утилита окружения

Подробности об использовании «Расширить атмосферу» Эта утилита позволяет вам легко регистрировать окружающие петли в качестве общего фонового звука или блокировать аудио, зависящее от объекта.

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

Чтобы зарегистрировать фоновую атмосферу, все, что вам нужно сделать, это вызвать метод AmbienceUtil.registerBackgroundAmbience в классе инициализатора вашего клиента и передать ему новый объект BackgroundAmbience с необходимыми параметрами:

• SoundEvent soundEvent: воспроизводимый окружающий звук.
• SoundCategory soundCategory: аудиокатегория для воспроизведения звука.
• PlayPredicate predicate: предикат, определяющий, разрешено ли воспроизведение звука или нет. Принимает ClientPlayerEntity и должен возвращать логическое значение.
• int fadeIn: Время затухания окружающего цикла при его начале воспроизведения (в тактах).
• int fadeOut: время затухания окружающего цикла после его остановки воспроизведения (в тактах).

Регистрация окружения объекта блока

Чтобы зарегистрировать атмосферу блочного объекта, все, что вам нужно сделать, это вызвать метод AmbienceUtil.registerBlockEntityAmbience в классе инициализатора вашего клиента и передать ему BlockEntityType<? extends BlockEntity>, который должен воспроизводить указанную атмосферу, и новый объект BlockEntityAmbience с необходимыми параметрами:

• SoundEvent soundEvent: воспроизводимый окружающий звук.
• SoundCategory soundCategory: категория аудио, в которой воспроизводится звук.
• PlayPredicate predicate: предикат, определяющий, разрешено ли воспроизведение звука или нет. Принимает BlockEntity и должен возвращать логическое значение.
• int fadeIn: Время затухания окружающего цикла при его начале воспроизведения (в тактах).
• int fadeOut: время затухания окружающего цикла после его остановки (в тактах).