Skip to content

Custom Tooltip Background

Allows replacing the item tooltip background and frame with a custom texture using Item definitions.

Example

A tooltip background replacement example:
json
{
  "type": "minecraft:select",
  "property": "catharsis:data_type",
  "data_type": "rarity",
  "cases": [
    {
      "when": "uncommon",
      "model": {
        "type": "catharsis:texture",
        "texture": "your_name_space:uncommon"
      }
    }
  ]
}

Behaves like item texture replacements, but the model is the following instead:

Root texture object

Condition (minecraft:condition)

Render a tooltip model based on a boolean property.

Root condition tooltip model object
  • type: minecraft:condition
  • property: type of boolean property.
    • You can find a list of all available item model boolean properties on the Minecraft wiki at Item Model Properties.
    Additionally, you can find a list of all Catharsis custom item properties in the Catharsis Conditional Properties documentation.
  • on_true: The tooltip model object when the property is true.
  • on_false: The tooltip model object when the property is false.

Range Dispatch (minecraft:range_dispatch)

Render an tooltip model based on a numeric property. Will select last entry with a threshold less than or equal to the property value.

Root range_dispatch tooltip model object
  • type: minecraft:range_dispatch
  • property: type of numeric property.
    • You can find a list of all available item model numeric properties on the Minecraft wiki at Item Model Properties.
    Additionally, you can find a list of all Catharsis custom item properties in the Catharsis Range Properties documentation.
  • Additional fields depending on the value of numeric property type.
  • scale: Optional. Will be used to scale the property value before comparing it to thresholds. Default is 1.0.
  • entries:
    • Entry object
      • threshold: The threshold value for this entry.
      • model: The tooltip model object to use for this threshold.
  • fallback: Optional. The tooltip model object to use if no thresholds are met.
    • Will render as a missing texture if fallback is needed but not provided.

Select (minecraft:select)

Render a tooltip background based on a select property.

Root select background model object
  • type: minecraft:select
  • property: type of the select property.
    • You can find a list of all available item select properties on the Minecraft wiki at Property Types.
    Additionally, you can find a list of all Catharsis select item properties in the Catharsis Select Properties documentation
  • Additional fields depending on the value of the select property type.
  • switch:
    • <value>:
  • fallback: Optional. The background model object to use if no thresholds are met.
    • Will render as a missing texture if fallback is needed but not provided.

Tree view icons from the Minecraft.wiki
Not an official Minecraft product. Not approved by or affiliated with Mojang or Microsoft.
Not approved or affiliated with Hypixel.