Skip to content

GitLab

提交 2ceaf42b 编辑于 作者: yuudi's avatar yuudi
浏览文件

docs: update documents

上级 1254316a
Hide whitespace changes
Inline Side-by-side
documents/.vuepress/config.yml
浏览文件 @ 2ceaf42b
......@@ -23,16 +23,30 @@ themeConfig:
link: /
- text: 安装方法
items:
- text: 概览
link: /install/
- text: 使用酷Q安装
items:
- text: 安装教程
link: /install/cq/
- text: httpapi配置说明
link: /install/config/
link: /install/cq/
- text: 使用mirai安装
link: /install/mirai/
- text: 酷Q
items:
- text: Windows 便携版
link: /install/Windows-quick-start/
- text: Windows 源码部署
link: /install/Windows-source/
- text: Linux 源码部署
link: /install/Linux-source/
- text: Docker
link: /install/docker/
- text: 作为 nonebot 插件部署
link: /install/nonebot-plugin/
- text: mirai
items:
- text: 安装教程
link: /install/mirai/
- text: Linux 部署
link: /install/Linux-cqhttp-mirai/
- text: Windows 部署
link: /install/Windows-cqhttp-mirai/
- text: 使用方法
items:
- text: 功能表
......
documents/README.md
浏览文件 @ 2ceaf42b
......@@ -13,7 +13,7 @@ yobot 提供了群聊、web 页面两套用户交互方式，具有操作便捷
自建方法请参考[安装教程](./install/README.md)
或者加入交流群 {{ [770947581,1044314369,774394459][Math.floor(Math.random()*3)] }}，租用或出租机器人
或者加入交流群 {{ [770947581,1044314369,1067699252,774394459][Math.floor(Math.random()*3)] }}，租用或出租机器人
## 功能介绍
......@@ -32,23 +32,23 @@ yobot 提供了群聊、web 页面两套用户交互方式，具有操作便捷
新版助手提供了一个网页面板，面板上可以进行更多操作
![主面板](https://assets.yobot.win/img/poYvQO.jpg)
![主面板](https://vs.yixuedh.com/assets/img/yobot/poYvQO.jpg)
![数据面板](https://assets.yobot.win/img/HOh17P.jpg)
![数据面板](https://vs.yixuedh.com/assets/img/yobot/HOh17P.jpg)
### 新闻推送
机器人主动发送游戏新闻与活动提醒
![游戏活动提醒](https://assets.yobot.win/img/5bd8d1f5ac68ffde.jpg)
![游戏活动提醒](https://vs.yixuedh.com/assets/img/yobot/5bd8d1f5ac68ffde.jpg)
![数据面板](https://assets.yobot.win/img/HOh17P.jpg)
![数据面板](https://vs.yixuedh.com/assets/img/yobot/HOh17P.jpg)
### 日程查询
机器人主动发送游戏新闻与活动提醒
![游戏活动提醒](https://assets.yobot.win/img/J04GEB.jpg)
![游戏活动提醒](https://vs.yixuedh.com/assets/img/yobot/J04GEB.jpg)
### 模拟抽卡
......@@ -57,7 +57,7 @@ yobot 提供了群聊、web 页面两套用户交互方式，具有操作便捷
还可以自定义修改卡池
（怕打扰可以关闭此功能）
![模拟抽卡](https://assets.yobot.win/img/u4OLHH.png)
![模拟抽卡](https://vs.yixuedh.com/assets/img/yobot/u4OLHH.png)
### 更多功能
......
documents/about.md
浏览文件 @ 2ceaf42b
......@@ -7,11 +7,7 @@ yobot 的编写出于学习目的，很高兴此工具能为大家提供帮助
邮件： <yobot@pcrbot.com>
QQ群：
1群：770947581
2群：1044314369
4群：1067699252
5群：774394459
QQ群：{{ [770947581,1044314369,1067699252,774394459][Math.floor(Math.random()*3)] }}
[项目贡献者](./project/contributors.md)
[更新日志](./project/changelog.md)
......
documents/features/web.md
浏览文件 @ 2ceaf42b
......@@ -35,7 +35,7 @@
| 加入全部成员 | |
| 报刀2000000 \[@某人\] \[昨日\] \[:留言\] | 对boss造成伤害但未击败时用，记录伤害，可以使用 200w/200万/2000k 等，如果有at则为代报，如果有“昨日”则将记录添加到前一天 |
| 尾刀 \[@某人\] \[昨日\] \[:留言\] | 对 boss 造成伤害并击败时用，记录伤害，如果有 at 则为代报，如果有“昨日”则将记录添加到前一天 |
| SL | 挑战 boss 强制取消后用，记录本日 SL，以便在后台汇总查看 |
| SL \[？\] | 挑战 boss 强制取消后用，记录本日 SL，用“？”查询今日是否已 SL |
| 撤销 | 撤销上一次报刀（非管理员只能撤销自己的记录） |
| 状态 | 显示 boss 状态 |
| 预约1 \[:留言\] | 预约 boss，当 boss 出现时通知 |
......
documents/install/Linux-cqhttp-mirai.md
浏览文件 @ 2ceaf42b
......@@ -5,12 +5,14 @@
安装环境
```shell
# redhat / centos:
# RHEL / CentOS:
yum install -y java python3 screen wget git
# debain / ubuntu 请使用 apt-get
# Debain / Ubuntu
# apt-get install -y java python3 screen wget git
```
新建一个 linux 用户
（可选）新建一个 linux 用户
```shell
groupadd qqbot
......@@ -31,11 +33,14 @@ mkdir -p ~/qqbot/yobot
cd ~/qqbot/yobot
# 下载源码
git clone https://github.com/yuudi/yobot.git --depth=1
git clone https://github.com/yuudi/yobot.git
# 国内可改用 https://gitee.com/yobot/yobot.git
cd yobot/src/client/
# 安装依赖
pip3 install -r requirements.txt --user
# 国内可加上参数 -i https://pypi.tuna.tsinghua.edu.cn/simple
# 生成 yobotg
python3 main.py
......@@ -44,33 +49,38 @@ python3 main.py
sh yobotg.sh
```
按下 `ctrl-a c` 连续组合键，新建一个 screen shell
按下 `ctrl-a , c` 连续组合键，新建一个 screen shell
启动 mirai-console
```shell
mkdir -p ~/qqbot/mirai
cd ~/qqbot/mirai
wget https://github.com/mamoe/mirai-console-wrapper/releases/download/1.2.0/mirai-console-wrapper-1.2.0-all.jar
java -jar mirai-console-wrapper-1.2.0-all.jar
# 你可以在这里找到最新版本：https://github.com/mamoe/mirai-console-wrapper/releases
wget https://github.com/mamoe/mirai-console-wrapper/releases/download/1.3.0/mirai-console-wrapper-1.3.0-all.jar
java -jar mirai-console-wrapper-1.3.0-all.jar
```
在 mirai-console 里登录 QQ 并下载 CQHTTPMirai 插件
```shell
# （mirai-console内）
# 登录 QQ
login 123456789 ppaasswwdd # 注意改成你的QQ小号的账号密码
# 安装 cqhttp-mirai
install CQHTTPMirai
```
按下 `ctrl-a c` 连续组合键，新建一个 screen shell
按下 `ctrl-a , c` 连续组合键，新建一个 screen shell
修改 CQHTTPMirai 配置文件
```shell
mkdir -p ~/qqbot/mirai/plugins/CQHTTPMirai
cd ~/qqbot/mirai/plugins/CQHTTPMirai
vim setting.yml
vi setting.yml
```
修改配置文件如下（注意修改 QQ 号）
......@@ -83,22 +93,26 @@ vim setting.yml
postMessageFormat: string
reverseHost: 127.0.0.1
reversePort: 9222
reversePath: /ws
reversePath: /ws/
accessToken: null
reconnectInterval: 3000
# 详细说明请参考 https://github.com/yyuueexxiinngg/cqhttp-mirai
```
保存后按下 `ctrl-a 1` 连续组合键，回到 1 号 shell （即 mirai-console 所在的 shell）
保存后按下 `ctrl-a , 1` 连续组合键，回到 1 号 shell （即 mirai-console 所在的 shell）
按下 `ctrl-c` 退出 mirai 然后重新启动 mirai 并登录 QQ
<!--
重新加载插件
```shell
# （mirai-console内）
reload
```
-->
部署完成，按下 `ctrl-a d` 连续组合键挂起这两个 shell
部署完成，现在可以按下 `ctrl-a , d` 连续组合键挂起这两个 shell
## 验证安装
......@@ -108,6 +122,6 @@ reload
见[FAQ](../usage/faq.md)
## 开始 web 模式
## 开启 web 访问
[开启方法](../usage/web-mode.md)
documents/install/Linux-source.md
浏览文件 @ 2ceaf42b
......@@ -46,7 +46,7 @@ Linux 用户可以使用 mirai 部署，具体请看[这里](./Linux-cqhttp-mira
配置正确后，启动 httpapi 插件后会反复出现如下都提示
![配置正确图片](https://assets.yobot.win/img/8ba6b840bab3ac25.jpg)
![配置正确图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
## 运行 yobot 服务
......@@ -85,9 +85,9 @@ sh yobotg.sh # 如果python的路径不是python3，请手动修改这个脚本
如果需要更换主机地址、端口等信息请修改src\client\yobot_config.json配置文件。
![windows下正确启动图](https://assets.yobot.win/img/aaf38d1a5cbc1c87.jpg)
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确yobot与httpapi成功通信](https://assets.yobot.win/img/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/Windows-cqhttp-mirai.md
浏览文件 @ 2ceaf42b
# Windows 使用 cqhttp-mirai 部署
# Windows 使用 cqhttp-mirai 部署（测试）
编写中……
## 部署过程
本文为便携版部署方式
### 部署 yobot
下载[yobot便携版](https://yobot.lanzous.com/b00nlr3ni)
解压后双击“yobot.exe”启动服务
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
### 部署 mirai
下载[mirai-installer](https://yobot.lanzous.com/id6owid)，并安装
启动 mirai
在 mirai 控制台里登录 QQ `login 123456789 ppaasswwdd`
在 mirai 控制台里安装 cqhttp-mirai `install CQHTTPMirai`
CQHTTPMirai 配置文件在 `mirai\plugins\CQHTTPMirai\setting.yml`，修改配置文件如下（注意修改 QQ 号）
```yaml
# 要进行配置的QQ号 (Mirai支持多帐号登录, 故需要对每个帐号进行单独设置)
"1234567890":
ws_reverse:
enable: true
postMessageFormat: string
reverseHost: 127.0.0.1
reversePort: 9222
reversePath: /ws/
accessToken: null
reconnectInterval: 3000
# 详细说明请参考 https://github.com/yyuueexxiinngg/cqhttp-mirai
```
重新启动 mirai 并登录
<!--
在 mirai 控制台里重新加载插件 `reload`
-->
部署完成
## 验证安装
向机器人发送“version”，机器人会回复当前版本
## 常见问题
见[FAQ](../usage/faq.md)
## 开启 web 访问
[开启方法](../usage/web-mode.md)
documents/install/Windows-portable.md
浏览文件 @ 2ceaf42b
......@@ -13,11 +13,11 @@
#### Windows 使用
yobot 三代基于酷Q机器人和 httpapi 插件实现
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](http://download.yobot.xyz/tools/CoolQ_With_Httpapi.7z)
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](http://vs.yixuedh.com/downloads/yobot/CoolQ_With_Httpapi.7z)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](http://download.yobot.xyz/tools/Packed_httpapi.7z)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](http://vs.yixuedh.com/downloads/yobot/Packed_httpapi.7z)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](http://download.yobot.xyz/tools/mirror_of_httpapi.7z)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](http://vs.yixuedh.com/downloads/yobot/mirror_of_httpapi.7z)
### 环境搭建
......@@ -35,7 +35,7 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
配置正确后，启动 httpapi 插件后会反复出现如下的提示
![配置正确图片](https://assets.yobot.win/img/8ba6b840bab3ac25.jpg)
![配置正确图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
## 运行yobot服务
......@@ -45,9 +45,9 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
下载yobot便携版，创建一个文件夹解压，启动 yobot.exe 即可。如需更改端口，请启动一次后修改 yobot_config.json 中的 port 字段并重启。
![windows下正确启动图](https://assets.yobot.win/img/aaf38d1a5cbc1c87.jpg)
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确yobot与httpapi成功通信](https://assets.yobot.win/img/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/Windows-quick-start.md
浏览文件 @ 2ceaf42b
......@@ -16,7 +16,7 @@
### 第一步
点击下载[酷Q-httpapi 整合包](http://download.yobot.xyz/tools/CoolQ_With_Httpapi.7z)
点击下载[酷Q-httpapi 整合包](https://vs.yixuedh.com/downloads/yobot/CoolQ_With_Httpapi.7z)
解压后双击“CQA.exe”，输入账号密码（注意账号风险，请勿使用重要的QQ号）
......@@ -24,7 +24,7 @@
启动 httpapi 插件后会反复出现如下的提示
![httpapi启用图片](https://assets.yobot.win/img/8ba6b840bab3ac25.jpg)
![httpapi启用图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
### 第二步
......@@ -32,7 +32,7 @@
解压后双击“yobot.exe”启动服务，双方通信成功后出现如下的提示
![windows下正确yobot与httpapi成功通信](https://assets.yobot.win/img/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/Windows-source.md
浏览文件 @ 2ceaf42b
......@@ -20,11 +20,11 @@
#### Windows 使用
yobot 三代基于酷Q机器人和 httpapi 插件实现
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](http://download.yobot.xyz/tools/CoolQ_With_Httpapi.7z)
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](http://vs.yixuedh.com/downloads/yobot/CoolQ_With_Httpapi.7z)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](http://download.yobot.xyz/tools/Packed_httpapi.7z)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](http://vs.yixuedh.com/downloads/yobot/Packed_httpapi.7z)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](http://download.yobot.xyz/tools/mirror_of_httpapi.7z)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](http://vs.yixuedh.com/downloads/yobot/mirror_of_httpapi.7z)
### 环境搭建
......@@ -42,7 +42,7 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
配置正确后，启动 httpapi 插件后会反复出现如下都提示
![配置正确图片](https://assets.yobot.win/img/8ba6b840bab3ac25.jpg)
![配置正确图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
## 运行yobot服务
......@@ -67,9 +67,9 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
如果需要更换主机地址、端口等信息请修改src\client\yobot_config.json配置文件。
![windows下正确启动图](https://assets.yobot.win/img/aaf38d1a5cbc1c87.jpg)
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确yobot与httpapi成功通信](https://assets.yobot.win/img/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/cq.md
浏览文件 @ 2ceaf42b
......@@ -10,7 +10,7 @@ yobot搭建难度约等于搭建网站的难度，请量力而行
:::
如果想租用或出租机器人，可以加群 {{ [770947581,1044314369,774394459][Math.floor(Math.random()*3)] }}
如果想租用或出租机器人，可以加群 {{ [770947581,1044314369,1067699252,774394459][Math.floor(Math.random()*3)] }}
选择一个安装教程：
......
documents/install/mirai.md
浏览文件 @ 2ceaf42b
......@@ -10,4 +10,12 @@ yobot 原生于 cqhttp，利用[cqhttp-mirai](https://github.com/yyuueexxiinngg/
## Linux 部署
利用 [mirai-console-wrapper](https://github.com/mamoe/mirai-console) 部署命令行操作
[详细说明](./Linux-cqhttp-mirai.md)
## Android 部署
利用 [mirai-Andriod](https://github.com/mzdluo123/MiraiAndroid) 与 [Qpython](https://play.google.com/store/apps/details?id=org.qpython.qpy3) 将 yobot 部署到安卓手机上
编写中……
documents/usage/access-token.md
浏览文件 @ 2ceaf42b
......@@ -10,4 +10,4 @@
进入httpapi的`<应用目录/config/<general|qq号>.json`（如下图），将其中 `access_token` 修改为刚才一样的字符串
![httpapi配置文件](https://assets.yobot.win/img/f6772ec9.png)
![httpapi配置文件](https://vs.yixuedh.com/assets/img/yobot/f6772ec9.png)
documents/usage/faq.md
浏览文件 @ 2ceaf42b
......@@ -92,4 +92,4 @@ chown -R 1000:1000 .
### 这里没有我的问题
可以在QQ群（{{ [770947581,1044314369,774394459][Math.floor(Math.random()*3)] }}）或[github issue](https://github.com/yuudi/yobot/issues)提问，提问前可以阅读[正确的提问姿势](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways/blob/master/README.md)
可以在QQ群（{{ [770947581,1044314369,1067699252,774394459][Math.floor(Math.random()*3)] }}）或[github issue](https://github.com/yuudi/yobot/issues)提问，提问前可以阅读[正确的提问姿势](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways/blob/master/README.md)
documents/usage/windows-nginx-package.md
浏览文件 @ 2ceaf42b
......@@ -2,8 +2,8 @@
## 使用方法
1. 在**你的服务器上**下载[yobot Nginx 预配置包](https://yobot.lanzous.com/id60sli)，解压。
1. 双击 `start.bat`，有一个窗口**一闪而过**，这是正常的。
1. 在**你的服务器上**下载[yobot Nginx 预配置包](https://yobot.lanzous.com/id7c0da)，解压。
1. 双击 `启动.bat`，有一个窗口**一闪而过**，这是正常的。
1. 在你自己的电脑上打开浏览器，输入你的服务器 ip 地址，如果看到 `Welcome to nginx!` 则说明启动成功。
1. 向你的机器人发送`登录`，获得地址后，删除地址中的 `:9222` （包括冒号），复制到浏览器进入后台。
1. 进入后台的设置页面，在 `此站点的公开地址` 一栏中，删除地址中的 `:9222` （包括冒号），然后保存并重启即可。
......@@ -14,7 +14,7 @@
如果使用的是国内服务器，那么 80 端口不能使用**未备案**的域名。
除了 `start.bat`，预配置包中还放了一些常用的快捷指令：
stop.bat 用于停止 nignx
forced-stop.bat 用于强制停止 nignx
reload.bat 用于修改配置文件后重新加载
除了 `启动.bat`，预配置包中还放了一些常用的快捷指令：
`停止.bat` 用于停止 nignx
`强制停止.bat` 用于强制停止 nignx
`重载配置.bat` 用于修改配置文件后重新加载
Supports Markdown
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或