Skip to content

Commit d49dc9e

Browse files
committed
Add shared bStats API and prepare 1.3.0 release
1 parent 5541e13 commit d49dc9e

9 files changed

Lines changed: 470 additions & 55 deletions

File tree

CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Changelog
2+
3+
All notable changes to MatrixLib will be documented in this file.
4+
5+
The format is based on Keep a Changelog, and this project follows Semantic Versioning for release tags.
6+
7+
## [1.3.0] - 2026-04-05
8+
9+
### Added
10+
11+
- Added shared `MatrixBStats` API to centralize Matrix-series telemetry registration.
12+
- Added built-in MatrixLib telemetry charts for currency topology reporting.
13+
14+
### Changed
15+
16+
- MatrixLib now shades and owns the `bStats` runtime for downstream Matrix plugins.
17+
- MatrixAuth, MatrixCook, MatrixShop, and MatrixStorage now register telemetry through the MatrixLib API instead of direct `Metrics` access.
18+
- Updated public docs, README entry points, and release materials for the new telemetry layer.
19+
20+
### Validated
21+
22+
- Verified `bash ./gradlew build`.
23+
- Verified downstream builds for MatrixAuth, MatrixCook, MatrixShop, and MatrixStorage against `matrixlibApiVersion=1.3.0`.

README.md

Lines changed: 44 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -3,73 +3,64 @@
33
44
# MatrixLib
55

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` 遥测封装。
77

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) |
911

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+
## 当前发布
1113

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`
1318

14-
## Discoverability
19+
## 核心能力
1520

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 依赖与图表注册
1828

19-
## What MatrixLib Provides
29+
## 下游集成
2030

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+
下游项目当前统一引用:
2732

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+
```
4638

47-
Downstream projects support two build modes:
39+
如果工作区里存在本地 `MatrixLib` 目录,下游项目会通过 `includeBuild` 直接链接源码;否则会通过 GitHub `sourceControl` 拉取。
4840

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 遥测
5342

54-
Reference configuration:
43+
- Plugin ID: `30557`
44+
- 共享遥测入口:`com.y54895.matrixlib.api.metrics.MatrixBStats`
5545

56-
```kotlin
57-
val matrixLibModule = "com.y54895.matrixlib:matrixlib-api"
46+
当前图表:
5847

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 | 单货币 / 多货币部署类型 |
6553

66-
## Current Public Release
54+
预留图表位:
6755

68-
- `1.1.0`
56+
| 预留 Chart ID | 计划用途 |
57+
| --- | --- |
58+
| `downstream_plugin_count` | 统计当前安装的 Matrix 系列下游插件数量 |
59+
| `resource_sync_targets` | 统计共享资源同步目标分布 |
60+
| `compat_bridge_modes` | 统计兼容桥接启用情况 |
6961

70-
## Links
62+
## 相关链接
7163

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)

