Skip to content

Commit 5be1056

Browse files
committed
Document module-level economy configs
1 parent e9f08b1 commit 5be1056

File tree

3 files changed

+44
-99
lines changed

3 files changed

+44
-99
lines changed

docs/matrixshop/shop-types/auction.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Auction 模块的默认配置、入口页和核心拍卖参数解
55

66
# Auction
77

8-
`Auction` 是 MatrixShop 里配置最复杂的模块之一。它不仅决定拍卖入口长什么样,还控制英式拍卖、荷式拍卖、押金、税率、抢拍保护和记录写入
8+
`Auction` 是 MatrixShop 里配置最复杂的模块之一。它不仅决定拍卖入口长什么样,还控制英式拍卖、荷式拍卖、押金、税率、抢拍保护、记录写入,以及拍卖使用的货币来源
99

1010
## 默认文件
1111

@@ -34,6 +34,8 @@ Bindings:
3434
Condition: 'perm matrixshop.auction.use'
3535

3636
Options:
37+
Currency:
38+
Key: vault
3739
Listing:
3840
Max-Active: 20
3941
Duration:
@@ -89,6 +91,7 @@ Options:
8991
| `Register` | 这里直接是 `true`,所以会注册独立拍卖命令。 |
9092
| `Priority` | 由于 `ah` 很容易和别的插件冲突,这个优先级非常重要。 |
9193
| `Condition` | 默认权限节点。 |
94+
| `Options.Currency.Key` | 模块级默认货币 key。 |
9295

9396
### `Options.Listing`
9497

@@ -151,6 +154,9 @@ Bindings:
151154
Show-In-Help: true
152155
Priority: 100
153156
157+
Currency:
158+
Key: vault
159+
154160
Title:
155161
- '&8Auction Hall &7{page}/{max-page}'
156162
@@ -212,6 +218,14 @@ icons:
212218
| `icons.P/N` | 翻页。 |
213219
| `icons.R` | 关闭页面。 |
214220

221+
## 当前货币优先级
222+
223+
`Auction` 当前采用:
224+
225+
1. `Auction/shops/*.yml -> Currency.Key`
226+
2. `Auction/settings.yml -> Options.Currency.Key`
227+
3. 默认回退 `vault`
228+
215229
## 使用建议
216230

217231
- 想限制玩家同时挂拍数量:改 `Options.Listing.Max-Active`。

docs/matrixshop/shop-types/chest-shop.mdx

Lines changed: 13 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ description: ChestShop 的入口、GUI、告示牌与库存相关配置说明。
77

88
`ChestShop` 是箱子商店模块。它和前面的菜单型商店不同,既有 GUI,也有箱子、告示牌、库存和数量档位这些线下交互逻辑。
99

10+
当前版本中,`ChestShop` 不使用 `shops/*.yml` 作为入口层,货币也只支持模块级配置。
11+
1012
## 默认文件
1113

