Skip to content

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
@NekoRabi
NekoRabi committed May 30, 2022
1 parent 5c9328c commit c6e4c6a
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 19 deletions.
16 changes: 11 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Majsoul-QQBot
一个基于YiriMirai的QQ机器人，主要有雀魂和天凤的相关功能(如查询、十连、监控等等)，还有一些娱乐性的功能，比如入群欢迎，制作/发送图片，随机复读等等

[指令帮助](./docs/command_help.md)
# [指令帮助](./docs/command_help.md)

# 效果展示

Expand Down Expand Up @@ -108,9 +108,9 @@ master: 0 # 机器人主人
searchfrequency: 6 # 查询频率，建议为 6
replyimgpath : fox # 表情包路径
replyimgpath : fox # 表情包选择,请将表情包方放在文件夹'data/reply/img/'下以
loglevel: INFO # 日志等级
loglevel: INFO # 日志等级,功能暂时关闭
# "戳一戳"配置文件
nudgeconfig:
Expand Down Expand Up @@ -148,6 +148,7 @@ settings: # 功能开关
norepeat: false # 全局自动回复
help: true # 是否显示帮助
voice: false # 语音功能
saveflashimg: false # 保存闪照
repeatconfig: # 回复、打断相关，要求值从上到下排序为从大到小，值为 百分数
repeatQ: 20 # 复读问号 的概率
Expand Down Expand Up @@ -188,6 +189,7 @@ voicesetting:
# 即 设置private 为 true，则只有你可以让机器人说话
secretId: ''
secretKey: ''
codec: 'mp3' # 音频格式,为 'mp3'或'wav'
Expand Down Expand Up @@ -276,16 +278,18 @@ up: # up的物品池，如果十连参数为 限时，up列表的装扮和人物
- 入群欢迎
- 摸头、互亲、举牌、色图、占卜等图片相关功能
- 强交互性，提供自定义回复、图片回复和语音回复
- 支持自定义指令，可以自定义自己喜欢的触发方式
- 以后会有更多……

# 存在的问题
1. config.yml编辑后乱码。 ~~（基本候是将 UTF-8 编码保存为 GBK 或者反过来）~~
解决办法: 将config.yml重新编码 ( 现已全部都使用 utf-8 编码 )
2. ~~网络请求超时(网络不好)~~
3. 天凤关注订阅时，新加入的玩家 ( 并且未在数据库注册过 ) 如果在短时间内 ( 2小时 ) 狂打,会出现输出多个播报对局的情况

# 开发计划

[ ] 数据库重新设计 (进行中)
[ ] 数据库重新设计 ( 快完成了!! )

[ ] 增加何切支持

Expand All @@ -296,7 +300,9 @@ up: # up的物品池，如果十连参数为 限时，up列表的装扮和人物
[ ] 做一份完整的说明书

