mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-07-27 16:21:28 +00:00
Merge branch 'dev' into master
This commit is contained in:
Ju4tCode
GitHub
@ -44,7 +44,7 @@
|
||||
<v-col
|
||||
cols="12"
|
||||
sm="6"
|
||||
v-for="(plugin, index) in filteredPlugins"
|
||||
v-for="(plugin, index) in displayPlugins"
|
||||
:key="index"
|
||||
>
|
||||
<v-card>
|
||||
@ -126,6 +126,9 @@ export default {
|
||||
plugin.author.indexOf(this.filterText) != -1
|
||||
);
|
||||
});
|
||||
},
|
||||
displayPlugins() {
|
||||
return this.filteredPlugins.slice((this.page - 1) * 10, this.page * 10);
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
|
||||
@ -116,7 +116,7 @@ module.exports = context => ({
|
||||
title: "协议适配",
|
||||
collapsable: false,
|
||||
sidebar: "auto",
|
||||
children: ["cqhttp-guide", "ding-guide"]
|
||||
children: ["cqhttp-guide", "ding-guide", "mirai-guide"]
|
||||
}
|
||||
],
|
||||
"/advanced/": [
|
||||
@ -209,6 +209,10 @@ module.exports = context => ({
|
||||
{
|
||||
title: "nonebot.adapters.ding 模块",
|
||||
path: "adapters/ding"
|
||||
},
|
||||
{
|
||||
title: "nonebot.adapters.mirai 模块",
|
||||
path: "adapters/mirai"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -50,3 +50,6 @@
|
||||
|
||||
|
||||
* [nonebot.adapters.ding](adapters/ding.html)
|
||||
|
||||
|
||||
* [nonebot.adapters.mirai](adapters/mirai.html)
|
||||
|
||||
@ -17,21 +17,25 @@ sidebarDepth: 0
|
||||
Bot 基类。用于处理上报消息，并提供 API 调用接口。
|
||||
|
||||
|
||||
### _abstract_ `__init__(driver, connection_type, config, self_id, *, websocket=None)`
|
||||
### `driver`
|
||||
|
||||
Driver 对象
|
||||
|
||||
|
||||
### `config`
|
||||
|
||||
Config 配置对象
|
||||
|
||||
|
||||
### _abstract_ `__init__(connection_type, self_id, *, websocket=None)`
|
||||
|
||||
|
||||
* **参数**
|
||||
|
||||
|
||||
* `driver: Driver`: Driver 对象
|
||||
|
||||
|
||||
* `connection_type: str`: http 或者 websocket
|
||||
|
||||
|
||||
* `config: Config`: Config 对象
|
||||
|
||||
|
||||
* `self_id: str`: 机器人 ID
|
||||
|
||||
|
||||
@ -39,21 +43,11 @@ Bot 基类。用于处理上报消息，并提供 API 调用接口。
|
||||
|
||||
|
||||
|
||||
### `driver`
|
||||
|
||||
Driver 对象
|
||||
|
||||
|
||||
### `connection_type`
|
||||
|
||||
连接类型
|
||||
|
||||
|
||||
### `config`
|
||||
|
||||
Config 配置对象
|
||||
|
||||
|
||||
### `self_id`
|
||||
|
||||
机器人 ID
|
||||
@ -69,6 +63,15 @@ Websocket 连接对象
|
||||
Adapter 类型
|
||||
|
||||
|
||||
### _classmethod_ `register(driver, config)`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
register 方法会在 driver.register_adapter 时被调用，用于初始化相关配置
|
||||
|
||||
|
||||
|
||||
### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
||||
|
||||
|
||||
|
||||
@ -197,6 +197,16 @@ sidebarDepth: 0
|
||||
@指定手机号人员
|
||||
|
||||
|
||||
### _static_ `atDingtalkIds(*dingtalkIds)`
|
||||
|
||||
@指定 id，@ 默认会在消息段末尾。
|
||||
所以你可以在消息中使用 @{senderId} 占位，发送出去之后 @ 就会出现在占位的位置：
|
||||
``python
|
||||
message = MessageSegment.text(f"@{event.senderId}，你好")
|
||||
message += MessageSegment.atDingtalkIds(event.senderId)
|
||||
``
|
||||
|
||||
|
||||
### _static_ `text(text)`
|
||||
|
||||
发送 `text` 类型消息
|
||||
@ -212,6 +222,11 @@ sidebarDepth: 0
|
||||
"标记 text 文本的 extension 属性，需要与 text 消息段相加。
|
||||
|
||||
|
||||
### _static_ `code(code_language, code)`
|
||||
|
||||
"发送 code 消息段
|
||||
|
||||
|
||||
### _static_ `markdown(title, text)`
|
||||
|
||||
发送 `markdown` 类型消息
|
||||
|
||||
1908
docs/api/adapters/mirai.md
Normal file
1908
docs/api/adapters/mirai.md
Normal file
File diff suppressed because it is too large
Load Diff
@ -14,7 +14,7 @@ NoneBot 使用 [pydantic](https://pydantic-docs.helpmanual.io/) 以及 [python-d
|
||||
|
||||
## _class_ `Env`
|
||||
|
||||
基类：`pydantic.env_settings.BaseSettings`
|
||||
基类：`nonebot.config.BaseConfig`
|
||||
|
||||
运行环境配置。大小写不敏感。
|
||||
|
||||
@ -211,7 +211,7 @@ X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2
|
||||
|
||||
|
||||
```default
|
||||
SUPER_USERS=["12345789"]
|
||||
SUPERUSERS=["12345789"]
|
||||
```
|
||||
|
||||
|
||||
|
||||
@ -120,7 +120,7 @@ Driver 基类。将后端框架封装，以满足适配器使用。
|
||||
|
||||
|
||||
|
||||
### _classmethod_ `register_adapter(name, adapter)`
|
||||
### `register_adapter(name, adapter)`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
@ -1225,7 +1225,7 @@ def something_else():
|
||||
|
||||
|
||||
|
||||
## `load_builtin_plugins()`
|
||||
## `load_builtin_plugins(name='echo')`
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
@ -215,7 +215,8 @@ Rule(async_function, run_sync(sync_function))
|
||||
|
||||
根据正则表达式进行匹配。
|
||||
|
||||
可以通过 `state["_matched"]` 获取正则表达式匹配成功的文本。
|
||||
可以通过 `state["_matched"]` `state["_matched_groups"]` `state["_matched_dict"]`
|
||||
获取正则表达式匹配成功的文本。
|
||||
|
||||
|
||||
|
||||
|
||||
@ -13,11 +13,14 @@
|
||||
NoneBot 在启动时将会从系统环境变量或者 `.env` 文件中寻找变量 `ENVIRONMENT` (大小写不敏感)，默认值为 `prod`。
|
||||
这将引导 NoneBot 从系统环境变量或者 `.env.{ENVIRONMENT}` 文件中进一步加载具体配置。
|
||||
|
||||
`.env` 文件是基础环境配置文件，该文件中的配置项在不同环境下都会被加载，但会被 `.env.{ENVIRONMENT}` 文件中的配置所覆盖。
|
||||
|
||||
现在，我们在 `.env` 文件中写入当前环境信息：
|
||||
|
||||
```bash
|
||||
# .env
|
||||
ENVIRONMENT=dev
|
||||
CUSTOM_CONFIG=common config # 这个配置项在任何环境中都会被加载
|
||||
```
|
||||
|
||||
如你所想，之后 NoneBot 就会从 `.env.dev` 文件中加载环境变量。
|
||||
@ -26,7 +29,7 @@ ENVIRONMENT=dev
|
||||
|
||||
NoneBot 使用 [pydantic](https://pydantic-docs.helpmanual.io/) 进行配置管理，会从 `.env.{ENVIRONMENT}` 文件中获悉环境配置。
|
||||
|
||||
可以在 NoneBot 初始化时指定加载某个环境配置文件: `nonebot.init(_env_file=".env.dev")`，这将忽略你在 `.env` 中设置的环境信息。
|
||||
可以在 NoneBot 初始化时指定加载某个环境配置文件: `nonebot.init(_env_file=".env.dev")`，这将忽略你在 `.env` 中设置的 `ENVIRONMENT` 。
|
||||
|
||||
:::warning 提示
|
||||
由于 `pydantic` 使用 JSON 解析配置项，请确保配置项值为 JSON 格式的数据。如：
|
||||
|
||||
@ -128,7 +128,7 @@ def check(arg1, args2):
|
||||
async def _checker(bot: Bot, event: Event, state: T_State) -> bool:
|
||||
return bool(arg1 + arg2)
|
||||
|
||||
return Rule(_check)
|
||||
return Rule(_checker)
|
||||
```
|
||||
|
||||
`Rule` 和 `RuleChecker` 之间可以使用 `与 &` 互相组合：
|
||||
|
||||
@ -1,3 +1,119 @@
|
||||
# 钉钉机器人使用指南
|
||||
|
||||
~~TODO~~
|
||||
基于企业机器人的outgoing（回调）机制，用户@机器人之后，钉钉会将消息内容POST到开发者的消息接收地址。开发者解析出消息内容、发送者身份，根据企业的业务逻辑，组装响应的消息内容返回，钉钉会将响应内容发送到群里。
|
||||
|
||||
::: warning 只有企业内部机器人支持接收消息
|
||||
普通的机器人尚不支持应答机制，该机制指的是群里成员在聊天@机器人的时候，钉钉回调指定的服务地址，即Outgoing机器人。
|
||||
:::
|
||||
|
||||
首先你需要有钉钉机器人的相关概念，请参阅相关文档：
|
||||
|
||||
- [群机器人概述](https://developers.dingtalk.com/document/app/overview-of-group-robots)
|
||||
- [开发企业内部机器人](https://developers.dingtalk.com/document/app/develop-enterprise-internal-robots)
|
||||
|
||||
## 关于 DingAdapter 的说明
|
||||
|
||||
你需要显式的注册 ding 这个适配器：
|
||||
|
||||
```python{2,6}
|
||||
import nonebot
|
||||
from nonebot.adapters.ding import Bot as DingBot
|
||||
|
||||
nonebot.init()
|
||||
driver = nonebot.get_driver()
|
||||
driver.register_adapter("ding", DingBot)
|
||||
nonebot.load_builtin_plugins()
|
||||
|
||||
if __name__ == "__main__":
|
||||
nonebot.run()
|
||||
```
|
||||
|
||||
注册适配器的目的是将 `/ding` 这个路径挂载到程序上，并且和 DingBot 适配器关联起来。之后钉钉把收到的消息回调到 `http://xx.xxx.xxx.xxx:{port}/ding` 时，Nonebot 才知道要用什么适配器去处理该消息。
|
||||
|
||||
## 第一个命令
|
||||
|
||||
因为 Nonebot 可以根据你的命令处理函数的类型注解来选择使用什么 Adapter 进行处理，所以你如果需要使用钉钉相关的功能，你的 handler 中 `bot` 类型的注解需要是 DingBot 及其父类。
|
||||
|
||||
对于 Event 来说也是如此，Event 也可以根据标注来判断，比如一个 handler 的 event 标注位 `PrivateMessageEvent`，那这个 handler 只会处理私聊消息。
|
||||
|
||||
举个栗子：
|
||||
|
||||
```python
|
||||
test = on_command("test", to_me())
|
||||
|
||||
|
||||
@test.handle()
|
||||
async def test_handler1(bot: DingBot, event: PrivateMessageEvent):
|
||||
await test.finish("PrivateMessageEvent")
|
||||
|
||||
|
||||
@test.handle()
|
||||
async def test_handler2(bot: DingBot, event: GroupMessageEvent):
|
||||
await test.finish("GroupMessageEvent")
|
||||
```
|
||||
|
||||
这样 Nonebot 就会根据不同的类型注解使用不同的 handler 来处理消息。
|
||||
|
||||
可以查看 Nonebot 官方的这个例子：<https://github.com/nonebot/nonebot2/tree/dev/tests>，更详细的了解一个 Bot 的结构。
|
||||
|
||||
## 多种消息格式
|
||||
|
||||
发送 markdown 消息：
|
||||
|
||||
```python
|
||||
@markdown.handle()
|
||||
async def markdown_handler(bot: DingBot):
|
||||
message = MessageSegment.markdown(
|
||||
"Hello, This is NoneBot",
|
||||
"#### NoneBot \n> Nonebot 是一款高性能的 Python 机器人框架\n> \n> [GitHub 仓库地址](https://github.com/nonebot/nonebot2) \n"
|
||||
)
|
||||
await markdown.finish(message)
|
||||
```
|
||||
|
||||
可以按自己的需要发送原生的格式消息（需要使用 `MessageSegment` 包裹，可以很方便的实现 @ 等操作）：
|
||||
|
||||
```python
|
||||
@raw.handle()
|
||||
async def raw_handler(bot: DingBot, event: MessageEvent):
|
||||
message = MessageSegment.raw({
|
||||
"msgtype": "text",
|
||||
"text": {
|
||||
"content": f"@{event.senderId}，你好"
|
||||
},
|
||||
})
|
||||
message += MessageSegment.atDingtalkIds(event.senderId)
|
||||
await raw.send(message)
|
||||
```
|
||||
|
||||
其他消息格式请查看 [钉钉适配器的 MessageSegment](https://github.com/nonebot/nonebot2/blob/dev/nonebot/adapters/ding/message.py#L8)，里面封装了很多有关消息的方法，比如 `code`、`image`、`feedCard` 等。
|
||||
|
||||
## 创建机器人并连接
|
||||
|
||||
在钉钉官方文档 [「开发企业内部机器人 -> 步骤一：创建机器人应用」](https://developers.dingtalk.com/document/app/develop-enterprise-internal-robots/title-ufs-4gh-poh) 中有详细介绍，这里就省去创建的步骤，介绍一下如何连接上程序。
|
||||
|
||||
### 本地开发机器人
|
||||
|
||||
在本地开发机器人的时候可能没有公网 IP，钉钉官方给我们提供一个 [内网穿透工具](https://developers.dingtalk.com/document/resourcedownload/http-intranet-penetration?pnamespace=app)，方便开发测试。
|
||||
|
||||
::: tip
|
||||
究其根源这是一个魔改版的 ngrok，钉钉提供了一个服务器。
|
||||
|
||||
本工具不保证稳定性，仅适用于开发测试阶段，禁止当作公网域名使用。如线上应用使用本工具造成稳定性问题，后果由自己承担。如使用本工具传播违法不良信息，钉钉将追究法律责任。
|
||||
:::
|
||||
|
||||
官方文档里已经讲了如何使用。我们再以 Windows（终端使用 Powershell） 为例，来演示一下。
|
||||
|
||||
1. 将仓库 clone 到本地，打开 `windows_64` 文件夹。
|
||||
2. 执行 `.\ding.exe -config="./ding.cfg" -subdomain=rcnb 8080` 就可以将 8080 端口暴露到公网中。
|
||||
你访问 <http://rcnb.vaiwan.com/xxxxx> 都会映射到 <http://127.0.0.1:8080/xxxxx>。
|
||||
|
||||
假设我们的机器人监听的端口是 `2333`，并且已经注册了钉钉适配器。那我们就执行 `.\ding.exe -config="./ding.cfg" -subdomain=rcnb 2333`，然后在机器人的后台设置 POST 的地址：`http://rcnb.vaiwan.com/ding`。
|
||||
这样钉钉接收到消息之后就会 POST 消息到 `http://rcnb.vaiwan.com/ding` 上，然后这个服务会把消息再转发到我们本地的开发服务器上。
|
||||
|
||||
### 生产模式
|
||||
|
||||
生产模式你的机器需要有一个公网 IP，然后到机器人的后台设置 POST 的地址就好了。
|
||||
|
||||
## 示例
|
||||
|
||||
关于钉钉机器人能做啥，你可以查看 `https://github.com/nonebot/nonebot2/blob/dev/tests/test_plugins/test_ding.py`，里面有一些例子。
|
||||
|
||||
@ -12,7 +12,7 @@ nb create
|
||||
|
||||
根据脚手架引导，将在当前目录下创建一个项目目录，项目目录内包含 `bot.py`。
|
||||
|
||||
如果未安装 `nb-cli`，使用你最熟悉的编辑器或 IDE，创建一个名为 `bot.py` 的文件，内容如下（这里以 CQHTTP 为例）：
|
||||
如果未安装 `nb-cli`，使用你最熟悉的编辑器或 IDE，创建一个名为 `bot.py` 的文件，内容如下（这里以 CQHTTP 适配器为例）：
|
||||
|
||||
```python{4,6,7,10}
|
||||
import nonebot
|
||||
@ -63,6 +63,7 @@ python bot.py
|
||||
|
||||
- [配置 CQHTTP](./cqhttp-guide.md)
|
||||
- [配置钉钉](./ding-guide.md)
|
||||
- [配置 mirai-api-http](./mirai-guide.md)
|
||||
|
||||
NoneBot 接受的上报地址与 `Driver` 有关，默认使用的 `FastAPI Driver` 所接受的上报地址有：
|
||||
|
||||
|
||||
@ -30,6 +30,12 @@ pip uninstall nonebot
|
||||
|
||||
nb-cli: [](https://github.com/nonebot/nb-cli)
|
||||
|
||||
4. 如果有疑问，可以加群交流 (点击链接直达)
|
||||
|
||||
[](https://jq.qq.com/?_wv=1027&k=5OFifDh)
|
||||
|
||||
[](https://t.me/cqhttp)
|
||||
|
||||
### 不使用脚手架(纯净安装)
|
||||
|
||||
```bash
|
||||
|
||||
195
docs/guide/mirai-guide.md
Normal file
195
docs/guide/mirai-guide.md
Normal file
@ -0,0 +1,195 @@
|
||||
# Mirai-API-HTTP 协议使用指南
|
||||
|
||||
::: warning
|
||||
|
||||
Mirai-API-HTTP 的适配现在仍然处于早期阶段, 可能没有进行过充分的测试
|
||||
|
||||
请在生产环境中谨慎使用
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
为了你的使用之旅更加顺畅, 我们建议您在配置之前具有以下的前置知识
|
||||
|
||||
- 对服务端/客户端(C/S)模型的基本了解
|
||||
- 对 Web 服务配置基础的认知
|
||||
- 对`YAML`语法的一点点了解
|
||||
|
||||
:::
|
||||
|
||||
::: danger
|
||||
|
||||
Mirai-API-HTTP 的适配器以 [AGPLv3 许可](https://opensource.org/licenses/AGPL-3.0) 单独开源
|
||||
|
||||
这意味着在使用该适配器时需要 **以该许可开源您的完整程序代码**
|
||||
|
||||
:::
|
||||
|
||||
**为了便捷起见, 以下内容均以缩写 `MAH` 代替 `mirai-api-http`**
|
||||
|
||||
## 配置 MAH 客户端
|
||||
|
||||
正如你可能刚刚在[CQHTTP 协议使用指南](./cqhttp-guide.md)中所读到的:
|
||||
|
||||
> 单纯运行 NoneBot 实例并不会产生任何效果，因为此刻 QQ 这边还不知道 NoneBot 的存在，也就无法把消息发送给它，因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。
|
||||
|
||||
这次, 我们将采用在实现上有别于 onebot<sup>即 CQHTTP</sup>协议的另外一种无头 QQ API 协议, 即 MAH
|
||||
|
||||
为了配置 MAH 端, 我们现在需要移步到[MAH 的项目地址](https://github.com/project-mirai/mirai-api-http), 来看看它是如何配置的
|
||||
|
||||
根据[项目提供的 README](https://github.com/project-mirai/mirai-api-http/blob/056beedba31d6ad06426997a1d3fde861a7f8ba3/README.md),配置 MAH 大概需要以下几步
|
||||
|
||||
1. 下载并安装 Java 运行环境, 你可以有以下几种选择:
|
||||
|
||||
- [由 Oracle 提供的 Java 运行环境](https://java.com/zh-CN/download/manual.jsp) **在没有特殊需求的情况下推荐**
|
||||
- [由 Zulu 编译的 OpenJRE 环境](https://www.azul.com/downloads/zulu-community/?version=java-8-lts&architecture=x86-64-bit&package=jre)
|
||||
|
||||
2. 下载[Mirai Console Loader](https://github.com/iTXTech/mirai-console-loader)
|
||||
|
||||
- 请按照文档 README 中的步骤下载并安装
|
||||
|
||||
3. 安装 MAH:
|
||||
|
||||
- 在 Mirai Console Loader 目录下执行该指令
|
||||
|
||||
- ```shell
|
||||
./mcl --update-package net.mamoe:mirai-api-http --channel stable --type plugin
|
||||
```
|
||||
|
||||
注意: 该指令的前缀`./mcl`可能根据操作系统以及使用 java 环境的不同而变化
|
||||
|
||||
4. 修改配置文件
|
||||
|
||||
::: tip
|
||||
|
||||
在此之前, 你可能需要了解我们为 MAH 设计的两种通信方式
|
||||
|
||||
- 正向 Websocket
|
||||
- NoneBot 作为纯粹的客户端,通过 websocket 监听事件下发
|
||||
- 优势
|
||||
1. 网络配置简单, 特别是在使用 Docker 等网络隔离的容器时
|
||||
2. 在初步测试中连接性较好
|
||||
- 劣势
|
||||
1. 与 NoneBot 本身的架构不同, 可能稳定性较差
|
||||
2. 需要在注册 adapter 时显式指定 qq, 对于需要开源的程序来讲不利
|
||||
- POST 消息上报
|
||||
- NoneBot 在接受消息上报时作为服务端, 发送消息时作为客户端
|
||||
- 优势
|
||||
1. 与 NoneBot 本身架构相符, 性能和稳定性较强
|
||||
2. 无需在任何地方指定 QQ, 即插即用
|
||||
- 劣势
|
||||
1. 由于同时作为客户端和服务端, 配置较为复杂
|
||||
2. 在测试中网络连接性较差 (未确认原因)
|
||||
|
||||
:::
|
||||
|
||||
- 这是当使用正向 Websocket 时的配置举例
|
||||
|
||||
- MAH 的`setting.yml`文件
|
||||
|
||||
- ```yaml
|
||||
# 省略了部分无需修改的部分
|
||||
|
||||
host: "0.0.0.0" # 监听地址
|
||||
port: 8080 # 监听端口
|
||||
authKey: 1234567890 # 访问密钥, 最少八位
|
||||
enableWebsocket: true # 必须为true
|
||||
```
|
||||
|
||||
- `.env`文件
|
||||
|
||||
- ```shell
|
||||
MIRAI_AUTH_KEY=1234567890
|
||||
MIRAI_HOST=127.0.0.1 # 当MAH运行在本机时
|
||||
MIRAI_PORT=8080 # MAH的监听端口
|
||||
```
|
||||
|
||||
- `bot.py`文件
|
||||
|
||||
- ```python
|
||||
import nonebot
|
||||
from nonebot.adapters.mirai import WebsocketBot
|
||||
|
||||
nonebot.init()
|
||||
nonebot.get_driver().register_adapter('mirai-ws', WebsocketBot, qq=12345678) # qq参数需要填在mah中登录的qq
|
||||
nonebot.load_builtin_plugins() # 加载 nonebot 内置插件
|
||||
nonebot.run()
|
||||
```
|
||||
|
||||
- 这是当使用 POST 消息上报时的配置文件
|
||||
|
||||
- MAH 的`setting.yml`文件
|
||||
|
||||
- ```yaml
|
||||
# 省略了部分无需修改的部分
|
||||
|
||||
host: '0.0.0.0' # 监听地址
|
||||
port: 8080 # 监听端口
|
||||
authKey: 1234567890 # 访问密钥, 最少八位
|
||||
|
||||
## 消息上报
|
||||
report:
|
||||
enable: true # 必须为true
|
||||
groupMessage:
|
||||
report: true # 群消息上报
|
||||
friendMessage:
|
||||
report: true # 好友消息上报
|
||||
tempMessage:
|
||||
report: true # 临时会话上报
|
||||
eventMessage:
|
||||
report: true # 事件上报
|
||||
destinations:
|
||||
- 'http://127.0.0.1:2333/mirai/http' #上报地址, 请按照实际情况修改
|
||||
# 上报时的额外Header
|
||||
extraHeaders: {}
|
||||
```
|
||||
|
||||
- `.env`文件
|
||||
|
||||
- ```shell
|
||||
HOST=127.0.0.1 # 当MAH运行在本机时
|
||||
PORT=2333
|
||||
|
||||
MIRAI_AUTH_KEY=1234567890
|
||||
MIRAI_HOST=127.0.0.1 # 当MAH运行在本机时
|
||||
MIRAI_PORT=8080 # MAH的监听端口
|
||||
```
|
||||
|
||||
- `bot.py`文件
|
||||
|
||||
- ```python
|
||||
import nonebot
|
||||
from nonebot.adapters.mirai import Bot
|
||||
|
||||
nonebot.init()
|
||||
nonebot.get_driver().register_adapter('mirai', Bot)
|
||||
nonebot.load_builtin_plugins() # 加载 nonebot 内置插件
|
||||
nonebot.run()
|
||||
```
|
||||
|
||||
## 历史性的第一次对话
|
||||
|
||||
现在, 先启动 NoneBot, 再启动 MAH
|
||||
|
||||
如果你的配置文件一切正常, 你将在控制台看到类似于下列的日志
|
||||
|
||||
```log
|
||||
02-01 18:25:12 [INFO] nonebot | NoneBot is initializing...
|
||||
02-01 18:25:12 [INFO] nonebot | Current Env: prod
|
||||
02-01 18:25:12 [DEBUG] nonebot | Loaded Config: {'driver': 'nonebot.drivers.fastapi', 'host': IPv4Address('127.0.0.1'), 'port': 8080, 'debug': True, 'api_root': {}, 'api_timeout': 30.0, 'access_token': None, 'secret': None, 'superusers': set(), 'nickname': set(), 'command_start': {'/'}, 'command_sep': {'.'}, 'session_expire_timeout': datetime.timedelta(seconds=120), 'mirai_port': 8080, 'environment': 'prod', 'mirai_auth_key': 12345678, 'mirai_host': '127.0.0.1'}
|
||||
02-01 18:25:12 [DEBUG] nonebot | Succeeded to load adapter "mirai"
|
||||
02-01 18:25:12 [INFO] nonebot | Succeeded to import "nonebot.plugins.echo"
|
||||
02-01 18:25:12 [INFO] nonebot | Running NoneBot...
|
||||
02-01 18:25:12 [DEBUG] nonebot | Loaded adapters: mirai
|
||||
02-01 18:25:12 [INFO] uvicorn | Started server process [183155]
|
||||
02-01 18:25:12 [INFO] uvicorn | Waiting for application startup.
|
||||
02-01 18:25:12 [INFO] uvicorn | Application startup complete.
|
||||
02-01 18:25:12 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:2333 (Press CTRL+C to quit)
|
||||
02-01 18:25:14 [INFO] uvicorn | 127.0.0.1:37794 - "POST /mirai/http HTTP/1.1" 204
|
||||
02-01 18:25:14 [DEBUG] nonebot | MIRAI | received message {'type': 'BotOnlineEvent', 'qq': 1234567}
|
||||
02-01 18:25:14 [INFO] nonebot | MIRAI 1234567 | [BotOnlineEvent]: {'self_id': 1234567, 'type': 'BotOnlineEvent', 'qq': 1234567}
|
||||
02-01 18:25:14 [DEBUG] nonebot | Checking for matchers in priority 1...
|
||||
```
|
||||
|
||||
恭喜你, 你的配置已经成功!
|
||||
Reference in New Issue
Block a user