Custom Tooltip API is a client-side Minecraft mod that gives you complete control over how item tooltips look and behave. It works with Forge, Fabric, and NeoForge on Minecraft 1.20.1 and 1.21.1. The mod runs only on the client and doesn't require server installation.
You can add custom text, dynamic data, and visual effects to tooltips for any item. This includes real-time values like durability, damage, or enchantments. You can also use placeholders for keybind hints, such as showing [Space] when the jump key is held. Text supports formatting like bold, italic, underlined, strikethrough, and obfuscated styles.
Visual effects include animated rainbow gradients, sliding two-color gradients, breathing pulses, and static gradients or solid colors. You can use hex codes, legacy Minecraft formatting codes, or named colors like blue or red.
The mod supports custom backgrounds and fonts. You can drop image files into the config/custom-tooltip-api/backgrounds/ folder and font files into config/custom-tooltip-api/fonts/. These are loaded via a dynamically generated resource pack and can be enabled per tooltip. Background modes include solid, gradient, stretch, and framed/nine-slice textures with full opacity control.
You control exactly where the tooltip appears. Options include placing it above the default tooltip, below it, at the start or end of a specific line, or replacing the item name, a single line, or the entire tooltip.
Visibility conditions let you show tooltips only when an item is damaged, enchanted, or unbreakable. You can also set tooltips to appear only when a specific key is held, using the Require Keybind mode.
All tooltip management happens in-game through the Mods Menu. Real talk, you can create, edit, duplicate, enable, disable, sort, and preview tooltips live by holding CTRL in the edit screen. No file editing is needed for basic use.
For developers, the mod includes a fluent API to register tooltips and custom placeholders directly from code. This allows dynamic text that updates every frame based on NBT data or other game states. API-generated tooltips merge with user-defined JSON configs.
Modpack creators benefit from a commented config.json5 file that documents tooltip setups. This makes it easier to share and maintain modpack systems with a team or community.
