这是一个 nonebot2 插件项目的模板库, 你可以直接使用本模板创建你的 nonebot2 插件项目的仓库
模板库使用方法:
- 点击仓库中的 "Use this template" 按钮, 输入仓库名与描述, 点击 " Create repository from template" 创建仓库
- 在创建好的新仓库中, 在 "Add file" 菜单中选择 "Create new file", 在新文件名处输入
LICENSE, 此时在右侧会出现一个 "Choose a license template" 按钮, 点击此按钮选择开源协议模板, 然后在最下方提交新文件到主分支 - 全局替换
owner为仓库所有者ID; 全局替换nonebot-plugin-example为插件名; 全局替换nonebot_plugin_example为包名; 修改 python 徽标中的版本为你插件的运行所需版本 - 修改 README 中的插件名和插件描述, 并在下方填充相应的内容
这里是插件的详细介绍部分
nb-cli安装, 包管理器安装 二选一
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-example
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行,
根据你使用的包管理器, 输入相应的安装命令
pip
pip install nonebot-plugin-example
pdm
pdm add nonebot-plugin-example
poetry
poetry add nonebot-plugin-example
conda
conda install nonebot-plugin-example
打开 bot项目下的 pyproject.toml 文件,
在其 plugins 里加入 nonebot_plugin_example
plugins = ["nonebot_plugin_example"]
在 nonebot2 项目的.env文件中添加下表中的必填配置
| 配置项 | 必填 | 默认值 | 说明 |
|---|---|---|---|
| 配置项1 | 是 | 无 | 配置说明 |
| 配置项2 | 否 | 无 | 配置说明 |
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|---|---|---|---|---|
| 指令1 | 主人 | 否 | 私聊 | 配置说明 |
| 指令2 | 群员 | 是 | 群聊 | 配置说明 |
| 指令 | 权限 | 需要@ | 范围 | 说明 | |
|---|---|---|---|---|---|
| 指令1 | 主人 | 否 | 私聊 | 配置说明 | |
| 指令2 | 群员 | 是 | 群聊 | 配置说明 | |
如果有效果图的话