Skip to content

Commit 2381e5a

Browse files
committed
Update MatrixShop release docs
1 parent e665150 commit 2381e5a

File tree

6 files changed

+82
-20
lines changed

6 files changed

+82
-20
lines changed

docs/matrixshop/commands-and-permissions.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ description: MatrixShop 的玩家指令、管理员指令与权限节点。
2222
- `/chestshop`
2323
- `/trade`
2424
- `/market`
25+
- `/cart`
26+
- `/record`
2527

26-
是否注册,取决于模块或具体 `shops/*.yml` `Bindings.Commands.Register`
28+
是否注册,取决于模块级或商店级配置中的 `Bindings.Commands.Register`
2729

2830
## 玩家命令
2931

@@ -44,9 +46,8 @@ description: MatrixShop 的玩家指令、管理员指令与权限节点。
4446
- `auction:<shop-id>`
4547
- `transaction:<shop-id>`
4648
- `menu:<shop-id>`
47-
- `cart:<shop-id>`
48-
- `record:<shop-id>`
49-
- `chestshop:<shop-id>`
49+
- `cart:<view-id>`
50+
- `record:<view-id>`
5051

5152
### 模块命令
5253

@@ -56,7 +57,7 @@ description: MatrixShop 的玩家指令、管理员指令与权限节点。
5657
| PlayerShop | `/playershop open [player]``/playershop edit``/playershop upload <price> [amount]` |
5758
| GlobalMarket | `/market open``/market upload <price> [amount]``/market manage` |
5859
| Auction | `/auction open``/auction upload <english\|dutch> <start> [buyout\|end] [duration]``/auction bid <id> [price]``/auction buyout <id>` |
59-
| ChestShop | `/chestshop create <buy\|sell\|dual> <price> [sell-price] [amount]``/chestshop edit``/chestshop stock``/chestshop history` |
60+
| ChestShop | `/chestshop open``/chestshop create <buy\|sell\|dual> <price> [sell-price] [amount]``/chestshop edit``/chestshop stock``/chestshop history` |
6061
| Transaction | `/trade request <player>``/trade accept``/trade money <amount>``/trade exp <amount>``/trade ready``/trade confirm` |
6162
| Cart | `/cart open``/cart checkout [valid_only]``/cart clear``/cart remove <slot>` |
6263
| Record | `/record open [keyword]``/record detail <id>``/record filter [module\|all]``/record income``/record expense` |

docs/matrixshop/configuration-structure.mdx

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Database:
120120
- `Cart/`
121121
- `Record/`
122122

123-
每个模块目录通常包含
123+
大多数模块目录包含
124124

125125
- `settings.yml`
126126
- `shops/*.yml`
@@ -131,6 +131,12 @@ Database:
131131
- `ChestShop/signs.yml`
132132
- `Record/retention.yml`
133133

134+
并且有三个模块已经不再使用 `shops/*.yml`:
135+
136+
- `ChestShop`
137+
- `Cart`
138+
- `Record`
139+
134140
## `settings.yml` 和 `shops/*.yml` 的分工
135141

136142
### `settings.yml`
@@ -157,8 +163,23 @@ Database:
157163
例如:
158164

159165
- `PlayerShop/shops/default.yml` -> `default`
160-
- `Cart/shops/cart.yml` -> `cart`
161-
- `Record/shops/record.yml` -> `record`
166+
- `GlobalMarket/shops/default.yml` -> `default`
167+
- `Auction/shops/default.yml` -> `default`
168+
- `Transaction/shops/default.yml` -> `default`
169+
170+
### 不使用 `shops/*.yml` 的模块
171+
172+
这三个模块当前采用“模块级入口 + UI 文件”的结构:
173+
174+
- `ChestShop`
175+
- `Cart`
176+
- `Record`
177+
178+
它们的入口命令、帮助文本和行为控制主要来自:
179+
180+
- `settings.yml`
181+
- `ui/*.yml`
182+
- 以及模块自身的运行时上下文
162183

163184
## 从哪里继续读
164185

docs/matrixshop/faq.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ currency: 'vault'
2424
- `auction`
2525
- `transaction`
2626

27+
以下模块当前不依赖 `shops/*.yml` 作为主入口:
28+
29+
- `chestshop`
30+
- `cart`
31+
- `record`
32+
2733
## `/ms open <id>` 打不开或提示歧义怎么办
2834

