本仓库为包含 mirai 与 el-bot 的基础可运行模版。 并在 package.json 中预置了几个简单的脚本。

你需要确保你已拥有 Java 与 Node.js 环境。

.
├── LICENSE
├── README.md
├── bot  // 机器人实体，你可以自由编写代码扩展它
├── el  // 配置目录，存放机器人相关的配置（可自行解析 yml 文件）
├── mirai  // mirai 本体，你也可以删除它，使用在其他地方启动的 mirai
├── nodemon.json  // 监听文件变动，自动重启（譬如修改配置时，非常方便）
├── package.json

git clone https://github.com/ElpsyCN/el-bot-template your-el-bot
cd your-el-bot

请检查 el-bot 是否为最新版本 ，模版的依赖更新可能要略微落后。
安装最新版本 el-bot：npm install el-bot@latest

npm install

由于种种原因，本项目将不再提供安装 mirai 的脚本与方法，你应当具有自行安装 mirai 的能力。

el-bot-template/mirai 下的目录结构（你可以参照目录结构放置你从某处得到的 jar 文件）：

.
├── bot.yml
├── content
│   ├── mirai-console-0.5.2.jar
│   └── mirai-core-qqandroid-1.1.3.jar
├── device.json
├── libraries
├── mirai-console-wrapper-1.3.0.jar
└── plugins
    ├── MiraiAPIHTTP
    └── mirai-api-http-v1.7.4.jar

由于种种原因，本项目将不再提供安装 mirai 的脚本与方法，你应当具有自行启动 mirai 的能力。

npm run start:mirai

进入 mirai 目录。

复制 plugins/MiraiAPIHTTP/setting.example.yml 文件为 plugins/MiraiAPIHTTP/setting.yml。

最好自行修改你的 authKey，否则你的机器人将很可能被 NTR。

# 默认为 el-psy-congroo
authKey: el-psy-congroo

复制 .env.example 文件为 .env。

• BOT_QQ（必须）: 机器人 QQ 号，用来告诉 el-bot 你是要登录哪个 QQ。
• BOT_PASSWORD（可选）: 机器人 QQ 密码。填写后，通过 yarn start:mirai 可实现自动登录。

BOT_QQ=123456
BOT_PASSWORD=xxxxxx

记得新建一个终端，并确保你的 mirai 控制台保持打开与 QQ 已经登录。 检测控制台是否可以正常使用的一个方式是访问 localhost:4859/about 查看是否有信息返回。（如果你修改了端口号，记得替换。）

npm run start:bot
# yarn run start:bot

# 本质与 npm run start:bot 相同，不过配置了 nodemon 启动，所以当修改文件时可以自动重启。
npm run bot
# yarn bot

此时，你的 QQ 机器人就已经成功运行起来了。并将附带了一些默认的功能。

然后？然后参照 el-bot 文档 自定义吧。

第一次最好别这么干，因为你还要在 mirai 控制台里验证登录什么的。

执行该脚本等价于同时启动下文描述的 mirai 和 el-bot。（此时两者的输出信息将显示在同一个终端中。）

确保你的 QQ 已在 mirai 控制台中登录。

el-bot 将在 mirai 启动三秒后再启动，并与已登录的 QQ 建立连接。（如连接失败，则每隔三秒，自动重新连接。）

npm run start
# yarn start

npm run webhook
# yarn webhook