novabot-plugin-example

✨ NovaBot 插件简单描述 ✨

这是一个 Nova-Bot 插件项目的模板库, 你可以直接使用本模板创建你的 Nova-Bot 插件项目的仓库

模板库使用方法:

1. 点击仓库中的 "Use this template" 按钮, 输入仓库名与描述, 点击 " Create repository from template" 创建仓库
2. 在创建好的新仓库中, 在 "Add file" 菜单中选择 "Create new file", 在新文件名处输入LICENSE, 此时在右侧会出现一个 "Choose a license template" 按钮, 点击此按钮选择开源协议模板, 然后在最下方提交新文件到主分支
3. 全局替换owner为仓库所有者ID; 全局替换novabot-plugin-example为插件名; 全局替换novabot_plugin_example为包名; 修改 python 徽标中的版本为你插件的运行所需版本
4. 修改 README 中的插件名和插件描述, 并在下方填充相应的内容

📖 介绍

这里是插件的详细介绍部分

💿 安装

使用 nb-cli 安装

在 Nova-Bot 项目的根目录下打开命令行, 输入以下指令即可安装

nb plugin install novabot-plugin-example

使用包管理器安装

在 Nova-Bot 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

pip

pip install novabot-plugin-example

pdm

pdm add novabot-plugin-example

poetry

poetry add novabot-plugin-example

conda

conda install novabot-plugin-example

打开 Nova-Bot 项目的 bot.py 文件, 在其中写入

nonebot.load_plugin('novabot_plugin_example')

从 github 安装

在 Nova-Bot 项目的插件目录下, 打开命令行, 输入以下命令克隆此储存库

git clone https://github.com/owner/novabot-plugin-example.git

打开 Nova-Bot 项目的 bot.py 文件, 在其中写入

nonebot.load_plugin('src.plugins.novabot_plugin_example')

⚙️ 配置

在 Nova-Bot 项目的.env文件中添加下表中的必填配置

配置项	必填	默认值	说明
配置项1	是	无	配置说明
配置项2	否	无	配置说明

🎉 使用

指令表

指令	权限	需要@	范围	说明
指令1	主人	否	私聊	配置说明
指令2	群员	是	群聊	配置说明

效果图

如果有效果图的话