# Custom Tooltip API<\/p>\n
**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.<\/p>\n
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.<\/p>\n
***<\/p>\n
### \u2728 Key Features<\/p>\n
* **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)<\/p>\n
* **Dynamic Detection:** Target item groups via Tags (e.g., `#c:swords`) or specific IDs (e.g., `minecraft:diamond_sword`).<\/p>\n
* **Advanced Targeting:** Apply tooltips to entire mods via Namespaces (`minecraft:*`), use Regex (`regex:.*_sword`), or target all items (`*`).<\/p>\n
* **Dynamic Placeholders:** Embed real-time item data directly into your text using variables like `%max_durability%`, `%weapon_damage%`, or `%enchantments%`.<\/p>\n
* **Multi-line Support (Lore):** Add entire paragraphs of lore or skill descriptions.<\/p>\n
* **Visual Effects & Gradients:**
\n * **Rainbow:** Animated rainbow effect.
\n * **Slide Gradient:** Two-color gradients that flow through the text.
\n * **Breathing Gradient:** A smooth pulse between two colors.
\n * **Static Gradient & Solid:** Fixed gradients or traditional solid text.
\n * **Colors:** Hex codes (e.g. `#RRGGBB`), legacy codes (e.g. `&d`) or Minecraft color names (e.g. `blue`).<\/p>\n
* **Positioning:** Decide exactly where your text appears:
\n * **Top:** Right below the item’s name.
\n * **Bottom:** At the very end of all descriptions.
\n * **Prepend:** At the start of a specific line.
\n * **Append:** At the end of a specific line.
\n * **Replace Name:** Swap the item’s default name for your custom text.
\n * **Replace All:** Completely clear the original tooltip and show only yours.<\/p>\n
* **Text Modifiers:** Full support for **Bold**, *Italic*, Underlined, ~~Strikethrough~~, and O\u0337\u034d\u031e\u0350\u0351b\u0337\u033b\u030cf\u0336\u032f\u0308u\u0338\u0332\u0357\u0350s\u0336\u0329\u032c\u035dc\u0335\u034e\u030aa\u0338\u0339\u031f\u030e\u1e97\u0334\u0356\u033fe\u0334\u031f\u032a\u034a\u0308\u0301\u010f\u0334\u0339\u032a text.<\/p>\n
* **And more!**<\/p>\n
***<\/p>\n
### \u2699\ufe0f In-Game Interface (GUI)<\/p>\n
* Manage all your tooltips directly from the **Mods Menu**. No need to manually edit files unless you want to.<\/p>\n
* Hold `CTRL` in the edit screen for an instant **Live Preview** of your tooltip.<\/p>\n
***<\/p>\n
### \ud83d\udee0\ufe0f For Developers (API)<\/p>\n
Developers can use the built-in API to register tooltips directly through code, bypassing the need for JSON files or user manual configuration.<\/p>\n
* Check out the project’s README.md file on GitHub!
\n* A code example can be found here<\/p>\n
***<\/p>\n
### \ud83d\udce6 For Modpack Creators<\/p>\n
The mod generates a `custom_tooltip_api\/config.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.<\/p>\n
There’s also a `custom_tooltip_api\/fonts` folder where you can place custom fonts. The dynamically generated resourcepack needs to be enabled to make them work.<\/p>\n
***<\/p>\n
### \ud83e\udde9 Dependencies<\/p>\n
**Required:**
\n* Fabric API
\n* YACL
\n* ModMenu<\/p>\n","protected":false},"excerpt":{"rendered":"
Data-driven tooltip text creation.<\/p>\n","protected":false},"featured_media":52964,"template":"","meta":{"_minecraft_slug":"custom-tooltip-api","_minecraft_project_id":"RGKUGobH","_minecraft_author":"Stalemated","_minecraft_license":"MIT","_minecraft_downloads":55,"_minecraft_follows":0,"_minecraft_client_side":"required","_minecraft_server_side":"unsupported","_minecraft_storage_type":"zip","_minecraft_archive_name":"custom-tooltip-api.zip","_minecraft_size_bytes":677098,"_minecraft_version_count":9,"_minecraft_updated_at":"2026-05-16T17:01:13.480260Z","_minecraft_date_created":"2026-04-20T21:57:09.148955Z","_minecraft_date_modified":"2026-05-13T23:00:27.493892Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/custom-tooltip-api","_minecraft_icon_attachment_id":52964,"_minecraft_imported_at":"2026-06-02T22:31:43+00:00","_minecraft_import_hash":"d63ff0e1879b0970e308f1a787a5f715","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[88,97,873,92],"mod_loader":[99],"minecraft_version":[36,60,93,94,101,102],"class_list":["post-52963","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-equipment","mod_category-fabric","mod_category-library","mod_category-utility","mod_loader-fabric","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6"],"yoast_head":"\n