nonebot-plugin-pcr-sign 0.3.2

nonebot_plugin_hoshino_sign 的重置版

nonebot-plugin-pcr-sign

✨ pcr签到 集印章/邮戳 ✨

📖 介绍

一个从 一个从 hoshino 抄借鉴的 nonebot2 签到插件nonebot-plugin-hoshino-sign 抄借鉴的 nonebot2 签到插件

💿 安装

[!TIP] 想要启用 CLI 数据迁移功能，需安装 nonebot-plugin-pcr-sign[cli]

使用 nb-cli 安装

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

nb plugin install nonebot-plugin-pcr-sign

使用包管理器安装

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

pip

pip install nonebot-plugin-pcr-sign

pdm

pdm add nonebot-plugin-pcr-sign

poetry

poetry add nonebot-plugin-pcr-sign

conda

conda install nonebot-plugin-pcr-sign

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

plugins = ["nonebot_plugin_pcr_sign"]

⚙️ 配置

配置表

在 nonebot2 项目的.env文件中修改配置项

配置项	必填	默认值	说明
sign_argot_expire_time	否	300	暗语过期时间（单位：秒 类型：int）
stamp_path	否	RES_DIR / "stamps"	印章图片路径
sign_background_source	否	"default"	签到背景图来源
album_background_source	否	"default"	收集册背景图来源

background_source

sign_background_source 为签到背景图来源，可选值为字面量 default / LoliAPI / Lolicon / random 或者结构 CustomSource 。LoliAPI 和 Lolicon 均为网络请求获取随机背景图，random为从默认签到背景目录中随机, CustomSource 用于自定义背景图。 默认为 default。

album_background_source 为收集册背景图来源，可选值为字面量 default / kraft / pcr / prev / random 或者结构 CustomSource 。前四者均为预设背景，random为从默认收集册背景目录中随机，CustomSource 用于自定义背景图。 默认为 default。

以下是 CustomSource 用法

在配置文件中设置 xxx_background_source 为 CustomSource结构的字典

CustomSource配置示例

• 网络链接

  • uri 可为网络图片 API，只要返回的是图片即可
  • uri 也可以为 base64 编码的图片，如 data:image/png;base64,xxxxxx （一般也没人这么干）

sign_background_source = '{"uri": "https://example.com/image.jpg"}'

• 本地图片

[!TIP]

• uri 也可以为本地图片路径，如 imgs/image.jpg、/path/to/image.jpg
• 如果本地图片路径是相对路径，会使用 nonebot-plugin-localstore 指定的 data 目录作为根目录
• 如果本地图片路径是目录，会随机选择目录下的一张图片作为背景图

sign_background_source = '{"uri": "/imgs/image.jpg"}'

🎉 使用

[!NOTE] 记得使用命令前缀哦

🪧 指令表

指令	权限	参数	说明
sign/签到/盖章/妈	所有	无	签到
album/收集册	所有	无 or @	查看自己（或别人）的收集册

🫣 暗语表

[!NOTE] 🧭 暗语使用指北

暗语消息来自 nonebot-plugin-argot 插件

对暗语对象回复对应的暗语指令即可获取暗语消息

暗语指令	对象	说明
background	签到图	查看背景图
stamp	签到图	获取印章图
raw	签到图	获取原文字消息

[!TIP] 注意暗语消息有过期时间，默认 5min 后失效，可通过配置修改

📸 效果图

🐾 签到图

🎞️ 收集册

🚚 迁移

如果有从nonebot-plugin-hoshino-sign迁移数据到本插件的需求

请使用 pip install nonebot-plugin-pcr-sign[cli] 安装所需依赖

或uv add nonebot-plugin-pcr-sign[cli]什么的，总之加上[cli]，别那么死板

nonebot-plugin-hoshino-sign 的默认数据目录为 "./data/nonebot_plugin_hoshino_sign/"

目录结构如下：

• 数据根目录
  • json
    • goodwill.json
  • db
    • pcr_stamp.db

运行 nb pcr migrate 进行迁移,默认会指向该路径寻找旧数据文件

如果旧数据在其他路径保存，可以使用 nb pcr migrate -d <path> 指定数据文件根路径

例如：nb pcr migrate -d ./data/sign/

[!TIP] 运行一次成功就好了哦! 重复执行迁移会导致用户好感度再被加一次的（

旧数据的用户好感度会累加到已有数据中

💖 鸣谢

• KomoriDev: 优秀的界面风格和设计理念学习
• nonebot-plugin-hoshino-sign：灵感来源
• SonderXiaoming/login_bonus: 灵感来源的来源
• GWYOG-Hoshino-plugins: 灵感来源的来源的来源
• 公主连结吧: 印章素材来源
• nonebot-plugin-argot: 优秀的 NoneBot2 暗语支持
• nonebot-plugin-htmlrender: 优秀的 NoneBot2 HTML 渲染支持
• nonebot-plugin-orm: 优秀的 NoneBot2 数据库支持

📋 TODO

• 数据迁移脚本(从原hoshino_sign插件迁移数据)
• 待补充,欢迎pr