README.md
June 6, 2026 · View on GitHub
✨ 特性 ✨
-
今日小猪: 抽取今天属于你的小猪类型 🐖
-
随机小猪: 从 PigHub 随机获取猪猪图 🐖
-
找猪: 从 PigHub 模糊搜索猪猪图 🐖
📦 安装方式 📦
使用 pip 安装:
pip install nonebot_plugin_rollpig
或者使用 nb-cli 安装:
nb plugin install nonebot_plugin_rollpig
或者直接 Download ZIP
🕹️ 使用方法 🕹️
今日小猪 (今日小猪) - 抽取今天属于你的小猪。
用法:今日小猪
随机小猪 (随机小猪) - 从PigHub随机获取一张猪猪图。
用法:随机小猪 [数量]
[数量]:可选参数,指定要抽取的猪猪数量,默认为 1,最大为 20。
找猪 (找猪) - 根据关键词查找猪猪。
用法:找猪 [关键词]
[关键词]:要查找的猪猪的关键词。
☁️ 云端资源同步 ☁️
插件默认会从云端同步小猪资源包,用于在不更新插件代码的情况下刷新 pig.json 与图片资源。
默认资源地址:
ROLLPIG_RESOURCE_SYNC_ENABLED=true
ROLLPIG_RESOURCE_MANIFEST_URL=https://pig.felislab.cc/resources/rollpig/manifest.json
ROLLPIG_RESOURCE_SYNC_INTERVAL_HOURS=24
如需关闭云端同步,可配置:
ROLLPIG_RESOURCE_SYNC_ENABLED=false
如需使用自己的资源站点,可将 ROLLPIG_RESOURCE_MANIFEST_URL 改为自己的 manifest.json 地址。
同步后的资源会缓存到本地,运行时优先使用本地缓存;云端不可用或资源校验失败时,会回退到插件内置资源。
超级用户可发送 同步小猪资源 或 刷新小猪图鉴 手动触发同步。
🐷 新增小猪 🐷
插件资源路径:
nonebot_plugin_rollpig/resource
- pig.json 小猪信息,例如:
[
{
"id": "pig",
"name": "猪",
"description": "普通小猪",
"analysis": "你性格温和,喜欢简单的生活,容易满足。在别人眼中可能有些慵懒,但你知道如何享受生活的美好。"
}
]
- image/ 小猪图片
- 图片命名需和信息中的
id一致 - 支持图片类型:
["png", "jpg", "jpeg", "webp", "gif"]
- 图片命名需和信息中的
📂 目录结构示例 📂
nonebot_plugin_rollpig/
├─ __init__.py
├─ resource/
│ ├─ pig.json
│ └─ image/
│ └─ pig.png
❗ 注意事项 ❗
- 新增小猪时只需在
pig.json添加对象,并将对应图片放到image/文件夹即可 🐷 - 图片自动按 id 匹配,无需在 JSON 中写图片后缀 🐖