Skip to content

Commit 3c27ce7

Browse files
author
54895y
committed
Document GitHub source consumption for MatrixLib
1 parent ec56888 commit 3c27ce7

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,31 @@
11
# MatrixLib
22

3-
MatrixLib 是 Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台加载动画、文本前缀、YAML 消息读取和资源文件操作
3+
`MatrixLib` 是 Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台输出、文本能力、YAML 读取、兼容层和共享菜单能力
44

5-
它的目标是把 MatrixShopMatrixAuthMatrixCook 中重复的基础能力抽离出来,减少重复实现,保证后续功能和风格迭代可以集中维护
5+
它的目标是把 `MatrixShop``MatrixAuth``MatrixCook` 中重复、稳定、可复用的基础设施沉淀出来,减少重复实现,统一后续维护入口
66

7-
## 适用范围
7+
## 提供能力
88

9-
- 统一 Matrix 系列插件的文本与控制台视觉风格
10-
- 提供共享的消息、资源和辅助 API
11-
- 作为其他 Matrix 插件的前置依赖
9+
- 共享 `branding / console / text / yaml` 能力
10+
- 共享 `menu / compat / action` API
11+
- 统一终端 banner 与中文生命周期输出
12+
- 统一 Bukkit / Folia 兼容桥接
13+
14+
## GitHub 源码构建
15+
16+
`MatrixLib` 现在作为公开 GitHub 仓库提供给下游插件直接参与构建。
17+
18+
下游仓库的 `settings.gradle.kts` 已支持两种模式:
19+
20+
1. 本地开发模式
21+
如果工作区存在本地 `MatrixLib` 目录,则优先通过 `includeBuild` 直接联动本地源码。
22+
2. GitHub 构建模式
23+
如果本地没有 `MatrixLib` 目录,则 Gradle 会通过 `sourceControl` 从 GitHub 拉取 `MatrixLib` 源码参与构建。
24+
25+
GitHub 仓库地址:
26+
27+
- Repo: [https://github.com/54895y/MatrixLib](https://github.com/54895y/MatrixLib)
1228

1329
## Wiki
1430

1531
- 项目 Wiki: [https://github.com/54895y/MatrixLib/wiki](https://github.com/54895y/MatrixLib/wiki)
16-
- 说明: 当前单独的 `54895y/wiki` 代码仓库为空,文档入口以本仓库 Wiki 地址为准

0 commit comments

Comments
 (0)