Lumen Tooltips

A client-side tooltip enhancement and visual preview mod for Minecraft: Java Edition.

Overview

Lumen Tooltips is a powerful client-side mod that enhances Minecraft's tooltips adding details, dynamic sizing, and visual previews directly in your inventory. Designed to give you more information at a glance, it replaces the need for multiple standalone mods by integrating hunger stats, container previews, and gear comparisons into one seamless package.

Key Features

• Enhanced Tooltip Data - Durability, food stats, enchantment descriptions, and gear comparisons.
• Visual Previews - See inside containers, books, fireworks, and spawn eggs without placing or using them.
• Inventory Actions - Scroll, wrap, and interact with tooltips using intuitive hotkeys.
• Text Safety - Includes a patch for the Translation Crash, which applies beyond just Tooltips.
• Fully Configurable - Change features, activation modes, keybinds, and control hints in-game without restarting.
• Cross-Loader Support - Fully compatible with both Fabric and NeoForge.
• Seamless Integration - Edit items or save them directly to Item Editor storage with configurable keybinds.

Installation

Requirements

• Minecraft (Fabric or NeoForge compatible version)
• Fabric API (if using Fabric)

Steps

1. Install Fabric Loader or NeoForge
2. Download the following files:
   • Lumen Tooltips (this mod)
   • Fabric API (if using Fabric)
3. Place all .jar files into your mods folder
4. Launch the game
5. Configure via the /lumen command in-game, or the Lumen Tooltips button in Minecraft's settings menu.

Feature Categories

Configuration

• In-Game Access: Open with /lumen or the Lumen Tooltips button in Minecraft's settings.
• Immediate Changes: Options apply without a save button or restart.
• Easy Navigation: Compact icon categories, option search, and collapsible advanced settings.
• Clear Changes: Changed-value markers plus per-option and current-menu reset buttons.
• Keybind Center: Rebind or unbind every Lumen shortcut with conflict warnings in one place.
• Live Examples: Visual options show formatted before-and-after tooltip previews.
• Control Hints: Configure preview, open, edit, and save hints without disabling their shortcuts.

Tooltip Information

• Durability Percentage: Added over Vanilla debug tooltip.
• Durability Coloring: Based on health (configurable thresholds).
• Hunger & Saturation: Icons for food (taken from AppleSkin).
• Status Effects: Food and Suspicious Stew effects.
• Enchantment Descriptions: Brief description of what the Enchantment does.
• Numeric Enchantments: Numeric levels instead of Roman numerals (disabled by default).
• Equipment Comparison: Hovered vs currently equipped item comparison.
• Vanilla Flags: Individual toggles for every registered vanilla hidden_components flag.

Navigation

• Map Exploration: Filled map / explored map percentage.
• Off-Map Direction: Direction when the player is outside the map.
• Unexplored Areas: Direction of the nearest unexplored map area.
• Lodestone Target: Target dimension and coordinates.
• Recovery Compass: Death location.
• Dimension Warning: Warning when a compass target is in another dimension.

Extra Statistics

Disabled by default; every statistic can be enabled separately.

• Fuel and Composting: Furnace burn duration and Composter success chance.
• Item Properties: Use cooldown, enchantability, and anvil prior-work penalty.
• Block Properties: Hardness, blast resistance, and Enchanting Table power.
• Tool Properties: Data-driven mining level and highest finite base mining speed.
• Item Source: Display name of the mod that registered the item.
• Display Controls: Always, hold-key, or advanced-tooltip activation and seconds/ticks units.

Tooltip Layout

• Screen Boundaries: Keeps tooltips inside screen boundaries.
• Text Wrapping: Wraps overly wide tooltip text.
• Maximum Width: Automatic and/or explicitly configured maximum width.
• Scrolling: Mouse wheel scrolling for tooltips taller than the screen.
• Scroll Speed: Configurable scroll speed/step.
• Control Hints: Configurable control hints for available actions.

Visual Previews

Configurable keybind, default Left Shift

• Shulker Boxes: Content grid with matching shulker color.
• Generic Containers: Container and chest content grids.
• Bundles: Contents with selected-item highlighting and fullness bar like vanilla.
• Filled Maps: Live map image and markers from client-known map data.
• Banners, Shields, and Decorated Pots: Enlarged vanilla item rendering with stored patterns.
• Potions and Tipped Arrows: Optional vanilla effect icons, levels, colors, and durations; disabled by default.
• Ender Chests: Session-only preview of the last Ender Chest opened in the current world.
• Paintings and Signs: Painting entities and signs or hanging signs with stored text.
• Player Heads: Enlarged native head models using stored profiles and skins.
• Written and Writable Books: First-page preview and page count, plus player heads beside author.
• Fireworks: Animated rocket and firework-star simulation, flight time, burst count, shapes, colors, trails, and twinkle.
• Spawn Eggs: Entity rendering with stored data.
• Mob Buckets: Entity rendering with stored bucket data.
• Spawners: Entity rendering from SpawnData and spawn potentials.
• Animations: Animated living entities and TNT fuse animation.
• Area-Effect Clouds: Radius, potion information and animated particles.
• Display Entities: Block, item, and text display entities.
• Item Frames: Item frames and glow item frames.
• Falling Blocks: Falling-block rendering, including end portals and gateway.
• Entity Positioning: Configurable fixed yaw and pitch for display entities.
• Entity Fitting: Automatic entity fitting, including special horse sizing.
• Invisible Entities: Shows custom_name fallback for invisible entities.
• Appearance: Compact, Vanilla, and Comfortable density plus full/compacted container contents.
• Tooltip Styles: Custom tooltip_style backgrounds and frames are respected where applicable.
• Preview Colors: Configurable container tint, counts, titles, and item-derived colors.
• Accessibility: Colorblind durability colors and reduced-motion entity and firework previews.

Opening Items

Configurable keybind, default Left Alt

• Container Contents: Open as read-only container screens.
• Written Books: Open in Minecraft’s native book viewer.
• Writable Books: Open read-only without signing or modifying them.
• Large Chests: Supports up to six vanilla chest rows.
• Inventory Support: Works from normal inventories, the Creative inventory, and Lumen-opened container screens.
• Nested Navigation: Shows breadcrumbs and a native back button while opening stored containers.
• Native Feedback: Returning to the parent plays the matching chest, Ender Chest, or Shulker Box close sound.

Text Safety

• Recursive Protection: Protection against malicious recursive translation components, highly configurable.
• Component.visit: Optional global Component.visit protection.

Extra

• Item Editor: Deep API integration with Item Editor, including shortcuts for editing and saving hovered items.
• Storage Routing: Save to the first available slot, a page number, or a named page, with optional page creation and page-number feedback.

Screenshots

Supported Languages

Contributing

Contributions are welcome! Please feel free to:

• Report bugs via GitHub Issues
• Submit feature requests
• Join the Discord for discussion

Related Projects & Inspirations

If you enjoy Lumen Tooltips, you might also be interested in the projects that inspired some of its features:

• AppleSkin: For the original hunger and saturation visualization (Lumen Tooltips implements this identically thanks to AppleSkins Unlicense).
• Meteor Client: For the shulker-box grid and rotating entity preview ideas.
• Item Editor: Lumen Tooltips features deep integration with Item Editor, allowing you to seamlessly transition from viewing an item's tooltip to editing its components.

License

This project is licensed under the terms of the license specified in the LICENSE file.

Modrinth • GitHub • Discord