Custom Tooltip API

Custom Tooltip API

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

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

Ключевые возможности

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

• Продвинутое нацеливание: Нацеливайся на конкретные ID предметов (minecraft:diamond_sword), группы тегов (#c:swords), целые пространства имён модов (minecraft:*), Regex-шаблоны (regex:.*_sword) или сразу на все предметы (*).

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

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

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

  • Rainbow: Анимированный радужный эффект.
  • Slide Gradient: Двухцветные градиенты, плавно текущие по тексту.
  • Breathing Gradient: Плавная пульсация между двумя цветами.
  • Static Gradient & Solid: Фиксированные градиенты или обычный сплошной текст.
  • Colors: Hex-коды (например, #RRGGBB), legacy-коды (например, &d) или названия цветов Minecraft (например, blue).

• Кастомные фоны и рамки: Режимы Solid, Gradient, Texture (Stretch) или Texture (Framed / Nine-Slice) с полным контролем прозрачности. Кидай любое фоновое изображение в config/custom-tooltip-api/backgrounds/ и включай его для отдельной подсказки через динамически генерируемый ресурспак. Полная совместимость с кастомным рендерингом Tierify.

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

• Позиционирование: Решай точно, где появится твой текст:

  • Top: Прямо под названием предмета.
  • Bottom: В самом конце всех описаний.
  • Prepend: В начале конкретной строки.
  • Append: В конце конкретной строки.
  • Replace Name: Заменить стандартное название предмета на свой текст.
  • Replace Line: Заменить конкретную строку своим текстом.
  • Replace All: Полностью очистить оригинальную подсказку и показать только свою.

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

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

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

• Управляй всеми своими подсказками прямо из Mods Menu. Не нужно вручную редактировать файлы, если не хочешь.

• Зажми CTRL в экране редактирования для мгновенного Live Preview твоей подсказки.

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

Для разработчиков (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

Только для Fabric:

• Fabric API
• ModMenu