Skip to content

根据源仓库修改自用的 NoneBot2 插件模板库

License

Notifications You must be signed in to change notification settings

lgc-NB2Dev/nonebot-plugin-template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-example

✨ NoneBot 插件简单描述 ✨

python pdm-managed wakatime
Pydantic Version 1 Or 2 license pypi pypi download
NoneBot Registry Supported Adapters

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

模板库使用方法:

  1. 点击仓库中的 Use this template 按钮, 输入仓库名与描述, 点击 Create repository from template 创建仓库
  2. 全局替换 owner 为仓库所有者 ID;
    全局替换 nonebot-plugin-example 为插件名;
    全局替换 nonebot_plugin_example 为包名;
    修改 python 徽标中的版本为你插件的运行所需版本;
    替换 WakaTime 的徽标
  3. 修改 README.md 中的插件名和插件描述, 并在下方填充相应的内容

📖 介绍

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

💿 安装

以下提到的方法 任选其一 即可

[推荐] 使用 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

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分的 plugins 项里追加写入

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

⚙️ 配置

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

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

🎉 使用

指令表

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

效果图

如果有效果图的话

📞 联系

QQ:3076823485
Telegram:@lgc2333
吹水群:1108636125
邮箱:[email protected]

💡 鸣谢

如果有要鸣谢的人的话

💰 赞助

赞助我

感谢大家的赞助!你们的赞助将是我继续创作的动力!

📝 更新日志

芝士刚刚发布的插件,还没有更新日志的说 qwq~

About

根据源仓库修改自用的 NoneBot2 插件模板库

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%