1214
- `ChestShop/settings.yml`
13-
- `ChestShop/shops/default.yml`
1415
- `ChestShop/signs.yml`
1516
- `ChestShop/ui/create.yml`
1617
- `ChestShop/ui/edit.yml`
@@ -40,6 +41,8 @@ Entry:
4041
Direct-Trade-On: []
4142
Stock:
4243
Double-Chest-Mode: expand_only
44+
Currency:
45+
Key: vault
4346
```
4447
4548
字段解释:
@@ -54,102 +57,7 @@ Stock:
5457
| `Entry.Open-GUI-On` | 哪些交互动作会直接打开 GUI。 |
5558
| `Entry.Direct-Trade-On` | 哪些交互动作会走直接交易。默认是空列表。 |
5659
| `Stock.Double-Chest-Mode` | 双箱库存处理方式,示例是 `expand_only`。 |
57-
58-
## `ChestShop/shops/default.yml`
59-
60-
```yaml
61-
Bindings:
62-
Commands:
63-
Bindings:
64-
- 'chestshop'
65-
- 'cshop'
66-
Register: true
67-
Show-In-Help: true
68-
Priority: 100
69-
70-
Title:
71-
- '&8ChestShop &7{shop-id}'
72-
73-
layout:
74-
- '#########'
75-
- '#11i22S##'
76-
- '#33###B##'
77-
- '##I#H#M##'
78-
- '#########'
79-
- '####R####'
80-
81-
icons:
82-
'#':
83-
material: 'STAINED_GLASS_PANE'
84-
name: ' '
85-
'1':
86-
material: 'WOOD_BUTTON'
87-
name: '&f1x'
88-
lore:
89-
- '&7Preview one trade bundle'
90-
'2':
91-
material: 'STONE_BUTTON'
92-
name: '&f8x'
93-
lore:
94-
- '&7Preview eight trade bundles'
95-
'3':
96-
material: 'STONE_BUTTON'
97-
name: '&f64x'
98-
lore:
99-
- '&7Preview sixty-four trade bundles'
100-
'i':
101-
material: 'AIR'
102-
mode: 'preview'
103-
'S':
104-
material: 'HOPPER'
105-
name: '&aSell To Shop'
106-
lore:
107-
- '&7Mode: &f{mode}'
108-
- '&7Amount: &f{total-amount}'
109-
- '&7Value: &e{total-buy-price}'
110-
'B':
111-
material: 'EMERALD'
112-
name: '&6Buy From Shop'
113-
lore:
114-
- '&7Mode: &f{mode}'
115-
- '&7Amount: &f{total-amount}'
116-
- '&7Cost: &e{total-sell-price}'
117-
'I':
118-
material: 'CHEST'
119-
name: '&fStock'
120-
lore:
121-
- '&7Current stock: &f{stock}'
122-
'H':
123-
material: 'PAPER'
124-
name: '&fHistory'
125-
lore:
126-
- '&7View recent trades'
127-
'M':
128-
material: 'BOOK'
129-
name: '&eManage'
130-
lore:
131-
- '&7Owner only'
132-
'R':
133-
material: 'BARRIER'
134-
name: '&cClose'
135-
actions:
136-
left:
137-
- 'close'
138-
```
139-
140-
### 顶层字段解释
141-
142-
| 字段 | 说明 |
143-
| --- | --- |
144-
| `Title` | 箱子商店标题。 |
145-
| `layout` | `1/2/3` 是数量档位,`i` 是预览区,`S/B` 是卖出和买入,`I/H/M` 是库存、历史、管理。 |
146-
| `icons.i.mode: preview` | 由模块代码渲染交易预览。 |
147-
| `icons.S` | 卖给商店。 |
148-
| `icons.B` | 从商店购买。 |
149-
| `icons.I` | 查看库存。 |
150-
| `icons.H` | 打开交易历史。 |
151-
| `icons.M` | 打开管理页。 |
152-
| `icons.R` | 关闭。 |
60+
| `Currency.Key` | 箱子商店统一使用的货币 key。 |
15361

15462
## `ChestShop/signs.yml`
15563

@@ -183,6 +91,13 @@ Formats:
18391

18492
## 使用建议
18593

186-
- 想改玩家打开箱店后的布局:改 `shops/default.yml`。
94+
- 想改玩家打开箱店后的布局:改 `ui/shop.yml`、`ui/edit.yml`、`ui/create.yml`。
18795
- 想改告示牌显示样式:改 `signs.yml`。
18896
- 想改变“右键箱子”“右键告示牌”的行为:改 `Entry.Open-GUI-On` 和 `Direct-Trade-On`。
97+
98+
## 当前货币优先级
99+
100+
`ChestShop` 当前不走商店级或商品级货币配置,直接使用:
101+
102+
1. `ChestShop/settings.yml -> Currency.Key`
103+
2. 默认回退 `vault`

docs/matrixshop/shop-types/transaction.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: Transaction 面对面交易模块的设置、入口页与交易界
77

88
`Transaction` 是玩家之间的面对面交易模块。它不依赖“商店上架”,而是依赖请求、会话、准备、确认这条流程。
99

10+
当前版本中,金钱报价已经接入统一经济模块。
11+
1012
## 默认文件
1113

1214
- `Transaction/settings.yml`
@@ -29,6 +31,8 @@ Bindings:
2931
Priority: 18
3032
Condition: 'perm matrixshop.transaction.use'
3133
Options:
34+
Currency:
35+
Money-Key: vault
3236
Request:
3337
Timeout-Seconds: 30
3438
Max-Pending: 5
@@ -70,6 +74,7 @@ Options:
7074
| `Trade.Allow-Items` | 是否允许交换物品。 |
7175
| `Trade.Allow-Money` | 是否允许附带金钱。 |
7276
| `Trade.Allow-Exp` | 是否允许附带经验。 |
77+
| `Options.Currency.Money-Key` | 金钱报价默认使用的货币 key。 |
7378
| `Record.Write-On-Complete` | 成交时是否写记录。 |
7479
| `Record.Write-On-Cancel` | 取消时是否写记录。 |
7580

@@ -85,6 +90,9 @@ Bindings:
8590
Show-In-Help: true
8691
Priority: 100
8792
93+
Currency:
94+
Key: vault
95+
8896
Title:
8997
- '&8Trade Hub &7{shop-id}'
9098
@@ -126,6 +134,14 @@ icons:
126134
| `L` | 打开交易记录。 |
127135
| `layout` | 这个页面不是商品列表,而是交易中心的导航页。 |
128136

137+
## 当前货币优先级
138+
139+
`Transaction` 当前采用:
140+
141+
1. `Transaction/shops/*.yml -> Currency.Key`
142+
2. `Transaction/settings.yml -> Options.Currency.Money-Key`
143+
3. 默认回退 `vault`
144+
129145
## `Transaction/ui/trade.yml`
130146

131147
这个文件决定真正交易时的主界面结构:

0 commit comments

Comments
 (0)