Skip to content

Commit 5eaf513

Browse files
author
54895y
committed
Improve MatrixLib README discoverability
1 parent a63f811 commit 5eaf513

1 file changed

Lines changed: 31 additions & 22 deletions

File tree

README.md

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,41 @@
11
> [!CAUTION]
2-
> 该项目使用codex生成,有问题请提[issue](https://github.com/54895y/MatrixLib/issues)
2+
> 本项目由 Codex 协作维护,如发现问题请直接提交 Issue。
33
44
# MatrixLib
55

6-
`MatrixLib`Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台输出、文本能力、YAML 读取、兼容层与共享菜单能力。
6+
**Keywords:** Minecraft plugin library, Paper plugin library, Folia plugin library, Bukkit plugin API, Spigot plugin API, TabooLib, Kotlin plugin library, GUI framework, shared runtime, Matrix plugin framework
77

8-
它负责承载 `MatrixShop``MatrixAuth``MatrixCook` 中重复、稳定、可复用的基础设施,减少重复造轮子,并统一后续维护入口。
8+
MatrixLib is a shared Minecraft plugin runtime and dependency library for MatrixShop, MatrixAuth and MatrixCook. It targets Paper, Bukkit, Spigot and Folia servers, and provides shared branding, console, menu, YAML, compat and action APIs.
99

10-
## 核心能力
10+
**中文关键词:** Minecraft 插件前置, Paper 插件前置, Folia 插件前置, Bukkit 插件 API, Spigot 插件 API, TabooLib 前置, Kotlin 插件库, GUI 菜单框架, 共享运行时, Matrix 插件框架
1111

12-
- 共享 `branding / console / text / yaml` 能力
13-
- 共享 `menu / compat / action` API
14-
- 统一中文终端 banner 与生命周期输出
15-
- 统一 Bukkit / Folia 兼容桥接
12+
## Discoverability
1613

17-
## 下游构建方式
14+
- English: Minecraft plugin library, Paper plugin framework, Folia plugin framework, Bukkit shared runtime, TabooLib shared API, Kotlin Minecraft library
15+
- 中文: Minecraft 插件前置, 服务器插件前置, 中文控制台前置, 共享菜单前置, 兼容层前置, GUI 菜单前置
1816

19-
下游仓库统一依赖坐标:
17+
## What MatrixLib Provides
18+
19+
- Shared `branding / console / text / yaml` APIs
20+
- Shared `menu / compat / action` APIs
21+
- Unified Chinese terminal banner and lifecycle output
22+
- Shared Bukkit / Folia compatibility bridge
23+
- Shared runtime for MatrixShop, MatrixAuth and MatrixCook
24+
25+
## Downstream Build Integration
26+
27+
Dependency coordinate:
2028

2129
- `com.y54895.matrixlib:matrixlib-api:1.0.1`
2230

23-
当前支持两种构建模式:
31+
Downstream projects support two build modes:
2432

25-
1. 本地联动模式
26-
如果工作区存在本地 `MatrixLib` 目录,则优先通过 `includeBuild` 直接联动本地源码。
27-
2. GitHub 源码模式
28-
如果本地没有 `MatrixLib` 目录,则 Gradle 会通过 `sourceControl`GitHub 拉取 `MatrixLib` 源码参与构建。
33+
1. Local linked mode
34+
If the workspace contains a local `MatrixLib` directory, downstream projects use `includeBuild` for direct local source linkage.
35+
2. GitHub source mode
36+
If there is no local `MatrixLib` directory, Gradle resolves MatrixLib directly from GitHub through `sourceControl`.
2937

30-
参考配置:
38+
Reference configuration:
3139

3240
```kotlin
3341
val matrixLibModule = "com.y54895.matrixlib:matrixlib-api"
@@ -39,12 +47,13 @@ sourceControl {
3947
}
4048
```
4149

42-
## 当前发布
50+
## Current Public Release
4351

44-
- 首个公开发布版本:`1.0.1`
45-
- GitHub Repo: [https://github.com/54895y/MatrixLib](https://github.com/54895y/MatrixLib)
52+
- First public release: `1.0.1`
4653

47-
## 文档
54+
## Links
4855

49-
- 开发文档由 `MatrixDevDocs` 仓库统一维护
50-
- Wiki 入口以仓库主页和文档仓库为准
56+
- GitHub Repo: [https://github.com/54895y/MatrixLib](https://github.com/54895y/MatrixLib)
57+
- Issues: [https://github.com/54895y/MatrixLib/issues](https://github.com/54895y/MatrixLib/issues)
58+
- Releases: [https://github.com/54895y/MatrixLib/releases](https://github.com/54895y/MatrixLib/releases)
59+
- Related docs: `MatrixDevDocs`

0 commit comments

Comments
 (0)