# 其他
语音模块是使用的腾讯云的api，是收费的，默认关闭，有想法可以打开玩玩，一天约 0.02 或 0.03 元 [地址](https://cloud.tencent.com/document/product/1073/37995)
语音模块是使用的腾讯云的api，是收费的，默认关闭，有想法可以打开玩玩，约 0.02 或 0.03 元

[腾讯云语音模块地址](https://cloud.tencent.com/document/product/1073/37995)

# 联系方式
QQ:1215791340 验证消息： 可爱的拉克丝
Expand Down
49 changes: 35 additions & 14 deletions docs/command_help.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
**群聊环境下，同一个群同一个人同一条指令有10秒cd，以期望解决多个机器人相互嵌套的问题**

# 指令面板
***因为指令是可以自定义的，因此这里以我自己定义的指令来说明***

**参数介绍: 小括号内的`()`为可选参数，方括号`[]`内的是必选参数，花括号`{}`内的是可用的参数,尖括号`<>`内的是参数类型**

### [自定义指令文档](./reg-command_help.md)

---

# 呼出指令面板
```
help / 帮助
```
Expand All @@ -23,7 +31,7 @@ addadmin qq号
deladmin qq号
```
分别是 添加机器人管理员 和 删除机器人管理员 **`仅有机器人主人有该权限`**
分别是 添加机器人管理员 和 删除机器人管理员 **<font color="blue">仅有机器人主人有该权限</font>**

```
getinfo
Expand All @@ -35,8 +43,9 @@ getinfo
```
log (level) (num)
```
获取最近 `num` 条的等级为 `level` 的日志 (未完成，想到再去完善)
<hr>
获取最近 `num` 条的等级为 `level` 的日志 (未完成，以后再去完善)

---

## 系统命令(管理员权限)

Expand Down Expand Up @@ -66,11 +75,15 @@ norepeat on/true/任意
```
参数为 `on` 或 `true` 时，禁用机器人的复读功能，其他参数为启用复读


----
----

# 群聊命令

## 雀魂相关

**雀魂相关的指令基本都以“ 雀魂”开头，基本格式为 `雀魂xx [参数]`，其中小括号内的`()`为可选参数，方括号`[]`内的是必选参数，花括号`{}`内的是给定参数**
**雀魂相关的指令基本都以“ 雀魂”开头，基本格式为 `雀魂xx [参数]`**

### **最重要的指令 `qhpt`**

Expand Down Expand Up @@ -108,14 +121,16 @@ qhpt 豆本豆豆 4 0
index 是从 `0` 开始的，即 `第一个用户的 index 是 0`

<br>
<hr>

---

<br>

```
qhsl/雀魂十连 ({限时/常驻})
```

来一次模拟雀魂十连，可以在 MajSoulInfo的 [drawcards.yml](./plugin/MajSoulInfo/drawcards.yml) 中配置哪些装扮或者角色进行up
来一次模拟雀魂十连，可以在 MajSoulInfo的 [drawcards.yml](../plugin/MajSoulInfo/drawcards.yml) 中配置哪些装扮或者角色进行up

***我并不清楚雀魂抽卡机制到底是怎么样的，我只是根据它公布的规则的来设计了这个抽卡。其中有出卡概率，十连保底给一个紫礼物，存在绿礼物***

Expand Down Expand Up @@ -160,7 +175,7 @@ qhyb / 雀魂月报 [玩家名] ({3/4}) ([YYYY-m])


```
disable/enable qhpt/qhsl/qhyb ......
disable/enable majsoul qhpt/qhsl/qhyb ......
```
禁用 / 启用 该群指令 `qhpt/qhsl/qhyb` 等等指令的使用

Expand All @@ -170,7 +185,7 @@ freshqh

刷新雀魂牌谱信息

<hr>
---

## 天凤相关

Expand All @@ -194,19 +209,19 @@ thgetwatch
```
获取本群天凤关注

<hr>
----

## 系统命令

```
```markdown
silence on/true
```
开启该群的沉默模式，尽可能减少信息输出

其他参数时为关闭改群沉默模式


```
```markdown
norepeat on/true/任意
```
禁用该群的复读相关功能，尽可能减少信息输出
Expand All @@ -217,11 +232,17 @@ norepeat on/true/任意

## 其他命令

```
```markdown
说: [文本]
```
让机器人将文本读出来

```markdown
在[群号]说:[文本]
```

私聊bot，向群聊发送语音

```
举牌 [内容]
```
Expand Down Expand Up @@ -304,4 +325,4 @@ close|disable|关闭 涩图 / 色图 / setu

简单来说 `来张拉克丝色图`

**色图功能默认关闭**
**<font color='red'>色图功能默认关闭</font>**
42 changes: 42 additions & 0 deletions docs/reg-command_help.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 自定义指令的使用

*要进行指令的自定义, 您必须会熟练使用正则表达式, 并默认您对 yaml 有以一定的了解*

*因为f-string会对花括号进行转义,因此在使用`{}`<font color="red">确定位数</font>的时候需要输入两个花括号,单独使用花括号只需要`\{`*

以添加管理员为例,其指令正则表达式为:`^{commandpre}addadmin\s*(\d+)\s*$`

只能修改`^{commandpre}` 后面的部分，`{commandpre}`为自定义的指令前缀,修改完指令主体会自动拼接指令前缀

请严格保持括号顺序,不要增加，也不要减少，修改顺序和变更数量会导致程序出错

**yaml 与 python 的简单互转**

**注意缩进,冒号后面要有空格 !!**
```markdown
# dict <=> yaml
# python:
dict(name='nekorabi',like='lux',age=20,hobby=['sleep','code'])
# yaml:
name: nekorabi
like: lux
age: 20
hobby:
-'sleep'
-'code'
```

以雀魂模块的雀魂月报为例简单说明

```markdown
majsoul:
qhyb: (qhyb|雀魂月报)\s*([\w_、,\.，@。\'\"!]+)\s*([34])?\s*([0-9]{{4}})?[-]?([0-9]{{1,2}})?\s*$
```

指令触发,进行处理时,会进行匹配
第一个参数为 <font color='green'>触发词</font> ,可以在括号内填入多个触发词,使用 `|` 进行分割,第二个参数为 <font color='blue'>玩家名
</font> ,第三个参数为查询类型,是三麻还是四麻 ( 可不填,默认四麻 ),第四第五个参数分别为年月 ( 时间参数 ),
可不填,默认为当前月份

**<font color="red">因此,保持括号的顺序和数量是很重要的</font>**

0 comments on commit c6e4c6a

Please sign in to comment.