Custom Tooltip API

Пользовательский API всплывающей подсказки

Custom Tooltip API — это мощная клиентская библиотека модов и разработчиков Minecraft для Minecraft, которая дает вам полный контроль над всплывающими подсказками к элементам. Добавляйте собственные знания, динамические данные в реальном времени, анимированные градиенты и собственные фоны — все это можно настроить в игре или с помощью кода.

Нет необходимости писать код для базового использования, поскольку он имеет мощный внутриигровой интерфейс и полную поддержку JSON. Однако он также предоставляет надежный API разработчика для тех, кто хочет внедрять всплывающие подсказки через код.

Ключевые особенности

• Выравнивание значков: выравнивайте значки всплывающих подсказок из внешних пакетов ресурсов по началу строки, чтобы их положение оставалось постоянным!

• Расширенный таргетинг: Нацеливайтесь на конкретные идентификаторы элементов (minecraft:diamond_sword), группы тегов (#c:swords), все пространства имен модов (minecraft:*), шаблоны регулярных выражений (regex:.*_sword) или каждый элемент сразу (*).

• Динамические заполнители. Встраивайте данные об элементах в реальном времени непосредственно в текст, используя такие переменные, как %durability%, %max_durability%, %weapon_damage% или %enchantments%. Вы также можете вставлять подсказки по сочетаниям клавиш, используя формат <key:key.jump> -> [Space].

• Многострочная поддержка (знания): Добавляйте целые абзацы знаний или описаний навыков.

• Визуальные эффекты и градиенты:

• Радуга: Эффект анимированной радуги.

  • Градиент слайда: двухцветные градиенты, струящиеся по тексту.
  • Дыхательный градиент: Плавный пульс между двумя цветами.
  • Статический градиент и сплошной цвет: фиксированные градиенты или традиционный сплошной текст.
  • Цвета: шестнадцатеричные коды (например, #RRGGBB), устаревшие коды (например, &d) или названия цветов Minecraft (например, blue).

• Настраиваемый фон и границы: режимы «Сплошной», «Градиент», «Текстура (растяжение)» или «Текстура (в рамке / девять фрагментов)» с полным контролем непрозрачности. Перетащите любое фоновое изображение в config/custom-tooltip-api/backgrounds/ и включите его для каждой подсказки через динамически генерируемый пакет ресурсов. Поддерживает полную совместимость с пользовательским рендерингом Tierify.

• Пользовательские шрифты: Перетащите любой шрифт в config/custom-tooltip-api/fonts/ и включите его для каждой подсказки с помощью динамически создаваемого пакета ресурсов.

• Размещение. Решите, где именно будет отображаться ваш текст:

• Вверху: Прямо под названием элемента.

  • Внизу: В самом конце всех описаний.
  • Prepend: в начале определенной строки.
  • Добавить: В конце определенной строки.
  • Заменить имя. Замените имя элемента по умолчанию на собственный текст.
  • Заменить строку: Замените определенную строку собственным текстом.
  • Заменить все. Полностью очистите исходную всплывающую подсказку и отобразите только свою.

• Условия видимости: всплывающая подсказка отображается только в том случае, если предмет поврежден, зачарован или нерушим. Используйте режим Требовать привязку клавиш, чтобы скрыть всплывающие подсказки до тех пор, пока игрок не удержит настраиваемую клавишу.

• Модификаторы текста: Полная поддержка шрифтов Жирный, Курсив, Подчеркнутый, ~~Зачеркнутый~~ и O̷͍̞͐͑b̷̻̌f̶̯̈u̸̲͗͐s̶̩̬͝c̵͎̊a̸̹̟̎ẗ̴͖̿e̴̟̪͊̈́ď̴̹̪ (запутанный) текст.

Внутриигровой интерфейс (GUI)

• Управляйте всеми всплывающими подсказками прямо из Меню модов. Нет необходимости редактировать файлы вручную, если вы этого не хотите.

• Удерживайте CTRL на экране редактирования, чтобы мгновенно просмотреть предварительный просмотр вашей всплывающей подсказки.

• Копирование/вставка записей в буфер обмена, изменение порядка, дублирование, включение/отключение и сортировка по дате создания или в алфавитном порядке.

Для разработчиков (API)

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

• Ознакомьтесь с файлом проекта README.md] на GitHub!
• Пример кода можно найти здесь

Для создателей модпаков

Мод создает файл custom_tooltip_api/config.json5 в вашей папке config. Он полностью поддерживает комментарии к коду, что позволяет невероятно легко документировать системы вашего модпака для вашей команды разработчиков или сообщества.

Перетащите пользовательские фоны в config/custom-tooltip-api/backgrounds/, а пользовательские шрифты в config/custom-tooltip-api/fonts/. Включите динамически создаваемый пакет ресурсов, чтобы активировать их.

Зависимости

Требуется на всех платформах:

• S-Lib
• YACL

Только ткань:

• API фабрики
• ModMenu