2935
如果多个模块里出现了同名 `shopId`,就不要再用短写法,直接改成显式前缀:
@@ -60,6 +66,15 @@ currency: 'vault'
6066
- `Bindings.Commands.Register`
6167
- 独立命令关键字本身
6268

69+
## 为什么 `/cart`、`/record` 能直接使用,但不需要 `shops/*.yml`
70+
71+
因为这两个模块当前已经改成“模块级入口 + UI 文件”模型:
72+
73+
- `Cart/settings.yml` + `Cart/ui/*.yml`
74+
- `Record/settings.yml` + `Record/ui/*.yml`
75+
76+
它们仍然支持独立命令和帮助输出,但不再通过 `shops/*.yml` 划分主入口。
77+
6378
## SystemShop 为什么没有数据库表
6479

6580
因为当前 SystemShop 是纯配置驱动模块,不依赖 JDBC 运行表。真正大量落表的是拍卖、市场、玩家商店、购物车、箱店和记录系统。

docs/matrixshop/index.mdx

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@ description: MatrixShop 当前模块化实现的总览与阅读入口。
66

77
# MatrixShop 文档
88

9-
MatrixShop 是一个模块化交易插件。当前代码已经围绕统一命令、统一菜单框架、统一权限校验和 JDBC 优先的数据层完成了第一批核心模块。
9+
MatrixShop 是面向生存、经济和市场场景的模块化交易插件。当前主线版本已经具备正式部署所需的核心模块、统一命令体系、统一菜单框架、统一权限校验和 JDBC 优先的数据层。
10+
11+
## 当前版本状态
12+
13+
- 已完成首发所需的核心业务链
14+
- 默认文案、帮助输出和主要模块反馈已统一进语言系统
15+
- 支持 SQLite / MySQL,JDBC 不可用时自动回退到文件后端
16+
- 默认文档以 `main` 分支和当前默认资源文件为准
1017

1118
## 当前实现的模块
1219

@@ -34,7 +41,7 @@ MatrixShop 是一个模块化交易插件。当前代码已经围绕统一命令
3441
- 真实目录结构与文件职责
3542
- 命令绑定、独立命令与 `shopId` 解析规则
3643
- SQLite / MySQL / 文件回退行为
37-
- 各交易模块的当前能力边界
44+
- 各模块当前能力和配置边界
3845
- 每个模块默认配置的完整示例与字段解读
3946
- UI 配置和动作语法
4047

@@ -48,3 +55,11 @@ MatrixShop 是一个模块化交易插件。当前代码已经围绕统一命令
4855
4. [数据库与存储](./database-and-storage)
4956
5. [模块总览](./modules-overview)
5057
6. [商店与模块详解](./shop-types)
58+
59+
## 发布前建议
60+
61+
如果你准备直接部署到正式服务器,建议至少先完成这三项检查:
62+
63+
1. 先执行一次 `/matrixshopadmin status`
64+
2. 确认 `database.yml``module.yml` 和主要模块 `settings.yml` 已按你的服设完成调整
65+
3. 逐个验证你实际会开放给玩家的入口命令和菜单绑定

docs/matrixshop/modules-overview.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ description: MatrixShop 各模块职责、默认文件和详细文档入口。
1616
| `player-shop` | 玩家个人商店 | `PlayerShop/settings.yml``PlayerShop/shops/default.yml` | [PlayerShop](./shop-types/player-shop) |
1717
| `global-market` | 全服共享市场 | `GlobalMarket/settings.yml``GlobalMarket/shops/default.yml` | [GlobalMarket](./shop-types/global-market) |
1818
| `auction` | 拍卖行 | `Auction/settings.yml``Auction/shops/default.yml` | [Auction](./shop-types/auction) |
19-
| `chestshop` | 箱子商店 | `ChestShop/settings.yml``ChestShop/shops/default.yml` | [ChestShop](./shop-types/chest-shop) |
19+
| `chestshop` | 箱子商店 | `ChestShop/settings.yml``ChestShop/signs.yml``ChestShop/ui/*.yml` | [ChestShop](./shop-types/chest-shop) |
2020
| `transaction` | 面对面交易 | `Transaction/settings.yml``Transaction/shops/default.yml` | [Transaction](./shop-types/transaction) |
21-
| `cart` | 购物车 | `Cart/settings.yml``Cart/shops/cart.yml` | [Cart](./shop-types/cart) |
22-
| `record` | 账本记录 | `Record/settings.yml``Record/shops/record.yml` | [Record](./shop-types/record) |
21+
| `cart` | 购物车 | `Cart/settings.yml``Cart/ui/*.yml` | [Cart](./shop-types/cart) |
22+
| `record` | 账本记录 | `Record/settings.yml``Record/retention.yml``Record/ui/*.yml` | [Record](./shop-types/record) |
2323

