|
3 | 3 |
|
4 | 4 | # MatrixLib |
5 | 5 |
|
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 |
| 6 | +`MatrixLib` 是 Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台输出、文本能力、YAML 读取、兼容层、共享菜单能力、共享货币模块,以及共享 `bStats` 遥测封装。 |
7 | 7 |
|
8 | | -`MatrixLib` 是 Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台输出、文本能力、YAML 读取、兼容层、共享菜单能力和共享货币模块。 |
| 8 | +| 文档 | Release Notes | Releases | Issues | |
| 9 | +| --- | --- | --- | --- | |
| 10 | +| [Docs](https://54895y.github.io/docs/matrixlib) | [1.3.0](https://54895y.github.io/docs/matrixlib/release-notes-1-3-0) | [GitHub Releases](https://github.com/54895y/MatrixLib/releases) | [GitHub Issues](https://github.com/54895y/MatrixLib/issues) | |
9 | 11 |
|
10 | | -MatrixLib is a shared Minecraft plugin runtime and dependency library for MatrixShop, MatrixAuth, MatrixCook and MatrixStorage. It targets Paper, Bukkit, Spigot and Folia servers, and provides shared branding, console, menu, YAML, compat, action and economy APIs. |
| 12 | +## 当前发布 |
11 | 13 |
|
12 | | -**中文关键词:** Minecraft 插件前置, Paper 插件前置, Folia 插件前置, Bukkit 插件 API, Spigot 插件 API, TabooLib 前置, Kotlin 插件库, GUI 菜单框架, 共享运行时, Matrix 插件框架 |
| 14 | +- 当前版本:`1.3.0` |
| 15 | +- 依赖坐标:`com.y54895.matrixlib:matrixlib-api:1.3.0` |
| 16 | +- 服务对象:`MatrixShop / MatrixAuth / MatrixCook / MatrixStorage` |
| 17 | +- 支持核心:`Paper / Bukkit / Spigot / Folia` |
13 | 18 |
|
14 | | -## Discoverability |
| 19 | +## 核心能力 |
15 | 20 |
|
16 | | -- English: Minecraft plugin library, Paper plugin framework, Folia plugin framework, Bukkit shared runtime, TabooLib shared API, Kotlin Minecraft library |
17 | | -- 中文: Minecraft 插件前置, 服务器插件前置, 中文控制台前置, 共享菜单前置, 兼容层前置, GUI 菜单前置, 共享货币前置 |
| 21 | +- 共享 `branding / console / text / yaml` API |
| 22 | +- 共享 `menu / compat / action / economy` API |
| 23 | +- 统一中文控制台横幅与生命周期输出 |
| 24 | +- 共享 `Economy/currency.yml` 货币定义与运行时同步 |
| 25 | +- 共享 Bukkit / Folia 兼容桥接 |
| 26 | +- 共享 `bStats` 封装 API `MatrixBStats` |
| 27 | +- 为下游插件统一承接 `bStats` shaded 依赖与图表注册 |
18 | 28 |
|
19 | | -## What MatrixLib Provides |
| 29 | +## 下游集成 |
20 | 30 |
|
21 | | -- Shared `branding / console / text / yaml` APIs |
22 | | -- Shared `menu / compat / action / economy` APIs |
23 | | -- Unified Chinese terminal banner and lifecycle output |
24 | | -- Shared Bukkit / Folia compatibility bridge |
25 | | -- Shared runtime for MatrixShop, MatrixAuth, MatrixCook and MatrixStorage |
26 | | -- Shared `Economy/currency.yml` with runtime synchronization to MatrixShop and MatrixStorage |
| 31 | +下游项目当前统一引用: |
27 | 32 |
|
28 | | -## Current Focus |
29 | | - |
30 | | -- Shared `economy` API is now part of MatrixLib |
31 | | -- `plugins/MatrixLib/Economy/currency.yml` is the source of truth for Matrix series currency definitions |
32 | | -- Runtime sync targets: |
33 | | - - `plugins/MatrixLib/Economy/currency.yml` |
34 | | - - `plugins/MatrixShop/Economy/currency.yml` |
35 | | - - `plugins/MatrixStorage/Economy/currency.yml` |
36 | | -- Supported shared currency backends: |
37 | | - - `Vault` |
38 | | - - `PlayerPoints` |
39 | | - - PlaceholderAPI-driven custom currencies |
40 | | - |
41 | | -## Downstream Build Integration |
42 | | - |
43 | | -Dependency coordinate: |
44 | | - |
45 | | -- `com.y54895.matrixlib:matrixlib-api:1.1.0` |
| 33 | +```kotlin |
| 34 | +dependencies { |
| 35 | + compileOnly("com.y54895.matrixlib:matrixlib-api:1.3.0") |
| 36 | +} |
| 37 | +``` |
46 | 38 |
|
47 | | -Downstream projects support two build modes: |
| 39 | +如果工作区里存在本地 `MatrixLib` 目录,下游项目会通过 `includeBuild` 直接链接源码;否则会通过 GitHub `sourceControl` 拉取。 |
48 | 40 |
|
49 | | -1. Local linked mode |
50 | | - If the workspace contains a local `MatrixLib` directory, downstream projects use `includeBuild` for direct local source linkage. |
51 | | -2. GitHub source mode |
52 | | - If there is no local `MatrixLib` directory, Gradle resolves MatrixLib directly from GitHub through `sourceControl`. |
| 41 | +## bStats 遥测 |
53 | 42 |
|
54 | | -Reference configuration: |
| 43 | +- Plugin ID: `30557` |
| 44 | +- 共享遥测入口:`com.y54895.matrixlib.api.metrics.MatrixBStats` |
55 | 45 |
|
56 | | -```kotlin |
57 | | -val matrixLibModule = "com.y54895.matrixlib:matrixlib-api" |
| 46 | +当前图表: |
58 | 47 |
|
59 | | -sourceControl { |
60 | | - gitRepository(uri("https://github.com/54895y/MatrixLib.git")) { |
61 | | - producesModule(matrixLibModule) |
62 | | - } |
63 | | -} |
64 | | -``` |
| 48 | +| Chart ID | 类型 | 含义 | |
| 49 | +| --- | --- | --- | |
| 50 | +| `configured_currency_count` | SingleLineChart | 当前已配置货币数量 | |
| 51 | +| `currency_modes` | AdvancedPie | 货币模式分布 | |
| 52 | +| `currency_setup` | SimplePie | 单货币 / 多货币部署类型 | |
65 | 53 |
|
66 | | -## Current Public Release |
| 54 | +预留图表位: |
67 | 55 |
|
68 | | -- `1.1.0` |
| 56 | +| 预留 Chart ID | 计划用途 | |
| 57 | +| --- | --- | |
| 58 | +| `downstream_plugin_count` | 统计当前安装的 Matrix 系列下游插件数量 | |
| 59 | +| `resource_sync_targets` | 统计共享资源同步目标分布 | |
| 60 | +| `compat_bridge_modes` | 统计兼容桥接启用情况 | |
69 | 61 |
|
70 | | -## Links |
| 62 | +## 相关链接 |
71 | 63 |
|
72 | | -- GitHub Repo: [https://github.com/54895y/MatrixLib](https://github.com/54895y/MatrixLib) |
73 | | -- Issues: [https://github.com/54895y/MatrixLib/issues](https://github.com/54895y/MatrixLib/issues) |
74 | | -- Releases: [https://github.com/54895y/MatrixLib/releases](https://github.com/54895y/MatrixLib/releases) |
75 | | -- Related docs: [https://54895y.github.io/docs/plugins](https://54895y.github.io/docs/plugins) |
| 64 | +- Matrix 插件总文档入口:[https://54895y.github.io/docs/plugins](https://54895y.github.io/docs/plugins) |
| 65 | +- Matrix 系列配置 Skill 文档:[https://54895y.github.io/docs/matrix-agent-skills/matrix-series-config](https://54895y.github.io/docs/matrix-agent-skills/matrix-series-config) |
| 66 | +- MatrixAgentSkills 仓库:[https://github.com/54895y/MatrixAgentSkills](https://github.com/54895y/MatrixAgentSkills) |
0 commit comments