HUD Icon Library 是什么?
HUD Icon Library 是一个实用模组,它为其他 Fabric 模组提供了简单的 API,用于在屏幕上显示图标。这通常用于:
- 状态指示器(生命值、法力值、耐力值等)
- 增益/减益通知(加速、力量等)
- 任务标记和目标
- 自定义 HUD 元素
- 带计时器的临时通知
功能特性
✨ 多图标支持:同时显示多个图标
⏱️ 计时器支持:图标可以是永久性的,也可以在设定时间后自动移除
? 灵活定位:可将图标放置在屏幕任意位置(默认:左上角)
? 可定制大小:默认为 16x16 像素(物品栏物品大小),完全可调
?️ 图片支持:支持 PNG 和 JPG 格式
? 文本显示:可选地在图标旁显示文本标签
⚙️ 基于代码的配置:使用简单 API,无需配置文件
? 轻量级:除 Fabric API 外无其他依赖
集成指南
本指南说明如何将 HUD Icon Library 集成到您现有的 Fabric 模组中。
目录
添加依赖
选项 1:使用编译后的 JAR
-
将 JAR 文件下载到模组的
libs/文件夹中 -
将其添加到模组的
build.gradle中:repositories { flatDir { dirs 'libs' } } dependencies { // ... 其他依赖项 // 添加 HUD Icon Library modImplementation project(':hudiconlib') include project(':hudiconlib') }
声明依赖
将库添加到您的 fabric.mod.json 依赖项中:
{
"depends": {
"fabricloader": ">=0.15.0",
"minecraft": "~1.20.1",
"hudiconlib": "*"
}
}
基本用法
导入 API
import net.cookiebrain.hudiconlib.HudIconLib;
import net.cookiebrain.hudiconlib.Icon;
创建并注册图标
简单图标(始终可见)
// 为纹理创建标识符
Identifier iconTexture = new Identifier("mymod", "textures/gui/icon.png");
// 在默认位置(左上角)创建图标
Icon myIcon = HudIconLib.createIcon(
"mymod:my_icon", // 唯一 ID
iconTexture, // 指向纹理的标识符
10, 10, 16, 16 // X, Y, 宽度, 高度
);
// 可选地添加文本
myIcon.setText("My Icon");
// 注册图标
HudIconLib.registerIcon(myIcon);
自定义位置和大小
Identifier customTexture = new Identifier("mymod", "textures/gui/custom.png");
Icon customIcon = HudIconLib.createIcon(
"mymod:custom_icon",
customTexture,
100, // X 位置
50, // Y 位置
24, // 宽度
24 // 高度
);
HudIconLib.registerIcon(customIcon);
定时图标(持续时间后自动移除)
Identifier buffTexture = new Identifier("mymod", "textures/gui/buff.png");
Icon timedIcon = HudIconLib.createIcon(
"mymod:timed_icon",
buffTexture,
10, 10, 16, 16
);
timedIcon.setText("Buff Active!");
timedIcon.setTextColor(0x00FF00); // 绿色文本
timedIcon.setDuration(30); // 30 秒
HudIconLib.registerIcon(timedIcon);
快速入门示例
以下是您模组初始化的完整示例:
package com.example.mymod;
import net.fabricmc.api.ClientModInitializer;
import net.minecraft.util.Identifier;
import net.cookiebrain.hudiconlib.HudIconLib;
import net.cookiebrain.hudiconlib.Icon;
public class MyModClient implements ClientModInitializer {
private static final String MOD_ID = "mymod";
@Override
public void onInitializeClient() {
// 初始化您的模组...
// 在初始化期间添加图标
setupIcons();
}
private void setupIcons() {
// 示例 1:永久性生命值图标
Identifier heartTexture = new Identifier(MOD_ID, "textures/gui/heart.png");
Icon healthIcon = HudIconLib.createIcon(
"mymod:health",
heartTexture,
10, 10, 16, 16
);
healthIcon.setText("❤ 20");
healthIcon.setTextColor(0xFF0000); // 红色
HudIconLib.registerIcon(healthIcon);
// 示例 2:基于计时器的增益图标
Identifier speedTexture = new Identifier(MOD_ID, "textures/gui/speed.png");
Icon buffIcon = HudIconLib.createIcon(
"mymod:speed_buff",
speedTexture,
10, 30, 16, 16
);
buffIcon.setText("Speed Boost");
buffIcon.setDuration(60); // 60 秒
HudIconLib.registerIcon(buffIcon);
}
// 您可以随时添加/移除图标
public void showCustomIcon(String message, int duration) {
Identifier infoTexture = new Identifier(MOD_ID, "textures/gui/info.png");
Icon notification = HudIconLib.createIcon(
"mymod:notification_" + System.currentTimeMillis(),
infoTexture,
10, 50, 16, 16
);
notification.setText(message);
notification.setDuration(duration);
HudIconLib.registerIcon(notification);
}
}
高级用法
使用构建器模式
Identifier advancedTexture = new Identifier("mymod", "textures/gui/advanced.png");
HudIconLib.builder("mymod:advanced_icon", advancedTexture)
.position(150, 100)
.size(32, 32)
.text("Advanced Icon")
.textColor(0xFFAA00)
.duration(45)
.alpha(0.8f)
.buildAndRegister();
动态图标管理
// 显示/隐藏图标
HudIconLib.hideIcon("mymod:my_icon");
HudIconLib.showIcon("mymod:my_icon");
// 移除图标
HudIconLib.removeIcon("mymod:my_icon");
// 检查图标是否存在
if (HudIconLib.hasIcon("mymod:my_icon")) {
// 执行某些操作
}
// 更新现有图标 Icon icon = HudIconLib.getIcon("mymod:my_icon"); if (icon != null) { icon.setText("Updated text"); icon.setAlpha(0.5f); }
// 清除所有图标 HudIconLib.clearAllIcons();
### 响应游戏事件
```java
import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;
public class MyModClient implements ClientModInitializer {
@Override
public void onInitializeClient() {
// 在玩家每次客户端 Tick 时更新图标
ClientTickEvents.END_CLIENT_TICK.register(client -> {
if (client.player != null) {
updatePlayerIcons(client.player);
}
});
}
private void updatePlayerIcons(PlayerEntity player) {
// 更新生命值显示
Icon healthIcon = HudIconLib.getIcon("mymod:health");
if (healthIcon != null) {
int health = (int) player.getHealth();
healthIcon.setText("❤ " + health);
}
// 显示低生命值警告
if (player.getHealth() < 6.0f) {
if (!HudIconLib.hasIcon("mymod:low_health_warning")) {
Identifier warningTexture = new Identifier("mymod", "textures/gui/warning.png");
Icon warning = HudIconLib.createIcon(
"mymod:low_health_warning",
warningTexture,
10, 50, 16, 16
);
warning.setText("Low Health!");
warning.setTextColor(0xFF0000);
HudIconLib.registerIcon(warning);
}
} else {
HudIconLib.removeIcon("mymod:low_health_warning");
}
}
}
最佳实践
1. 图标文件组织
将图标文件存储在可预测的位置:
src/main/resources/
assets/
yourmod/
textures/
gui/
icon1.png
icon2.png
2. 使用命名空间 ID
始终使用模组 ID 前缀来标记你的图标 ID:
// 推荐做法
HudIconLib.createIcon("mymod:health_icon", ...)
// 不推荐 - 可能与其他模组冲突
HudIconLib.createIcon("health_icon", ...)
3. 清理定时图标
对于短暂显示的图标,请务必使用 .setDuration() 以便自动移除:
icon.setDuration(30); // 30 秒后自动移除
4. 检查现有图标
在创建重复图标之前:
if (!HudIconLib.hasIcon("mymod:my_icon")) {
Icon icon = HudIconLib.createIcon(...);
HudIconLib.registerIcon(icon);
}
5. 安全处理空值
获取图标时:
Icon icon = HudIconLib.getIcon("mymod:my_icon");
if (icon != null) {
// 更新图标
}
6. 性能考量
- 限制同时存在的图标数量(建议:< 20)
- 使用合适的图标尺寸(推荐 16x16,避免使用大图片)
- 在不再需要时移除图标
7. 文本格式化
使用 Minecraft 颜色代码为文本着色:
icon.setTextColor(0xFFFFFF); // 白色
icon.setTextColor(0xFF0000); // 红色
icon.setTextColor(0x00FF00); // 绿色
icon.setTextColor(0x0000FF); // 蓝色
icon.setTextColor(0xFFAA00); // 橙色
故障排除
图标未出现
- 检查文件路径:确保纹理路径正确且文件存在
- 检查可见性:确认
icon.isVisible()返回 true - 检查注册状态:验证图标是否已成功注册
图标闪烁
- 不要每帧都创建/移除图标
- 使用
hideIcon()/showIcon()代替移除并重新创建
性能问题
- 减少同时存在的图标数量
- 使用更小的纹理文件
- 使用
removeIcon()或clearAllIcons()移除未使用的图标
示例项目结构
your-mod/
├── build.gradle
├── src/main/
│ ├── java/com/yourmod/
│ │ ├── YourMod.java
│ │ └── YourModClient.java
│ └── resources/
│ ├── fabric.mod.json
│ └── assets/
│ └── yourmod/
│ └── textures/
│ └── gui/
│ ├── icon1.png
│ └── icon2.png
└── libs/
└── hudiconlib-0.2.0.jar
你是这个资源的作者?登录后可认领此资源。
相似资源
一个用于收集生物掉落物的多区块模组。
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
查看物品与配方
在游戏画面角落显示附近世界地形、玩家、生物和实体的地图。可创建路径点,帮助你找到标记过的位置。
AE2:一款流行的自动化与存储模组
评论 0
登录后参与评分
还没有评论,来抢沙发吧