开始 #
启动Mirai #
推荐使用官方启动器 mirai-console-loader 自行启动 mirai 与 mirai-api-http 插件。
由于种种原因，本教程不提供
mirai的使用教程。你可以查看 Mirai 用户手册 。
你需要具备自行启动
mirai的能力。
搭建PHP环境 #
8.0` > `PHP Version` ≥ `7.0
使用 Apache 、 Nginx 或者 IIS 等搭建都可以。
由于此类教程繁多，本教程不提供搭建
PHP 环境的教程。建议自行百度：搭建PHP环境 。
安装 #
在 miraiez 仓库中拉取最新代码。
代码须放置于 PHP Web 服务端 中。
配置 #
- 在
mirai-api-http的配置文件setting.yml中启用http和webhook适配器。 - 将
webhook适配器的回调地址设置为webhook.php的所在地址。 - 完成上述步骤后，请修改
miraiez的配置文件config.php。
配置参考 #
config.php #
<?php
define("httpApi", "http://localhost:90"); //http api
define("verifyKey", "0123456789"); //http api verifyKey
define("Authorization", ""); //webhook Authorization
setting.yml #
## 启用的 adapter, 内置有 http, ws, reverse-ws, webhook
adapters:
- http
- webhook
## 是否开启认证流程, 若为 true 则建立连接时需要验证 verifyKey
## 建议公网连接时开启
enableVerify: true
verifyKey: 0123456789
## 开启一些调式信息
debug: false
## 是否开启单 session 模式, 若为 true，则自动创建 session 绑定 console 中登录的 bot
## 开启后，接口中任何 sessionKey 不需要传递参数
## 若 console 中有多个 bot 登录，则行为未定义
## 确保 console 中只有一个 bot 登陆时启用
singleMode: false
## 历史消息的缓存大小
## 同时，也是 http adapter 的消息队列容量
cacheSize: 4096
## adapter 的单独配置，键名与 adapters 项配置相同
adapterSettings:
## 详情看 http adapter 使用说明 配置
http:
host: localhost
port: 90
cors: [*]
## 详情看 webhook adapter 使用说明 配置
webhook:
destinations:
- 'http://localhost:80/webhook.php'
extraHeaders:
Authorization: 'bearer SV*(&*(SH@ID^G'
hedaer1: value1
hedaer2: value2
如需了解更多，可以查看 mirai-api-http 官方 文档 。
完成 #
向你的机器人发送 hello 。
如果机器人回复 Hello world 。
那么恭喜你，你的 MiraiPHP 机器人 搭建成功了！
更多 #
插件 #
你可以使用 PHP 编写机器人插件。
将你编写的插件放入 plugins 文件夹。
并在 webhook.php 中加入插件列表即可。
查看 plugins 文件夹中的示例插件。
注意是 miraiez 文件中的 plugins 文件夹！
easyMirai.php 中的是核心函数。
可以帮助你更快的编写插件。
帮助 #
你可以查看 Mirai 、 mirai-api-http 、miraiez 对应的文档，以便快速入门。