[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
[![Discord][discord-shield]][discord-url]
[![Modrinth][modrinth-shield]][modrinth-url]
ModMenu Badges Lib
更多徽章!!!
支持
·
报告 Bug
·
功能请求
目录
- 关于本项目
- 用法
- 路线图
- 贡献
- 许可证
关于本项目
![游戏内截图][screenshot]
这只是一个简单的库,用于为 ModMenu 添加你自己的徽章。
例如,Tschipcraft 在 Dynamic Lights 中使用它来显示 Data Pack 徽章。
(返回顶部)
用法
Mod 开发者
- 在
build.gradle或build.gradle.kts中添加 Gradle 依赖
repositories {
maven("https://api.modrinth.com/maven")
}
dependencies {
// 选项 1:将 ModMenu Badges Lib 包含进项目,使其在你自己的 jar 中可用(额外约 ~5kb)
include(modImplementation("maven.modrinth", "modmenu-badges-libb", ""))
// 选项 2:依赖 ModMenu Badges Lib,但要求用户手动安装它
modImplementation("maven.modrinth", "modmenu-badges-lib", "")
}
- 在你的 fabric.mod.json 中添加推荐依赖
"recommends": {
"modmenu-badges-lib": "*"
}
- 打开 ModMenu Badges Generator,复制结果并添加到你的
fabric.mod.json 中。
> 备用颜色代码生成器:https://argb-int-calculator.netlify.app
{
...
"custom": {
"mcb": [
{
// 徽章文本
"name": "Example Badge",
// 填充颜色
"fillColor": -2003942227,
// 描边颜色
"outlineColor": -2003084874
},
{
//下一个徽章
}
]
},
...
}
整合包开发者
- 在你的整合包实例根目录中创建
modmenu-extra-badges.json文件
(.minecraft 文件夹,或取决于启动器的其他位置)
- 使用下面的示例按你的需要进行编辑
颜色值生成工具:https://syorito-hatsuki.github.io/modmenu-badges-lib/
{
// Mod ID
"modmenu-badges-lib": {
// 按字母顺序排序徽章 [默认: false]
"sort": true,
// 用新的徽章覆盖全部,也就是删除所有旧徽章 [默认: false]
"overwrite": true,
// modmenu-badges-lib 徽章列表
"badges": [
{
// name 是唯一必需的值。
// 如果缺少,其他值会根据它自动生成
"name": "Another House"
},
{
// 必需
"name": "COLORFUL",
// 可选
"labelColor": -16711936,
// 可选
"fillColor": -16776961,
// 可选
"outlineColor": -65536,
// 可选
"delete": false
},
]
},
// 删除默认的 Minecraft 徽章
"minecraft": {
"badges": [
{
"delete": true,
"name": "Minecraft"
},
]
}
}
路线图
- [ ] 按徽章搜索
- [x] 自带在线徽章编辑器并支持实时预览
完整的计划功能列表(以及已知问题)请参见 open issues。
(返回顶部)
贡献
贡献正是让开源社区成为如此美妙之地的原因——在这里人们可以学习、获得灵感并创造。任何
你做出的贡献都将被高度赞赏。
如果你有能让这个项目变得更好的建议,请 fork 本仓库并创建一个 pull request。你也可以
直接创建一个带有 "enhancement" 标签的 issue。
别忘了给这个项目点个 star!再次感谢!
- Fork 本项目
- 创建你的功能分支(
git checkout -b feature/AmazingFeature) - 提交你的更改(
git commit -m 'Add some AmazingFeature') - 推送到该分支(
git push origin feature/AmazingFeature) - 打开一个 Pull Request
(返回顶部)
许可证
本项目基于 MIT License 分发。更多信息请参见 LICENSE.txt。
(返回顶部)
[contributors-shield]: https://img.shields.io/github/contributors/syorito-hatsuki/modmenu-badges-lib.svg?style=for-the-badge
[contributors-url]: https://github.com/syorito-hatsuki/modmenu-badges-lib/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/syorito-hatsuki/modmenu-badges-lib.svg?style=for-the-badge
[forks-url]: https://github.com/syorito-hatsuki/modmenu-badges-lib/network/members
[stars-shield]: https://img.shields.io/github/stars/syorito-hatsuki/modmenu-badges-lib.svg?style=for-the-badge
[stars-url]: https://github.com/syorito-hatsuki/modmenu-badges-lib/stargazers
[issues-shield]: https://img.shields.io/github/issues/syorito-hatsuki/modmenu-badges-lib.svg?style=for-the-badge
[issues-url]: https://github.com/syorito-hatsuki/modmenu-badges-lib/issues
[license-shield]: https://img.shields.io/github/license/syorito-hatsuki/modmenu-badges-lib.svg?style=for-the-badge
[license-url]: https://github.com/syorito-hatsuki/modmenu-badges-lib/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/kit-lehto
[discord-shield]: https://img.shields.io/discord/1032138561618726952?logo=discord&logoColor=white&style=for-the-badge&label=Discord
[discord-url]: https://discord.gg/pbwnMwnUD6
[modrinth-shield]: https://img.shields.io/modrinth/v/modmenu-badges-lib?label=Modrinth&style=for-the-badge
[modrinth-url]: https://modrinth.com/mod/modmenu-badges-lib
[screenshot]: https://user-images.githubusercontent.com/33298273/233725872-902aa00e-618d-48d3-b594-990d2cad85ae.png