Skip to content

Commit 3228bf2

Browse files
committed
docs: 添加 DicePP 机器人功能列表文档
1 parent da4745f commit 3228bf2

File tree

2 files changed

+255
-0
lines changed

2 files changed

+255
-0
lines changed

src/plugins/DicePP/docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
## 文档目录
66

7+
- [功能列表](./feature_list.md) - 机器人所有功能汇总
78
- [架构总览](./architecture.md) - 项目整体架构介绍
89
- [命令模式](./command_pattern.md) - 命令系统的设计与实现
910
- [命令示例:以掷骰为例](./example_roll.md) - 以 `.r` 掷骰命令为例详解
Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
# DicePP 机器人功能列表
2+
3+
本文档列出 DicePP 机器人的所有功能。
4+
5+
---
6+
7+
## 目录
8+
9+
1. [骰子系统](#1-骰子系统)
10+
2. [角色卡系统](#2-角色卡系统)
11+
3. [跑团日志](#3-跑团日志)
12+
4. [先攻系统](#4-先攻系统)
13+
5. [卡牌与随机生成](#5-卡牌与随机生成)
14+
6. [数据查询](#6-数据查询)
15+
7. [群管理功能](#7-群管理功能)
16+
8. [通用工具](#8-通用工具)
17+
9. [Master 指令](#9-master-指令)
18+
10. [外部 API](#10-外部-api)
19+
11. [多机器人互联](#11-多机器人互联)
20+
21+
---
22+
23+
## 1. 骰子系统
24+
25+
| 功能 | 命令 | 说明 |
26+
|------|------|------|
27+
| 基础掷骰 | `.r` / `.roll` | 支持多种骰子表达式,如 `3d6+5``4d6k3`|
28+
| 随机选择 | `.choose` / `.pick` | 从选项中随机选择,如 `.choose A B C` |
29+
| 骰池 | `.pool` | 骰池投掷,用于 DND 5E 等规则 |
30+
| 默认骰设置 | `.set` | 设置默认骰子面数 |
31+
| 业力骰子 | `.karma` | Karma 系统,记录玩家运气值 |
32+
33+
### 骰子表达式支持
34+
35+
- 基础骰子:`d4`, `d6`, `d8`, `d10`, `d12`, `d20`, `d100`
36+
- 掷骰数量:`3d6` 表示掷 3 个 6 面骰
37+
- 加减修正:`+5`, `-2`
38+
- 优势/劣势:`2d20kh1` (优势), `2d20kl1` (劣势)
39+
- 掷骰原因:`3d6+5 力量检定`
40+
41+
---
42+
43+
## 2. 角色卡系统
44+
45+
### DND 5E 角色卡
46+
47+
| 功能 | 命令 | 说明 |
48+
|------|------|------|
49+
| 创建角色卡 | `.角色卡` | 创建新的 DND 5E 角色卡 |
50+
| 属性检定 | `.力量` / `.敏捷`| 进行属性检定 |
51+
| 技能检定 | `.攀爬` / `.游泳`| 进行技能检定 |
52+
| 豁免检定 | `.力量豁免`| 进行豁免检定 |
53+
| 攻击检定 | `.攻击` / `.攻击优势` | 进行攻击检定 |
54+
| 生命骰 | `.生命骰` / `.1#生命骰` | 使用生命骰恢复生命值 |
55+
| 长休 | `.长休` | 长时间休息,恢复所有生命值和生命骰 |
56+
| 生命值管理 | `.hp` | 查看/调整生命值 |
57+
58+
### COC 角色卡
59+
60+
| 功能 | 命令 | 说明 |
61+
|------|------|------|
62+
| 生命值管理 | `.hp` | COC 角色的生命值管理 |
63+
64+
### 属性生成
65+
66+
| 功能 | 命令 | 说明 |
67+
|------|------|------|
68+
| COC 属性生成 | `.coc` | 生成 7 个 COC 属性 (4D6K3) |
69+
| DND 属性生成 | `.dnd` | 生成 6 个 DND 属性 (4D6K3) |
70+
71+
---
72+
73+
## 3. 跑团日志
74+
75+
| 功能 | 命令 | 说明 |
76+
|------|------|------|
77+
| 创建日志 | `.log create` | 创建新的跑团日志 |
78+
| 记录片段 | `.log add` | 向日志中添加片段 |
79+
| 导出日志 | `.log export` | 导出日志为文件 |
80+
| 查看日志 | `.log view` | 查看日志内容 |
81+
| 删除日志 | `.log delete` | 删除日志 |
82+
| 日志统计 | `.log stat` | 统计日志信息 |
83+
84+
---
85+
86+
## 4. 先攻系统
87+
88+
| 功能 | 命令 | 说明 |
89+
|------|------|------|
90+
| 先攻列表 | `.先攻` | 显示当前战斗轮先攻列表 |
91+
| 添加角色 | `.先攻 add 角色名` | 添加角色到先攻列表 |
92+
| 移除角色 | `.先攻 del 角色名` | 从先攻列表移除 |
93+
| 下一轮 | `.先攻 next` | 进入下一战斗轮 |
94+
| 战斗轮 | `.战斗轮` | 快速进行一轮战斗 |
95+
96+
---
97+
98+
## 5. 卡牌与随机生成
99+
100+
### 抽卡系统
101+
102+
| 功能 | 命令 | 说明 |
103+
|------|------|------|
104+
| 抽卡 | `.draw` / `.抽卡` | 从卡组中抽取卡牌 |
105+
| 卡组管理 | `.deck` | 管理自定义卡组 |
106+
107+
### 随机生成器
108+
109+
| 功能 | 命令 | 说明 |
110+
|------|------|------|
111+
| 随机生成 | `.gen` | 随机生成各种内容 |
112+
| NPC 生成 | `.gen npc` | 生成随机 NPC |
113+
| 物品生成 | `.gen item` | 生成随机物品 |
114+
115+
---
116+
117+
## 6. 数据查询
118+
119+
| 功能 | 命令 | 说明 |
120+
|------|------|------|
121+
| 资料查询 | `.查询` / `.q` | 根据关键字查找资料 |
122+
| 全文搜索 | `.搜索` / `.s` | 全文搜索资料库 |
123+
| 私设资料 | `.私设` / `.hb` | 管理自定义资料 (需权限) |
124+
125+
### 内置数据库
126+
127+
- DND 5E 怪物图鉴
128+
- DND 5E 法术列表
129+
- COC 怪物图鉴
130+
- 其他 TRPG 资料
131+
132+
---
133+
134+
## 7. 群管理功能
135+
136+
| 功能 | 命令 | 说明 |
137+
|------|------|------|
138+
| 群配置 | `.config` / `.c` | 查看/修改群设置 |
139+
| 模式切换 | `.mode` | 切换群预设模式 (dnd/coc/ygo 等) |
140+
| 欢迎词 | `.welcome` | 设置入群欢迎词 |
141+
| 激活状态 | `.on` / `.off` | 开启/关闭机器人响应 |
142+
| 自定义对话 | `.chat` | 设置自动回复对话 |
143+
144+
---
145+
146+
## 8. 通用工具
147+
148+
| 功能 | 命令 | 说明 |
149+
|------|------|------|
150+
| 今日人品 | `.jrrp` | 每日随机人品值 |
151+
| 宏定义 | `.define` / `.def` | 定义自定义宏 |
152+
| 变量 | `.set` / `.get` | 用户自定义变量 |
153+
| 昵称 | `.nn` | 设置用户昵称 |
154+
| 好感度 | `.好感` | 记录角色好感度 |
155+
| 点数 | `.point` | 记录和分配点数 |
156+
| 帮助 | `.help` / `.帮助` | 查看帮助信息 |
157+
| 统计 | `.统计` | 查看个人/群聊使用统计 |
158+
159+
---
160+
161+
## 9. Master 指令
162+
163+
| 功能 | 命令 | 说明 |
164+
|------|------|------|
165+
| 发送消息 | `.master send` | 向指定用户/群发送消息 |
166+
| 重启 | `.master reboot` | 重启机器人 |
167+
| 静默模式 | `.master silent` | 开启/关闭静默模式 |
168+
| 清理日志 | `.master log clean` | 清理日志文件 |
169+
| 管理员 | `.admin` | 管理员相关功能 |
170+
171+
---
172+
173+
## 10. 外部 API
174+
175+
机器人提供 FastAPI 接口供外部调用:
176+
177+
- `/api/roll` - 掷骰接口
178+
- `/api/query` - 查询接口
179+
- `/api/character` - 角色卡接口
180+
181+
详见 [FastAPI 模块](./fastapi.md)
182+
183+
---
184+
185+
## 11. 多机器人互联
186+
187+
| 功能 | 命令 | 说明 |
188+
|------|------|------|
189+
| Hub 连接 | `.hub` | 连接多个 DicePP 机器人 |
190+
| 跨机器人掷骰 | - | 支持互相转发掷骰请求 |
191+
192+
---
193+
194+
## 指令一览表
195+
196+
```
197+
.r/.roll - 掷骰
198+
.choose/.pick - 随机选择
199+
.pool - 骰池
200+
.set - 默认骰设置
201+
.karma - 业力骰子
202+
203+
.角色卡 - DND5E 角色卡
204+
.hp - 生命值管理
205+
.coc - COC 属性生成
206+
.dnd - DND 属性生成
207+
208+
.log - 跑团日志
209+
210+
.先攻 - 先攻列表
211+
.战斗轮 - 战斗轮
212+
213+
.draw/.抽卡 - 抽卡
214+
.deck - 卡组管理
215+
.gen - 随机生成
216+
217+
.q/.查询 - 资料查询
218+
.s/.搜索 - 全文搜索
219+
.私设/.hb - 私设资料
220+
221+
.config/.c - 群配置
222+
.mode - 模式切换
223+
.welcome - 欢迎词
224+
.on/.off - 激活状态
225+
226+
.jrrp - 今日人品
227+
.define/.def - 宏定义
228+
.set/.get - 变量
229+
.nn - 昵称
230+
.好感 - 好感度
231+
.point - 点数
232+
.help - 帮助
233+
.统计 - 统计信息
234+
```
235+
236+
---
237+
238+
## 附录
239+
240+
### 数据存储
241+
242+
机器人使用 JSON 格式存储以下数据:
243+
244+
- 用户数据 (`DC_USER_DATA`)
245+
- 群组数据 (`DC_GROUP_DATA`)
246+
- 昵称 (`DC_NICKNAME`)
247+
- 宏定义 (`DC_MACRO`)
248+
- 变量 (`DC_VARIABLE`)
249+
- 角色卡 (`DC_CHAR_DND`)
250+
- 生命值 (`DC_CHAR_HP`)
251+
252+
### 国际化
253+
254+
支持多语言文本,可通过 `LocalizationManager` 管理。

0 commit comments

Comments
 (0)