Installation

🛠️ 部署与安装

如果您已经配置好 NoneBot2，可跳过前面的安装步骤

1. 部署 NoneBot2 机器人

📖 查阅官方文档：NoneBot2 - 快速上手

2. 安装适配器并配置连接

你可以在 OneBot V11（QQ聊天） 和 QQGuild（QQ频道） 适配器中进行选择

可以只安装一个或者全部安装

OneBot V11 适配器

1. 通过脚手架安装

   nb adapter install nonebot-adapter-onebot

   📖 参考官方文档：OneBot V11 - 安装 NoneBot OneBot 适配器

2. 安装 go-cqhttp
   go-cqhttp 的具体配置将在下一步完成

   📖 查阅官方文档：go-cqhttp - 基础教程

3. 配置连接

   1. 在一个目录下运行 go-cqhttp，go-cqhttp 将会在该目录下生成配置文件和设备文件等

      go-cqhttp

   2. 编辑 go-cqhttp 配置文件 config.yml

      • 像下面那样修改 servers.ws-reverse.universal 为 OneBot V11 上报地址
      • 你不必使用这里的 18080 端口号，可以选择其他的端口号

      servers:
        - ws-reverse:
          universal: ws://127.0.0.1:18080/onebot/v11/

      📖 参考官方文档：OneBot V11 - 配置连接

   3. 编辑 NoneBot 基础配置文件

      • 修改或加入以下配置项
      • 其中 HOST 为上一步的上报地址中的主机名，PORT 端口号

      # HOST 默认为 127.0.0.1
      HOST=127.0.0.1
      PORT=18080

      📖 参考官方文档：

      • NoneBot2 - .env 文件
      • OneBot V11 - 配置连接

QQGuild 适配器

Warning

原 nonebot-adapter-qqguild 已停止维护，现已经更改至 nonebot-adapter-qq
从插件版本 v1.4.0开始也更换了适配器，一些安装步骤也进行了更改

1. 如果你还没有创建过QQ频道机器人，请前往 QQ 开放平台 创建一个机器人
   并获取机器人的 开发者ID token 和 机器人令牌 secret，用于下面的 QQGuild 配置

   📖 参考官方文档：QQ 开放平台 - QQ 机器人

2. 通过脚手架安装

   nb adapter install nonebot-adapter-qq

3. 编辑 NoneBot 基础配置文件，设置 QQGuild 的机器人帐号等

   • ⚠️ 注意：配置项 QQ_BOTS 中 intent.direct_message 需要设置为 true
     以开启 QQGuild 适配器的私聊消息处理
   • 例如修改为下面的配置

   QQ_BOTS='
   [ 
     { 
       "id": "114514",
       "token": "xxxxxxxxxxxxxxx",
       "secret": "XXXXXXXXXXXXXX",
       "intent": {
         "guild_messages": true,
         "at_messages": true,
         "direct_message": true
       }
     }
   ]
   '
   QQ_IS_SANDBOX=false
   DRIVER=~httpx+~websockets

   📖 参考官方文档：

   • NoneBot2 - .env 文件
   • QQGuild - 配置

4. 安装本插件

关于插件名 nonebot-plugin-mystool 中的下划线 _ 与 - 的区别：
安装命令可以使用下划线 _ 或者 -，例如 nonebot-plugin-mystool
但是在配置文件中需要使用下划线 _，例如 nonebot_plugin_mystool

方法一、通过脚手架

安装

nb plugin install nonebot-plugin-mystool

卸载

nb plugin uninstall nonebot-plugin-mystool

方法二、通过 PyPI

安装

1. 如果设置了虚拟环境，请先激活虚拟环境

   # Linux / macOS
   source .venv/bin/activate

2. 终端使用命令

   pip install nonebot-plugin-mystool

3. 修改机器人目录的 pyproject.toml 文件

   # ...
   [tool.nonebot]
   # ...
   plugins = []
   # ...

   ⬇️ 在 [tool.nonebot] plugins 中添加 "nonebot_plugin_mystool" ⬇️

   # ...
   [tool.nonebot]
   # ...
   plugins = ["nonebot_plugin_mystool"]
   # ...

卸载

1. 如果设置了虚拟环境，请先激活虚拟环境

   # Linux / macOS
   source .venv/bin/activate

2. 终端使用命令

   pip uninstall nonebot-plugin-mystool

3. 修改机器人目录的 pyproject.toml 文件

   # toml
   [tool.nonebot]
   plugins = ["nonebot_plugin_mystool"]

   ⬇️ 在 [tool.nonebot] plugins 中删除 "nonebot_plugin_mystool" ⬇️

   # toml
   [tool.nonebot]
   plugins = []

方法三、下载源代码放入指定目录

安装

1. 下载源代码

• 可通过GitHub项目页面的 Code 按钮可下载主分支（一般情况下和发行版差别不大）源代码的压缩包，或使用以下链接下载：
  https://github.com/Ljzd-PRO/nonebot-plugin-mystool/archive/refs/heads/stable.zip
  下载 dev 分支的源代码压缩包（一般情况下是处于开发状态的分支，有最新修改但不稳定）：
  https://github.com/Ljzd-PRO/nonebot-plugin-mystool/archive/refs/heads/dev.zip

• 可通过 git 命令克隆仓库：

  git clone https://github.com/Ljzd-PRO/nonebot-plugin-mystool.git

  切换至 dev 分支（一般情况下是处于开发状态的分支，有最新修改但不稳定）：

  git checkout dev

• 可在 release 页面下载发行版源代码压缩包（与 PyPI 代码相同）
  找到你需要的版本，在 Assets 下点击 Source code (zip) 下载

2. 修改机器人目录的 pyproject.toml 文件

设置好 [tool.nonebot] plugin_dirs，如果默认已经指定了目录，可跳过此步骤
在 [tool.nonebot] plugins 中删除 "nonebot_plugin_mystool"（如果存在的话）

# toml
[tool.nonebot]
plugins = []
plugin_dirs = ["src/plugins"]

3. 将源代码放入指定目录

将插件项目目录下的 src/nonebot_plugin_mystool 源代码目录放入机器人工作目录下的 src/plugins 目录中

如果你在上一步指定了其他目录，请放入相应的目录

卸载

删除机器人工作目录下的 src/plugins/nonebot_plugin_mystool 目录

6. 启动机器人

• 在机器人工作目录下，执行

  nb run

• 如果你使用了 OneBot V11 + go-cqhttp，还需要启动 go-cqhttp

  go-cqhttp