nonebot-plugin-nailongremove/docs/tutorial.md
student_2333 84ea92cd5a
up
2024-11-07 19:34:21 +08:00

9.4 KiB
Raw Blame History

从零开始的面向小白的插件部署教程

1. 部署 Python 环境

如果你已经拥有自己心仪的 Python 环境,检查你的 Python 版本是否大于等于 3.9 即可

Warning

不建议下载最新的 Python 版本,因为可能有第三方库还没来得及适配最新版的 Python导致出现插件依赖相关问题

在下面的教程中,我们会下载最新版本的前一个大版本

Note

本人不喜欢 Conda 给系统上它的默认环境,所以下面不介绍如何使用 Conda

基于 Anaconda 虚拟环境可以参考:nailongremove 部署教程

1.1. Windows

访问 Python 官网 https://www.python.org,鼠标移到 Downloads 上,之后点击 All Releases

1.1-1

之后向下滚动到 Looking for a specific release 下寻找要下载的版本

在上张图片中可以看到当前最新的 Python 版本为 3.13.0,所以我们寻找最新的 3.12 版本下载

1.1-2

点进去之后向下滚找到 Windows installer (64-bit) 下载(现在的电脑一般是 X86 架构 CPU 加 64 位操作系统,如果是其他架构请自行下载对应架构的安装包)

1.1-3

下载完成后打开安装包(忽略这个是 3.11 版的安装界面)一定要记得勾选 Add python.exe to PATH 然后直接点击 Install Now 安装即可

如果要更改安装路径可以选择 Customize Installation 后自行更改后继续安装,注意安装路径最好不要有中文

1.1-4

打开终端Win + R 输入 powershell 回车),输入以下内容回车验证 Python 是否安装成功

python -V

1.1-5

1.2. Linux

在 Linux 环境下我们使用 pyenv 来管理系统中的 Python

在命令行中输入以下命令回车安装:

curl https://pyenv.run | bash