2424
## 应该先读哪些页
2525

@@ -36,15 +36,15 @@ description: MatrixShop 各模块职责、默认文件和详细文档入口。
3636
先看:
3737

3838
1. 对应模块的 `settings.yml` 是否启用、是否有权限条件。
39-
2. 对应 `shops/*.yml` 的文件名是否和你打开的 `shopId` 一致。
39+
2. 如果该模块使用 `shops/*.yml`,确认文件名是否和你打开的 `shopId` 一致。
4040
3. 模块页里记录的默认命令别名和 UI 文件是否匹配。
4141

4242
### 如果你在做中文化或重做界面
4343

4444
先看:
4545

4646
1. [绑定与 UI](./bindings-and-ui)
47-
2. 对应模块页中的 `shops/*.yml`
47+
2. 对应模块页中的 `shops/*.yml``ui/*.yml`
4848
3. 对应模块的 `ui/*.yml`
4949

5050
## 当前模块边界
@@ -55,6 +55,6 @@ description: MatrixShop 各模块职责、默认文件和详细文档入口。
5555
- `PlayerShop``GlobalMarket``Auction` 主要是运行时上架数据。
5656
- `ChestShop` 有箱子、库存、告示牌这套线下交互。
5757
- `Transaction` 不是商品市场,而是面对面交换。
58-
- `Cart``Record` 是辅助模块,不是独立销售市场。
58+
- `Cart``Record` 是辅助模块,不是独立销售市场,也不再使用 `shops/*.yml` 作为主入口
5959

6060
如果你准备直接改字段,请进入 [商店与模块详解](./shop-types) 下的具体模块页。

docs/matrixshop/quick-start.mdx

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,19 @@ plugins/MatrixShop/
3333
└─ Record/
3434
```
3535

36-
每个模块目录下至少会有
36+
大多数模块目录下会包含
3737

3838
- `settings.yml`
3939
- `shops/*.yml`
4040
- `ui/*.yml`
4141

42-
`shops/*.yml` 的文件名就是当前实现里的 `shopId`
42+
但有三个例外:
43+
44+
- `ChestShop/`:不再使用 `shops/*.yml`,只保留 `settings.yml``signs.yml``ui/*.yml`
45+
- `Cart/`:不再使用 `shops/*.yml`,只保留 `settings.yml``ui/*.yml`
46+
- `Record/`:不再使用 `shops/*.yml`,只保留 `settings.yml``retention.yml``ui/*.yml`
47+
48+
对于仍然使用 `shops/*.yml` 的模块,文件名就是当前实现里的 `shopId`
4349

4450
## 3. 先做的三项检查
4551

@@ -71,7 +77,7 @@ modules:
7177

7278
### 检查绑定命令
7379

74-
模块命令不是写死的。它们会从各模块 `settings.yml` 和 `shops/*.yml` 里的 `Bindings.Commands` 读取。
80+
模块命令不是全部写死的。它们会从各模块 `settings.yml` 和 `shops/*.yml` 里的 `Bindings.Commands` 读取。
7581

7682
例如默认情况下:
7783

@@ -80,6 +86,8 @@ modules:
8086
- `/chestshop`
8187
- `/trade`
8288
- `/market`
89+
- `/cart`
90+
- `/record`
8391

8492
都可能在启动时注册成独立命令。
8593

@@ -95,6 +103,8 @@ modules:
95103
/ms open systemshop:weapon
96104
/auction open
97105
/market open
106+
/cart help
107+
/record help
98108
```
99109

100-
如果你能正常打开系统商店、拍卖行和市场页面,说明基础配置已经生效。
110+
如果你能正常打开系统商店、拍卖、市场、购物车和记录页面,说明基础配置已经生效。

0 commit comments

Comments
 (0)