Skip to content

cubstaryow/nonebot-plugin-HelpWithPic

Repository files navigation

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-HelpWithPic

✨ nonebot插件-动态帮助图片制作 ✨

license pypi python

⚠ 注意

因为我是小白,我只能以我自己的方式写我觉得可能挺好用的插件() 所以部分代码逻辑可能不是很好

目前只支持 onebotV11 暂时还未上传nonebot商店 将在正式版尝试上传.

📖 介绍

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

💿 安装

使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-HelpWithPic
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip
pip install nonebot-plugin-HelpWithPic
pdm
pdm add nonebot-plugin-HelpWithPic
poetry
poetry add nonebot-plugin-HelpWithPic
conda
conda install nonebot-plugin-HelpWithPic

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

plugins = ["nonebot_plugin_HelpWithPic"]

⚙️ 配置

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

大小写不影响配置)

⚠ 注意

部分 pydantic 版本可能会导致 HWP_custom_bg 项目报错!

配置项 必填 默认值 说明
HWP_font None 使用的字体文件
HWP_custom_bg [] 图片背景,需要以file:///开头,比如["file:///./data/draw/default_bg1.png"]此处使用相对路径,默认使用bing壁纸
HWP_bot_version "Unknow" 可以填你的bot版本
HWP_commandstart "#" 自定义命令头
HWP_nickname "本bot的帮助文档" 标题
HWP_text "你想要的,我们都没有(不是\n这是描述" 描述
HWP_version "HelpWithPic-Betaxxx" 插件版本
cubplugin_datadir "" 插件数据文件夹
hwp_addseparator "\n" helpadd的命令分割符,默认为回车
hwp_txt_halign "left" 描述文本对齐方式 left / center / right

🎉 使用

指令表

指令 权限 需要@ 范围 说明
#help user 群聊/私聊 请根据HWP_commandstart使用