然后执行下面的命令来向 shell 配置中写入 pyenv 的环境变量相关配置(如果你使用的不是 bash请自行替换文件名

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(pyenv init -)"' >> ~/.bashrc

执行以下命令重载 shell 配置(其他 shell 请自行修改文件名)

source ~/.bashrc

现在你应该可以使用 pyenv 了

pyenv -v

1.2-1

按照 Wiki 中 Suggested build environment 部分 根据你所使用的发行版安装好所需依赖,如下面是 Ubuntu / Debian / Linux Mint 发行版所需执行的命令

1.2-2

装好依赖后开始安装 Python执行下面的命令安装 Python 3.12

pyenv install 3.12

稍等片刻安装好后,设置 Python 3.12 为 shell 中的默认 Python

pyenv global 3.12

验证是否安装成功

python -V

(忽略这里的 Python 版本为 3.11 1.2-3

2. 部署 NoneBot

在这里我们使用我开发的 nb-cli-plugin-bootstrap 来创建 NoneBot2 项目

先找一个心仪的目录来放置你的 NoneBot2 项目,注意路径中最好不要存在中文

Windows 用户在资源管理器中单击地址栏后输入 powershell 回车即可打开命令行(忽略我输入的是 pwsh,如图

2-1

首先安装 nb-clinb-cli-plugin-bootstrap,输入以下命令回车

pip install nb-cli nb-cli-plugin-bootstrap

安装完成后输入以下内容回车开始创建项目

nb bs

项目名称为创建项目后的文件夹名称

选择适配器时,使用键盘上下键将左侧箭头指向 OneBot V11 适配器(如果你要对接野生 QQ 机器人),之后 按一下空格 选中该适配器
这步一定要记得按空格选中你要安装的适配器!!!选中后左侧圆圈会变成实心,该项也会亮起,请注意区分!!

2-2

剩余选项根据你的喜好填写即可,如果不想自定义可以一直回车使用默认设置
建议修改一下端口号避免由于端口被占用导致 NoneBot 无法启动

部分设置后续可以通过 .env.prod 文件修改,使用任意文本编辑器打开查看详细信息
之后的插件配置也需要填写到此文件中

安装完成后如图

2-3

3. 安装插件

接上一步操作,在命令行中输入下面的命令将工作目录切换到你创建好的项目目录中
或者在资源管理器中打开项目文件夹后单击地址栏输入 powershell 回车打开新的命令行窗口

cd 项目名

之后输入下面的命令来安装本插件

nb plugin install nonebot-plugin-nailongremove

安装过程如图

3-1
3-2

4. 模型相关配置

接上一节,先进入虚拟环境,进入虚拟环境后命令行左侧应该会多出来你虚拟环境的名字

nb sh

接下来介绍安装完插件后要使用对应模型所需要额外做的一些操作

4.1. 模型 1默认

如果想要使用默认的模型 1为了避免一些问题onnxruntime 没有包括在插件配置里自动安装,你需要手动安装

CPU 运行

直接运行下面命令安装 onnxruntime 即可

pip install onnxruntime

GPU 运行

首先安装 onnxruntime-gpu

pip install onnxruntime-gpu

检查你安装的 onnxruntime-gpu 版本,对照 这里 检查你安装的版本需要的 CUDA 和 cuDNN 版本,如果没有安装则需要自行安装(教程待补充)

最后更改插件配置项,让 onnxruntime 使用 CUDA 运行(NoneBot 配置简单介绍看这里

NAILONG_ONNX_PROVIDERS=["CUDAExecutionProvider"]

4.2. 模型 0

如果想要使用模型 0按照下面的操作来安装额外依赖

再安装额外依赖

pip install "nonebot-plugin-nailongremove[model0]"

安装过程如图

4.2-1
4.2-2

5. 启动 NoneBot

在命令行中输入以下命令并回车启动 NoneBot

nb run

Windows 下也可以直接双击 #启动.bat
Linux 下也可以使用 ./#run.sh

NoneBot启动

启动完成并且没问题的话,应该像下面这样,没有任何报错

5-1

6. 配置野生 QQ 机器人协议端连接 NoneBot

如果你想对接其他聊天平台(在第二步时安装了其他的适配器),请略过这节并自行查看对应平台适配器的文档,见 适配器商店

请在以下协议实现中选择其中一个你心仪的开始使用即可

6.1. Lagrange.OneBot

下载安装步骤参见 NoneBotX 社区文档

注:首次启动生成配置文件(appsettings.json)后建议先在配置文件中把 Bot 的 QQ 号先填好,参考下面配置,把其中的 0 替换为你 Bot 的 QQ 号,密码不填使用扫码登录

{
  // ...
  "Account": {
    "Uin": 0,
    "Password": ""
    // ...
  }
  // ...
}

安装好后修改其配置文件使其以反向 Websocket 连接到 NoneBot 即可,参考下面配置,记得把下面 Port 后的 8080 修改成你之前配置的端口号

{
  // ...
  "Implementations": [
    {
      "Type": "ReverseWebSocket",
      "Host": "127.0.0.1",
      "Port": 8080,
      "Suffix": "/onebot/v11/ws",
      "ReconnectInterval": 5000,
      "HeartBeatInterval": 5000,
      "HeartBeatEnable": true,
      "AccessToken": ""
    }
  ]
}

6.2. NapCat

基于 QQNT 本体的协议实现,需要安装 QQNT 客户端,但可以以无头(无图形界面)方式启动

下载安装步骤参见 NapCat 文档

安装好后修改其配置文件使其以反向 Websocket 连接到 NoneBot 即可,参考下面配置,记得把下面的 8080 修改成你之前配置的端口号

{
  // ...
  "wsReverse": {
    "enable": true,
    "urls": ["ws://127.0.0.1:8080/onebot/v11/ws"]
  }
  // ...
}

7. 后续

7.1. 修改插件配置项

参考 NoneBot 文档 DotEnv 配置 一节 的文件格式,修改 .env.prod 文件即可

例:如果我想修改 NAILONG_MODEL 配置为 1,则在 .env.prod 配置中按如下格式修改

NAILONG_MODEL=1

7.1-1

多行配置项例子:

NAILONG_MODEL1_SCORE='
{
  "nailong": 0.75,
  "htgt": 0.75
}
'
NAILONG_TIP='
{
  "nailong": "本群禁止发奶龙!",
  "htgt": "疑似奶龙尸块"
}
'

7.1-2

7.2. 更新插件

在 Bot 项目目录下打开命令行,之后执行下面命令即可

nb plugin update nonebot-plugin-nailongremove

7.3. 常见问题

常见问题请跳转至 issues