自定义工具提示API

自定义工具提示API

数据驱动的提示文本创建。

自定义工具提示API预览查看大图

自定义提示框 API

自定义提示框 API 是一款功能强大的客户端 Minecraft 模组和开发者库，让您能够完全掌控物品提示框。添加自定义描述、动态实时数据、动画渐变和自定义背景，所有这些都可以在游戏内或通过代码进行配置。

基本使用无需编写代码，因为它拥有强大的游戏内界面和完整的 JSON 支持。同时，它也提供了健壮的开发者 API，供那些希望通过代码注入提示框的用户使用。

⚠️ 寻找提示框滚动或调整大小功能？ 从 4.0.0 版本开始，所有提示框滚动、调整大小和自定义尺寸限制功能已移至单独独立的模组：智能提示框滚动 (STS)。 此外，此模组现在需要 S-Lib 才能运行。

✨ 主要特性

  • 图标对齐： 将来自外部资源包的提示框图标对齐到行首，确保位置保持一致！

  • 高级目标定位： 定位特定的物品 ID（minecraft:diamond_sword）、标签组（#c:swords）、整个模组命名空间（minecraft:*）、正则表达式模式（regex:.*_sword），或一次性匹配所有物品（*）。

  • 动态占位符： 使用 %durability%、%max_durability%、%weapon_damage% 或 %enchantments% 等变量将实时物品数据直接嵌入到文本中。您还可以使用 <key:key.jump> → [空格] 的格式嵌入按键提示。

  • 多行支持（描述）： 添加整段背景故事或技能描述。

  • 视觉效果与渐变：

    • 彩虹： 动画彩虹效果。
    • 滑动渐变： 在文本中流动的双色渐变。
    • 呼吸渐变： 两种颜色之间的平滑脉动。
    • 静态渐变与纯色： 固定渐变或传统的纯色文本。
    • 颜色： 十六进制代码（如 #RRGGBB）、传统代码（如 &d）或 Minecraft 颜色名称（如 blue）。

  • 自定义背景与边框： 支持纯色、渐变、纹理（拉伸）或纹理（带框 / 九宫格）模式，并可完全控制透明度。将任何背景图片放入 config/custom-tooltip-api/backgrounds/ 目录，然后通过动态生成的资源包为每个提示框启用。完全兼容 Tierify 自定义渲染。

  • 自定义字体： 将任何字体放入 config/custom-tooltip-api/fonts/ 目录，然后通过动态生成的资源包为每个提示框启用。

  • 定位： 精确决定文本显示的位置：

    • 顶部： 紧接在物品名称下方。
    • 底部： 在所有描述的最末尾。
    • 前置： 在特定行的开头。
    • 追加： 在特定行的末尾。
    • 替换名称： 用您的自定义文本替换物品的默认名称。
    • 替换行： 用您的自定义文本替换特定行。
    • 全部替换： 完全清除原始提示框，只显示您的内容。

  • 可见性条件： 仅当物品处于受损、附魔或不可破坏状态时显示提示框。使用需要按键模式，在玩家按住可配置的按键之前隐藏提示框。

  • 文本修饰符： 完全支持粗体、斜体、下划线、删除线和 O̷͍̞͐͑b̷̻̌f̶̯̈u̸̲͗͐s̶̩̬͝c̵͎̊a̸̹̟̎ẗ̴͖̿e̴̟̪͊̈́ď̴̹̪ （混淆）文本。

⚙️ 游戏内界面 (GUI)

  • 直接从模组菜单管理您的所有提示框。除非您愿意，否则无需手动编辑文件。
  • 在编辑界面按住 CTRL 键，即可即时实时预览您的提示框。
  • 将条目复制/粘贴到剪贴板、重新排序、复制、启用/禁用，以及按创建日期或字母顺序排序。

🛠️ 对于开发者 (API)

开发者可以使用内置 API 通过代码直接注册提示框和自定义占位符，并支持完整的 .dynamicText() 功能，可用于能量、魔力或任何自定义 NBT 等实时逐帧数据。

📦 对于整合包作者

此模组会在您的 config 文件夹中生成一个 custom_tooltip_api/config.json5 文件。它完全支持代码注释，使您能够极其轻松地为您的开发团队或社区记录整合包的机制。

将自定义背景放入 config/custom-tooltip-api/backgrounds/ 目录，将自定义字体放入 config/custom-tooltip-api/fonts/ 目录。启用动态生成的资源包来激活它们。

🧩 依赖项

所有平台必需：

仅限 Fabric：