Skip to content
GitLab
提交 97f6ee2a 编辑于 作者: yuudi's avatar yuudi
浏览文件

docs: update documents

上级 a5a045f3
Hide whitespace changes
Inline Side-by-side
documents/README.md
浏览文件 @ 97f6ee2a
......@@ -32,23 +32,23 @@ yobot 提供了群聊、web 页面两套用户交互方式，具有操作便捷
新版助手提供了一个网页面板，面板上可以进行更多操作
![主面板](https://vs.yixuedh.com/assets/img/yobot/poYvQO.jpg)
![主面板](https://img.yobot.win/yobot/poYvQO.jpg)
![数据面板](https://vs.yixuedh.com/assets/img/yobot/HOh17P.jpg)
![数据面板](https://img.yobot.win/yobot/HOh17P.jpg)
### 新闻推送
机器人主动发送游戏新闻与活动提醒
![游戏活动提醒](https://vs.yixuedh.com/assets/img/yobot/5bd8d1f5ac68ffde.jpg)
![游戏活动提醒](https://img.yobot.win/yobot/5bd8d1f5ac68ffde.jpg)
![数据面板](https://vs.yixuedh.com/assets/img/yobot/HOh17P.jpg)
![数据面板](https://img.yobot.win/yobot/HOh17P.jpg)
### 日程查询
机器人主动发送游戏新闻与活动提醒
![游戏活动提醒](https://vs.yixuedh.com/assets/img/yobot/J04GEB.jpg)
![游戏活动提醒](https://img.yobot.win/yobot/J04GEB.jpg)
### 模拟抽卡
......@@ -57,7 +57,7 @@ yobot 提供了群聊、web 页面两套用户交互方式，具有操作便捷
还可以自定义修改卡池
（怕打扰可以关闭此功能）
![模拟抽卡](https://vs.yixuedh.com/assets/img/yobot/u4OLHH.png)
![模拟抽卡](https://img.yobot.win/yobot/u4OLHH.png)
### 更多功能
......
documents/install/Linux-cqhttp-mirai.md
浏览文件 @ 97f6ee2a
......@@ -2,7 +2,7 @@
## 部署过程
安装环境
### 环境准备
```shell
# RHEL / CentOS:
......@@ -20,13 +20,14 @@ useradd -g qqbot -m qqbot
su qqbot
```
新建一个 screen
这里我们用 screen 作为终端复用工具，具体用法请搜索 screen 教程
现在新建一个 screen 终端
```shell
screen -S qqbot
```
下载并启动 yobot
### 部署 yobot
```shell
mkdir -p ~/qqbot/yobot
......@@ -51,19 +52,25 @@ sh yobotg.sh
按下 `ctrl-a , c` 连续组合键，新建一个 screen shell
下载 mirai-console 和 cqhttp-mirai
### 部署 mirai
下载 miraiOK
下面这个是 amd64 的可执行文件，如果你的计算机不是 amd64 架构，请在[这里](https://github.com/LXY1226/MiraiOK/#下载地址)找到其他的可执行文件
```shell
mkdir -p ~/qqbot/mirai/plugins/CQHTTPMirai
cd ~/qqbot/mirai
wget http://t.imlxy.net:64724/mirai/MiraiOK/miraiOK_linux_amd64 -O miraiOK
```
# 你可以在这里找到最新版本：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
# 国内可改用 http://yopan.loli.show/mirai-console-wrapper-1.3.0-all.jar
下载 cqhttp-mirai
cd plugins
你也可以在[这里](https://github.com/yyuueexxiinngg/cqhttp-mirai/releases)找到最新版本
```shell
cd ~/qqbot/mirai/plugins
# 你可以在这里找到最新版本：https://github.com/yyuueexxiinngg/cqhttp-mirai/releases
wget https://github.com/yyuueexxiinngg/cqhttp-mirai/releases/download/0.1.4/cqhttp-mirai-0.1.4-all.jar
# 国内可改用 http://yopan.loli.show/mirai-plugins/CQHTTPMirai/CQHTTPMirai-0.1.4.jar
```
......@@ -72,7 +79,10 @@ wget https://github.com/yyuueexxiinngg/cqhttp-mirai/releases/download/0.1.4/cqht
```shell
cd ~/qqbot/mirai/plugins/CQHTTPMirai
vi setting.yml
vim setting.yml
# 如果你不熟悉 vim，建议使用 nano
# yum install nano -y 或 apt-get install nano -y
# nano setting.yml
```
修改配置文件如下（注意修改 QQ 号）
......@@ -91,11 +101,12 @@ vi setting.yml
# 详细说明请参考 https://github.com/yyuueexxiinngg/cqhttp-mirai
```
启动 mirai-console 并登录 QQ
启动 miraiOK 并登录 QQ
```shell
cd ~/qqbot/mirai
java -jar mirai-console-wrapper-1.3.0-all.jar
chmod +x miraiOK
./miraiOK
# （mirai-console内）
login 123456789 ppaasswwdd # 注意改成你的QQ小号的账号密码
......
documents/install/Linux-source.md
浏览文件 @ 97f6ee2a
......@@ -46,7 +46,7 @@ Linux 用户可以使用 mirai 部署，具体请看[这里](./Linux-cqhttp-mira
配置正确后，启动 httpapi 插件后会反复出现如下都提示
![配置正确图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
![配置正确图片](https://img.yobot.win/yobot/8ba6b840bab3ac25.jpg)
## 运行 yobot 服务
......@@ -54,10 +54,7 @@ Linux 用户可以使用 mirai 部署，具体请看[这里](./Linux-cqhttp-mira
源码运行需要使用 git 作为版本管理和更新工具，如果没有使用过 git 可以阅读：[git官网](https://git-scm.com/)，[git教程](https://www.runoob.com/git/git-tutorial.html)
推荐使用Python版本为[Python3.7](https://www.python.org/downloads/release/python-377/)
您**仍然可以**继续使用Linux预装的*Python3.6*运行Yobot源码。
如何在Linux上安装多版本Python，请自行询问搜索引擎。
请注意，[Python版本过高可能导致包不兼容](https://github.com/yuudi/yobot/issues/158#issuecomment-643633908)。
确保 python 版本至少为 3.6
下载源码 `git clone https://github.com/yuudi/yobot.git`
......@@ -88,9 +85,9 @@ sh yobotg.sh # 如果python的路径不是python3，请手动修改这个脚本
如果需要更换主机地址、端口等信息请修改src\client\yobot_config.json配置文件。
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确启动图](https://img.yobot.win/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://img.yobot.win/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/Windows-cqhttp-mirai.md
浏览文件 @ 97f6ee2a
......@@ -10,19 +10,19 @@
解压后双击“yobot.exe”启动服务
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确启动图](https://img.yobot.win/yobot/aaf38d1a5cbc1c87.jpg)
### 部署 mirai
下载[mirai-installer](https://yobot.lanzous.com/id6owid)，并安装
下载 miraiOK
[miraiOK 64位](http://t.imlxy.net:64724/mirai/MiraiOK/miraiOK_windows_amd64.exe)
[miraiOK 32位](http://t.imlxy.net:64724/mirai/MiraiOK/miraiOK_windows_386.exe)
启动 mirai
双击启动 miraiOK
在 mirai 控制台里登录 QQ `login 123456789 ppaasswwdd`
下载 [CQHTTPMirai.jar](http://yopan.loli.show/mirai-plugins/CQHTTPMirai/CQHTTPMirai-0.1.4.jar) 并放在 `.\plugins` 目录里
在 mirai 控制台里安装 cqhttp-mirai `install CQHTTPMirai`
CQHTTPMirai 配置文件在 `mirai\plugins\CQHTTPMirai\setting.yml`，修改配置文件如下（注意修改 QQ 号）
新建 CQHTTPMirai 配置文件在 `.\plugins\CQHTTPMirai\setting.yml`，修改配置文件如下（注意修改 QQ 号）
```yaml
# 要进行配置的QQ号 (Mirai支持多帐号登录, 故需要对每个帐号进行单独设置)
......@@ -38,11 +38,9 @@ CQHTTPMirai 配置文件在 `mirai\plugins\CQHTTPMirai\setting.yml`，修改配
# 详细说明请参考 https://github.com/yyuueexxiinngg/cqhttp-mirai
```
重新启动 mirai 并登录
重新启动 miraiOK 并登录
<!--
在 mirai 控制台里重新加载插件 `reload`
-->
在 mirai 控制台里登录 QQ `login 1234567890 ppaasswwdd`
部署完成
......
documents/install/Windows-portable.md
浏览文件 @ 97f6ee2a
......@@ -13,11 +13,11 @@
#### Windows 使用
yobot 三代基于酷Q机器人和 httpapi 插件实现
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](http://vs.yixuedh.com/downloads/yobot/CoolQ_With_Httpapi.7z)
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](https://yobot.lanzous.com/iXsLmdsixkh)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](http://vs.yixuedh.com/downloads/yobot/Packed_httpapi.7z)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](https://yobot.lanzous.com/iQentdsixif)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](http://vs.yixuedh.com/downloads/yobot/mirror_of_httpapi.7z)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](https://yobot.lanzous.com/iS5JSdsixli)
### 环境搭建
......@@ -35,7 +35,7 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
配置正确后，启动 httpapi 插件后会反复出现如下的提示
![配置正确图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
![配置正确图片](https://img.yobot.win/yobot/8ba6b840bab3ac25.jpg)
## 运行yobot服务
......@@ -45,9 +45,9 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
下载yobot便携版，创建一个文件夹解压，启动 yobot.exe 即可。如需更改端口，请启动一次后修改 yobot_config.json 中的 port 字段并重启。
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确启动图](https://img.yobot.win/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://img.yobot.win/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/Windows-quick-start.md
浏览文件 @ 97f6ee2a
# Windows 便携版（快速上手版）
## 参考视频
在 windows 下使用便携版安装可以参考[演示视频](http://download.yobot.xyz/media/Tutorial.mp4)
（视频中网站为旧版，不影响安装过程）
## 准备服务器
服务器能保证24小时在线和提供web服务
......@@ -16,7 +11,7 @@
### 第一步
点击下载[酷Q-httpapi 整合包](https://vs.yixuedh.com/downloads/yobot/CoolQ_With_Httpapi.7z)
点击下载[酷Q-httpapi 整合包](https://yobot.lanzous.com/iXsLmdsixkh)
解压后双击“CQA.exe”，输入账号密码（注意账号风险，请勿使用重要的QQ号）
......@@ -24,7 +19,7 @@
启动 httpapi 插件后会反复出现如下的提示
![httpapi启用图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
![httpapi启用图片](https://img.yobot.win/yobot/8ba6b840bab3ac25.jpg)
### 第二步
......@@ -32,7 +27,7 @@
解压后双击“yobot.exe”启动服务，双方通信成功后出现如下的提示
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://img.yobot.win/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/Windows-source.md
浏览文件 @ 97f6ee2a
......@@ -20,11 +20,11 @@
#### Windows 使用
yobot 三代基于酷Q机器人和 httpapi 插件实现
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](http://vs.yixuedh.com/downloads/yobot/CoolQ_With_Httpapi.7z)
如果你第一次使用酷Q机器人，可以直接下载[酷Q-httpapi 整合包](https://yobot.lanzous.com/iXsLmdsixkh)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](http://vs.yixuedh.com/downloads/yobot/Packed_httpapi.7z)
如果你已经使用过酷Q机器人，可以下载[httpapi 插件](https://yobot.lanzous.com/iQentdsixif)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](http://vs.yixuedh.com/downloads/yobot/mirror_of_httpapi.7z)
如果你已经使用过 httpapi 插件，或者想额外开启一个 httpapi 插件，可以下载[httpapi 插件分身版](https://yobot.lanzous.com/iS5JSdsixli)
### 环境搭建
......@@ -42,7 +42,7 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
配置正确后，启动 httpapi 插件后会反复出现如下都提示
![配置正确图片](https://vs.yixuedh.com/assets/img/yobot/8ba6b840bab3ac25.jpg)
![配置正确图片](https://img.yobot.win/yobot/8ba6b840bab3ac25.jpg)
## 运行yobot服务
......@@ -50,9 +50,7 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
源码运行需要使用git作为版本管理和更新工具，如果没有使用过git可以阅读：[git官网](https://git-scm.com/)，[git教程](https://www.runoob.com/git/git-tutorial.html)
推荐使用Python版本为[Python3.7](https://www.python.org/downloads/release/python-377/)
**极其不推荐**使用Windows商店自带Python，建议从官网下载可执行文件进行安装。
请注意，[Python版本过高可能导致包不兼容](https://github.com/yuudi/yobot/issues/158#issuecomment-643633908)。
确保 python 版本至少为 3.6
下载源码 `git clone https://github.com/yuudi/yobot.git`
......@@ -69,9 +67,9 @@ yobot 三代基于酷Q机器人和 httpapi 插件实现
如果需要更换主机地址、端口等信息请修改src\client\yobot_config.json配置文件。
![windows下正确启动图](https://vs.yixuedh.com/assets/img/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确启动图](https://img.yobot.win/yobot/aaf38d1a5cbc1c87.jpg)
![windows下正确yobot与httpapi成功通信](https://vs.yixuedh.com/assets/img/yobot/8179fdd1e46690b2.jpg)
![windows下正确yobot与httpapi成功通信](https://img.yobot.win/yobot/8179fdd1e46690b2.jpg)
### 验证安装
......
documents/install/docker.md
浏览文件 @ 97f6ee2a
......@@ -3,7 +3,7 @@
建议购买一台阿里云Ubuntu 18.04(linux) 云服务器来运行。
最低配置1核2GB。
::: Warning
::: warning
本文只适用于在**Linux**下部署的情况。
**Windows系统下部署**，建议参考[Windows源码部署](./Windows-source.md)。
......
documents/install/server.md
浏览文件 @ 97f6ee2a
......@@ -9,14 +9,14 @@
[阿里云学生服务器](https://promotion.aliyun.com/ntms/act/campus2018.html)（24岁以下自动获得学生身份）
[腾讯云学生服务器](https://cloud.tencent.com/act/campus)（25岁以下自动获得学生身份）
## 国外免费服务器
## 境外免费服务器
稳定性好，可以访问外网资源，需要外币信用卡验证
[甲骨文永久免费](https://www.oracle.com/cloud/free/)
[谷歌云永久免费](https://console.cloud.google.com/freetrial)
## 国外便宜服务器
## 境外便宜服务器
一些口碑比较好的：
......@@ -42,5 +42,5 @@
## 域名购买
国内域名商：[腾讯dnspod](https://dnspod.cloud.tencent.com/)、[阿里万网](https://wanwang.aliyun.com/domain/)
国外域名商：[namesilo](https://namesilo.com/)、[porkbun](https://porkbun.com/)
境外域名商：[namesilo](https://namesilo.com/)、[porkbun](https://porkbun.com/)
免费域名：[freenom](https://www.freenom.com)（条款严格）
documents/usage/access-token.md
浏览文件 @ 97f6ee2a
......@@ -10,4 +10,4 @@
进入httpapi的`<应用目录/config/<general|qq号>.json`（如下图），将其中 `access_token` 修改为刚才一样的字符串
![httpapi配置文件](https://vs.yixuedh.com/assets/img/yobot/f6772ec9.png)
![httpapi配置文件](https://img.yobot.win/yobot/f6772ec9.png)
documents/usage/faq.md
浏览文件 @ 97f6ee2a
# 常见问题
你可以按下`ctrl-F`然后搜索你的问题关键词。
你可以按下`ctrl-F`在此页面搜索你的问题关键词。或用顶部搜索栏在整个文档中进行搜索。
## 酷Q 问题
### 酷Q 社区无法注册账号
现在酷Q只能在周末注册。
现在酷Q只能在周末白天注册。
### 需要购买 酷Q Pro 吗
......@@ -32,9 +32,9 @@ yobot 不需要。（其他插件可能需要）
## mirai 问题
### mirai 如何使用
### CQHTTP-mirai 无法下载
mirai 尚未稳定，稳定后本站会发布教程和一键安装包。如果想体验测试版可以参考[这里](../install/mirai.md)
由于 mirai-console 的插件下载服务器长期故障，请按新版教程手动下载 `CQHTTP-mirai`
## yobot 问题
......@@ -83,9 +83,11 @@ Apache: `RemoteIPHeader X-Real-IP`
请参考[Docker部署](../install/docker.md)
此类情况均是由root账户直接运行docker实例造成的。
在源码根目录中执行：
```shell script
chown -R 1000:1000 .
```
以解决该问题。
### 运行时提示“存在未提交的修改”
......@@ -97,5 +99,4 @@ chown -R 1000:1000 .
### 这里没有我的问题
可以在QQ群（{{ [770947581,1044314369,1067699252,774394459][Math.floor(Math.random()*4)] }}）或[这里](https://github.com/yuudi/yobot/issues)提问，提问前**建议阅读**[正确的提问姿势](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways/blob/master/README.md)和[提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md)
可以在QQ群（{{ [770947581,1044314369,1067699252,774394459][Math.floor(Math.random()*4)] }}）或[github issue](https://github.com/yuudi/yobot/issues)提问，提问前可以阅读[正确的提问姿势](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways/blob/master/README.md)
src/client/yobot.py
浏览文件 @ 97f6ee2a
......@@ -34,7 +34,7 @@ else:
class Yobot:
Version = "[v3.6.3]"
Version_id = 197
Version_id = 199
# "git rev-list --count HEAD"
def __init__(self, *,
......
Supports Markdown
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或