nonebot-plugin-random 0.0.6

Nonebot2 通用抽图/语音插件

nonebot-plugin-random

✨ Nonebot2 通用抽图/语音插件 ✨

📖 介绍

如果只是想简单做个抽图或者抽语音的功能，不需要自己写多余的代码

只需要安装本插件，在对应路径放好相关资源并配置好即可

💿 安装

插件仍在开发中，遇到问题还请务必提 issue。

使用 nb-cli 安装

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

nb plugin install nonebot-plugin-random

使用包管理器安装

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

pip

pip install nonebot-plugin-random

pdm

pdm add nonebot-plugin-random

poetry

poetry add nonebot-plugin-random

conda

conda install nonebot-plugin-random

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

nonebot.load_plugin('nonebot_plugin_random')

从 github 安装

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

git clone https://github.com/jcjrobert/nonebot-plugin-random.git

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

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

🎉 使用

机器人每次在重启时会创建（如果没有）并读取机器人运行目录下的 data/random/ 文件夹

然后依次读取每个文件夹，一个文件夹就是一个抽取功能

以随机capoo为例，你可以在 data/random 下创建capoo文件夹，然后把你喜欢的capoo图片放入文件夹

之后重启，使用命令 随机capoo 即可

可以在群里动态添加图片，使用命令 添加随机capoo + 图片 + 图片名（可选） 即可，可以回复添加，目前任何人都能添加，后面会加上权限管理

目前不能动态添加文件夹，需要手动添加并重启，这点请注意

⚙️ 配置

如果你有自定义命令的需求，你可以在当前文件夹，以随机capoo为例

即data/random/capoo下添加config.json文件，然后按照下表进行配置并重启

配置项	必填	默认值	说明
"draw_output"	否	"image"	抽取输出类型，有"image"/"record"
"message_type"	否	"command"	命令响应类型，"command"即on_command，"keyword"即on_keyword, "regex"即on_regex
"message"	否	["随机当前文件夹文件名"]	自定义命令，必须是列表，若"message_type"为"keyword"时只取第一项，为"regex"时必须为两项，第一项是正则表达式，第二项是匹配表达式的命令
"insert_message"	否	["添加随机当前文件夹文件名"]	自定义添加图片命令，必须是列表，仅"message_type"为"command"且"message_type"为"image"时有效
"is_tome"	否	false	使用抽取命令时是否需要at机器人
"output_prefix"	否	""	输出前缀，"draw_output"为"record"下该配置无效
"output_suffix"	否	""	输出后缀，"draw_output"为"record"下该配置无效
"is_at_sender"	否	false	机器人发消息时是否需要at发送者，"draw_output"为"record"下该配置无效

指令表

指令	说明
随机XX	指令可见上述配置
随机XX + 文件名	仅在"message_type"为"command"时生效，指定文件名字（搜索第一个开头为指定名称的文件，可包括后缀）
添加随机XX + 图片名	仅在"message_type"为"command"且"message_type"为"image"时生效，添加指令可自定义，可添加数张图片，空格隔开可以分别对图片命名，可以回复添加，图片名默认为当前时间的时间戳+自动判断图片的后缀

目前去除command前缀的手段非常暴力，直接遍历command并依次进行replace，进行自定义命令时需额外注意这点，如果有完美的解决方案欢迎提出issue或PR

支持的文件后缀

draw_output	suffix
image	gif,png,jpg,jpeg
record	mp3,wav,ogg

仅在上表的文件后缀才会被纳入随机抽取的列表当中，时间原因，只确认了这些后缀，如果有其他可以用的后缀欢迎提出issue或PR

📝 TODO LIST

• 对随机命令进行开关管理
• 添加图片权限管理
• 支持文本抽取
• 菜单生成
• 支持小视频抽取

📝 更新日志

展开/收起

0.0.6

• 支持动态添加图片（仅command）

0.0.5

• 支持根据文件名定向抽取文件（仅command）

0.0.4

• 去除draw_mode，现在可以抽取该文件夹下符合格式的全部文件
• 代码优化，分离config

0.0.3

• 支持正则命令匹配

0.0.2

• 修复未配置"message"时不能正常使用随机命令的bug
• 支持输出前后缀配置和at发送者

0.0.1

• 插件初次发布

💡 特别感谢

• noneplugin/nonebot-plugin-petpet Nonebot2 插件，用于制作摸头等头像相关表情包

其他

capoo资源欢迎加入交流群获取，日后可能会开放远程下载