Madoka 使用教程 - Colsrch的小破站

Madoka QQ 机器人使用教程

配置 Mirai

该机器人使用 mirai 进行收发消息,因此需要先配置 mirai.

配置 JAVA 环境

安装 Java 11 版本以上的 OpenJDK 并添加 环境变量。

注意:请安装 OpenJDK 而不是甲骨文(Oracle)的jdk。原因

下载 mirai-console-loader 启动器

mirai-console-loader 简称 mcl,是 mirai-console 的官方一键启动器。

由于想要运行 Mirai 需要准备 mirai-core, mirai-console 和 mirai-console-terminal, 然后还需要通过一大串指令来启动它。因此有了 mcl 一键启动它,我们只需要下载它即可。

下载完成 mcl 之后解压,我们可以得到下列文件

进入该目录,让我们启动它

Linux
1
./mcl
Windows
1
.\mcl.cmd

启动后它会自动下载一堆依赖,当你看到 mirai-console started successfully. 就代表你已经启动 mirai-console 成功了😘

接下来让我们先关掉它。

配置 mirai-api-http v2

首先前往项目地址下载这个jar包(下载 2.x 版本哦)

然后将其放到 plugins 目录下

现在你需要再次启动 mcl 以便自动生成 mirai-api-http 的配置文件。

启动后就关掉哦~

编辑 mirai-api-http 配置文件,一般只需要自定义一下 verifyKey 就可以了,下面是示例配置

config/net.mamoe.mirai-api-http/setting.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
adapters:
- http
- ws
debug: false
enableVerify: true
verifyKey: ServiceVerifyKey # 你可以自己设定, 这里作为示范
singleMode: false
cacheSize: 4096 # 可选, 缓存大小, 默认4096. 缓存过小会导致引用回复与撤回消息失败
adapterSettings:
## 详情看 http adapter 使用说明 配置
http:
host: localhost
port: 8080 # 端口
cors: [*]

## 详情看 websocket adapter 使用说明 配置
ws:
host: localhost
port: 8080 # 端口
reservedSyncId: -1 # 确保为 -1

配置自动登录

编辑 AutoLogin.yml 配置文件,示例配置:

config/Console/AutoLogin.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
accounts: 
- # 账号, 现只支持 QQ 数字账号
account: 123456
password:
# 密码种类, 可选 PLAIN 或 MD5
kind: PLAIN
# 密码内容, PLAIN 时为密码文本, MD5 时为 16 进制
value: password
# 账号配置. 可用配置列表 (注意大小写):
# "protocol": "ANDROID_PHONE" / "ANDROID_PAD" / "ANDROID_WATCH"
# "device": "device.json"
configuration:
protocol: ANDROID_PHONE
device: device.json

接下来再次运行 mcl 就可以登录了。

登录验证问题

若你登录过程中遇到登录验证等问题,推荐使用 MiraiAndroid 成功登录你对应的 QQ 号后,导出对应 device.json 并复制到 bots/QQ账号 目录。

配置 Madoka

前面我们已经成功运行 mcl 了,接下来就要开始配置机器人核心程序了。为什么叫它核心程序?只有一个 mirai 也不能干什么事。

安装 MySQL

Madoka 使用 MySQL 来存储 99.99% 的数据,这里推荐安装 MySQL 8.0+, 在 Madoka 开发测试中,所用版本均为 8.0。

具体安装方法请移步搜索引擎检索

安装完成后需要创建一个数据库,例如:qqbot

克隆项目

1
git clone https://github.com/MadokaProject/Application.git Madoka

安装依赖

进入 Madoka 目录,执行下列命令安装依赖

1
pip install -r requirements.txt

建议使用 Virtualenv 或 Anaconda 等虚拟环境工具

配置基本信息

app/core 目录的 env.config.ini 文件复制或重命名为 config.ini, 然后补全它。

注意:你不应该往配置字段值中添加任何无关符号。
错误写法: key='value'
正确写法: key=value

安装插件

前往 插件仓库 将所需插件对应文件弄到至 app/plugin 目录(不管什么方式,然后执行 .sys reload 命令或重启机器人

若你安装的插件有需要安装的依赖库,你应该可以在对应插件同名文件夹下找到 requirements.txt 文件。

方法三

使用 Web 端一键安装(暂无)。

你也可以自行在该目录编写其他插件,同时欢迎你将你的插件 PR 到插件仓库

运行 Madoka

请确保你的 mirai 已运行

1
python main.py

若你在安装依赖时使用了虚拟环境,你还需要先切换到对应虚拟环境中。

评论