RELEASE_POST_BBCODE.txt

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
[center][size=6][b]MatrixLib[/b][/size][/center]
2+
[center][size=4]Matrix 系列统一前置插件 / 共享运行时基础层[/size][/center]
3+
[center][size=3]当前发布版本:1.3.0[/size][/center]
4+
5+
[hr]
6+
7+
[b]插件简介[/b]
8+
9+
MatrixLib 是 Matrix 系列插件的共享前置插件,用于统一品牌风格、控制台输出、文本能力、YAML 读取、兼容层、共享菜单能力和共享货币模块。
10+
11+
它主要服务于 MatrixShop、MatrixAuth、MatrixCook 和 MatrixStorage,适用于 Paper、Bukkit、Spigot 和 Folia 服务端生态。
12+
13+
[b]核心功能[/b]
14+
15+
[list]
16+
[*]提供共享的 branding / console / text / yaml API
17+
[*]提供共享的 menu / compat / action / economy API
18+
[*]统一中文控制台横幅与生命周期输出
19+
[*]提供 Bukkit / Folia 兼容桥接能力
20+
[*]提供共享的 Economy/currency.yml 货币配置入口
21+
[*]运行时可同步货币配置到 MatrixShop 与 MatrixStorage
22+
[*]支持 Vault、PlayerPoints 与基于 PlaceholderAPI 的自定义货币动作
23+
[*]提供共享 JDBC datasource factory
24+
[*]提供共享 item hook registry,当前已覆盖 CraftEngine、ItemsAdder、Oraxen
25+
[*]提供共享 Bukkit 插件查找与反射命令注册辅助能力
26+
[/list]
27+
28+
[b]Wiki / 相关地址[/b]
29+
30+
[list]
31+
[*]项目仓库:[url]https://github.com/54895y/MatrixLib[/url]
32+
[*]GitHub Releases:[url]https://github.com/54895y/MatrixLib/releases[/url]
33+
[*]Issue 地址:[url]https://github.com/54895y/MatrixLib/issues[/url]
34+
[*]Matrix 插件总文档入口:[url]https://54895y.github.io/docs/plugins[/url]
35+
[/list]
36+
37+
[b]Skills 使用方法[/b]
38+
39+
如果你希望使用 AI 直接生成 Matrix 系列的共享货币配置、跨插件联动配置或 Kether 脚本,可以使用公开的 MatrixAgentSkills:
40+
41+
[list]
42+
[*]Matrix Series Config 文档:[url]https://54895y.github.io/docs/matrix-agent-skills/matrix-series-config[/url]
43+
[*]Codex / OpenAI Skills:
44+
[url]https://github.com/54895y/MatrixAgentSkills/tree/main/matrix-series-config[/url]
45+
[*]Claude / Gemini / Cline / Roo / Continue 通用 Prompt:
46+
[url]https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/portable/matrix-series-config.md[/url]
47+
[*]AIChat 知识库入口:
48+
[url]https://raw.githubusercontent.com/54895y/MatrixAgentSkills/main/aichat/matrix-series-config-kb.md[/url]
49+
[/list]
50+
51+
推荐使用方式:
52+
53+
[list=1]
54+
[*]把对应的 Skill 或 Prompt 链接发给你的 AI Agent
55+
[*]告诉它你要生成 MatrixLib 的共享货币文件,或同时联动 MatrixShop / MatrixStorage
56+
[*]例如直接让 Agent 生成 plugins/MatrixLib/Economy/currency.yml,并同步规划 MatrixShop 与 MatrixStorage 的货币 key 引用
57+
[/list]
58+
59+
[b]更新日志[/b]
60+
61+
当前源码主线版本重点如下:
62+
63+
[list]
64+
[*]当前发布版本已升级到 1.3.0
65+
[*]共享 economy API 已正式收敛到 MatrixLib
66+
[*]新增共享 MatrixBStats API,统一承接 Matrix 系列插件的 bStats 遥测注册
67+
[*]plugins/MatrixLib/Economy/currency.yml 成为 Matrix 系列货币定义主入口
68+
[*]运行时会同步货币文件到 MatrixShop 与 MatrixStorage
69+
[*]共享 runtime text / console 能力已经稳定承载下游插件
70+
[*]共享 YAML bundle factory、item hooks、JDBC datasource factory 已落地
71+
[*]已提供共享 Bukkit 平台辅助能力,包括插件查找与反射命令注册
72+
[*]下游 MatrixAuth / MatrixCook / MatrixShop / MatrixStorage 已切到共享遥测 API
73+
[*]本地开发记录显示 MatrixLib 与全部下游 bash ./gradlew build 已通过
74+
[/list]
75+
76+
[b]bStats 图表[/b]
77+
78+
[list]
79+
[*]Plugin ID:30557
80+
[*]configured_currency_count:当前已配置货币数量
81+
[*]currency_modes:货币模式分布
82+
[*]currency_setup:单货币 / 多货币部署类型
83+
[/list]
84+
85+
[b]预留图表位[/b]
86+
87+
[list]
88+
[*]downstream_plugin_count
89+
[*]resource_sync_targets
90+
[*]compat_bridge_modes
91+
[/list]
92+
93+
[b]GitHub Issue 提交问题[/b]
94+
95+
[list]
96+
[*]项目地址:[url]https://github.com/54895y/MatrixLib[/url]
97+
[*]Issue 地址:[url]https://github.com/54895y/MatrixLib/issues[/url]
98+
[/list]
99+
100+
如果你在使用过程中遇到以下问题,欢迎直接提交 Issue:
101+
102+
[list]
103+
[*]前置加载失败
104+
[*]共享货币模块异常
105+
[*]下游插件兼容问题
106+
[*]菜单 / 文本 / YAML API 行为异常
107+
[*]Folia / Bukkit 兼容层问题
108+
[*]新功能建议
109+
[/list]
110+
111+
提交 Issue 时建议附带以下信息:
112+
113+
[list]
114+
[*]服务端核心与版本
115+
[*]MatrixLib 版本
116+
[*]相关下游插件版本,例如 MatrixShop / MatrixStorage
117+
[*]控制台报错日志
118+
[*]相关配置文件片段
119+
[*]复现步骤
120+
[/list]
121+
122+
[hr]
123+
[right][size=2][color=red]VibeCoding 声明:本插件在开发过程中使用了 AI / Vibe Coding 作为辅助工具,但实际功能收敛、接口边界、兼容性验证与发布内容仍以仓库代码、文档和实机测试结果为准;如发现问题,请优先通过 GitHub Issues 提交反馈。[/color][/size][/right]

0 commit comments

Comments
 (0)