✦ Custom Tooltip API ✦

Custom Tooltip API is a fully client-side tool for developers, modpack creators, and players who want absolute control over item tooltips. This mod allows you to add custom lore, rarities, and great visual effects to any item's tooltip with ease.

No need to code for basic usage, as it features a powerful in-game interface and full JSON support. However, it also provides a robust Developer API for those who want to inject tooltips via code.

✨ Key Features

Icon Alignment: Align tooltip icons from external resource packs to the start of the line so the position stays consistent! (Can toggle it on / off)
Dynamic Detection: Apply your tooltips to entire item groups using Tags (e.g., #c:swords, #c:ores) or to specific items via their ID (e.g., minecraft:diamond_sword).
Multi-line Support (Lore): Add entire paragraphs of lore or skill descriptions.
Visual Effects & Gradients:
- Rainbow: Animated rainbow effect.
- Slide Gradient: Two-color gradients that flow through the text.
- Breathing Gradient: A smooth pulse between two colors.
- Static Gradient & Solid: Fixed gradients or traditional solid text.
- Colors: Minecraft formatting colors and Hex codes (#RRGGBB).
Positioning: Decide exactly where your text appears:
- Top: Right below the item's name.
- Bottom: At the very end of all descriptions.
- Prepend: At the start of a specific line.
- Append: At the end of a specific line.
- Replace Name: Swap the item's default name for your custom text.
- Replace All: Completely clear the original tooltip and show only yours.
Text Modifiers: Full support for Bold, Italic, Underlined, ~~Strikethrough~~, and O̷͍̞͐͑b̷̻̌f̶̯̈u̸̲͗͐s̶̩̬͝c̵͎̊a̸̹̟̎ẗ̴͖̿e̴̟̪͊̈́ď̴̹̪ text.

⚙️ In-Game Interface (GUI)

Manage all your tooltips directly from the Mods Menu. No need to manually edit files unless you want to!

Full ModMenu Integration: Complete configuration support including friendly hints, default examples, and localization support.
Live Tooltip Previews: See your custom tooltip rendered in real-time inside the selection screen for faster editing.

🛠️ For Developers (API)

Developers can use the built-in API to register tooltips directly through code, bypassing the need for JSON files or user manual configuration.

Easy Registration: Simply call CustomTooltipApi.registerTooltip(entry) to add your dynamic tooltips to the game.
Seamless Integration: Code entries are merged with user-defined JSON entries, ensuring maximum compatibility and flexibility for your own mods.
A code example can be found here

📦 For Modpack Creators

The mod generates a custom_tooltips.json5 file in your config folder. It fully supports code comments, making it incredibly easy to document your modpack's systems for your development team or community.