一款高度可定制的 Minecraft Profile UI 库。
? 概述
Profile API 不仅仅是一个状态查看器——它是一个精致、模块化的 Minecraft UI 框架。右键点击任意玩家,即可访问一个结构精美的个人资料屏幕,显示实时角色模型、装备以及来自模组生态系统的动态数据。
✨ 主要特性
- ? 实时 3D 预览:以高分辨率居中渲染的方式,全方位展示玩家的华丽形象。
- ?️ 互动式装备:查看已装备的护甲槽位,悬停时显示名称、附魔和属性等工具提示。
- ? 结构化数据:信息以整洁的行布局组织,并带有微妙的强调效果。
- ? 高级视觉效果:
- 精美面板:带有边框的 UI 元素,营造专业且“嵌入式”的感觉。
- 条件着色:生命值显示为红色,经验值显示为绿色,称号颜色与队伍颜色匹配。
- 动态图标:自动为生命值、饥饿值和 XP 生成图标(支持开发者自定义图标)。
- ⚙️ 极致可配置:可以切换几乎所有视觉元素——从 3D 模型到“精美”面板样式。
- ? 模块化 API:开发者可以在几秒钟内注册自定义的“Profile 组件”。
?️ 面向开发者
添加到你的项目 (Gradle)
repositories {
maven {
name = "GitHubPackages"
url = uri("https://maven.pkg.github.com/yigit-guven/Profile-API")
}
}
dependencies {
implementation "net.yigitguven.profile:profile:VERSION"
}
注册组件
ProfileRegistry.register(player -> new ProfileComponent() {
@Override
public ResourceLocation getId() {
return new ResourceLocation("yourmod", "example_stat");
}
@Override
public Component getTitle() {
return Component.literal("Strength");
}
@Override
public Component getValue() {
// 可以是动态着色的文本
return Component.literal("Lv. 99").withStyle(ChatFormatting.GOLD);
}
@Override
public ResourceLocation getIcon() {
return new ResourceLocation("yourmod", "textures/gui/strength_icon.png");
}
});
? 如何使用?
安装
- 从 Modrinth 或 CurseForge 下载最新版本。
- 将
.jar 文件放入你的 Minecraft mods 文件夹中。
- 确保已安装正确版本的 加载器。
控制
- 右键点击任意玩家以查看其个人资料。
- 命令:
/profile view <player>(支持查看自己和他人)。
许可证与使用
整合包
你完全可以自由地将 Profile API 包含在任何整合包中!无需明确许可,但如果能链接回此页面则深表感谢。
基于 Profile API 进行开发
我们鼓励其他开发者将 Profile API 作为依赖项使用!由于它采用 LGPL 3.0 许可证授权,只要你不对 Profile API 源代码本身进行修改,你就可以构建依赖于该库的模组,而无需将你自己的模组也置于 LGPL 协议之下。
? 项目链接
❤️ 支持本项目
如果你觉得这个库有用,请考虑:
- ⭐ 点亮星标 仓库!
- ? 关注我在 GitHub、Modrinth 和 CurseForge。
- ?️ 制作模组:创建依赖于 Profile API 的新模组以壮大生态系统。
- ? 服务器托管:通过我们的链接购买由 BisectHosting 提供的服务器,享受 25% OFF 优惠:在此获取 25% 折扣!
A highly customizable Profile UI library for Minecraft.
? Overview
Profile API is more than just a stats viewer—it's a polished, modular UI framework for Minecraft. By right-clicking any player, you gain access to a beautifully structured profile screen showing real-time character models, equipment, and dynamic data from across the modding ecosystem.
✨ Key Features
- ? Real-time 3D Preview: See players in their full glory with high-resolution, centered 3D model rendering.
- ?️ Interactive Equipment: View equipped armor slots with hoverable tooltips showing names, enchantments, and stats.
- ? Structured Data: Information is organized into clean, row-based layouts with subtle highlights.
- ? Premium Visuals:
- Fancy Panels: Framed UI elements for a professional, "embedded" feel.
- Conditional Coloring: Health is Red, Experience is Green, and Titles match Team colors.
- Dynamic Icons: Automatic icons for Health, Hunger, and XP (with custom Icon support for developers).
- ⚙️ Ultra Configurable: Toggle almost every visual element—from the 3D model to the "Fancy" panel styling.
- ? Modular API: Developers can register custom "Profile Components" in seconds.
?️ For Developers
Adding to your project (Gradle)
repositories {
maven {
name = "GitHubPackages"
url = uri("https://maven.pkg.github.com/yigit-guven/Profile-API")
}
}
dependencies {
implementation "net.yigitguven.profile:profile:VERSION"
}
Registering a Component
ProfileRegistry.register(player -> new ProfileComponent() {
@Override
public ResourceLocation getId() {
return new ResourceLocation("yourmod", "example_stat");
}
@Override
public Component getTitle() {
return Component.literal("Strength");
}
@Override
public Component getValue() {
// Can be dynamic colored text
return Component.literal("Lv. 99").withStyle(ChatFormatting.GOLD);
}
@Override
public ResourceLocation getIcon() {
return new ResourceLocation("yourmod", "textures/gui/strength_icon.png");
}
});
? How 2 Play?
Installation
- Download the latest version from Modrinth or CurseForge.
- Drop the
.jar file into your Minecraft mods folder.
- Ensure you have the correct version of Mod Loader installed.
Controls
- Right-Click any player to view their profile.
- Command:
/profile view <player> (supports self-view and others).
License & Usage
Modpacks
You are absolutely free to include Profile API in any modpack! No explicit permission is required, though a link back to this page is always appreciated.
Developing with Profile API
We encourage other developers to use Profile API as a dependency! Since it is licensed under LGPL 3.0, you can build mods that depend on this library without having to license your own mod under LGPL, as long as you don't modify the Profile API source code itself.
? Project Links
❤️ Support the Project
If you find this library useful, please consider:
- ⭐ Starring the repository!
- ? Following me on GitHub, Modrinth, and CurseForge.
- ?️ Building Mods: Create new mods that depend on Profile API to grow the ecosystem.
- ? Server Hosting: Use our link to buy a server via BisectHosting with 25% OFF using our link: Get 25% Off Here!
评论 0
登录后参与评分
还没有评论,来抢沙发吧