Skip to content

lgc-NB2Dev/nonebot-plugin-pjsk

Repository files navigation

NoneBotPluginLogo

NoneBotPluginText

NoneBot-Plugin-PJSK

✨ Project Sekai 表情包制作 ✨

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

💬 前言

  • 由于本人没玩过啤酒烧烤, 可能出现一些小问题,可以提 issue 或者 加群反馈 或者单纯进来玩
  • 本项目仅供学习使用,请勿用于商业用途,喜欢该项目可以 Star 或者提供 PR,如果构成侵权将在 24 小时内删除

📖 介绍

Wonderhoy!

Wonderhoy

💿 安装

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

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

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

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

⚙️ 配置

插件开箱即用,所有配置项皆为可选。请按需添加下面的配置项到 .env 文件中

配置项 必填 默认值 说明
PJSK_ASSETS_PREFIX ... TheOriginalAyaka/sekai-stickers 仓库 GitHubUserContent 地址列表
PJSK_REPO_PREFIX ... 本仓库 GitHubUserContent 地址列表
PJSK_HELP_AS_IMAGE True 是否将帮助信息渲染为图片发送
PJSK_REPLY True 是否回复消息发送者
PJSK_REQ_RETRY 1 插件请求 URL 时的重试次数
PJSK_REQ_PROXY None 插件下载资源时使用的代理
PJSK_USE_CACHE True 是否缓存插件生成的所有图片
PJSK_CLEAR_CACHE False 是否在插件启动时清空缓存文件夹,禁用时只会清理非表情包的图片缓存

🎉 使用

直接使用指令 pjsk 进入交互创建模式;
使用指令 pjsk -h 了解使用 Shell-Like 指令创建表情的帮助

效果图

使用交互创建模式

example

使用 Shell-Like 指令

example

📞 联系

Agnes Digital

QQ 群: 424506063

student_2333

QQ:3076823485
Telegram:@lgc2333
吹水群:1105946125
邮箱:lgc2333@126.com

💡 鸣谢

  • 原项目 & 素材来源

💰 赞助

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

Agnes Digital

student_2333

📝 更新日志

0.4.0

  • 适配 Pydantic V1 & V2

0.3.1

  • 修复无法生成图片的 Bug

0.3.0

  • 重构插件:
    • 弃用 imagetext-pyPillow,改用 htmlrender 渲染 svg(表情) 与 html(总览、帮助)
    • 弃用 saa,换用 alconna
  • 配置项更改:
    • 添加 PJSK_USE_CACHEPJSK_CLEAR_CACHE
    • 移除 PJSK_EMOJI_SOURCEPJSK_STICKER_FORMAT
    • PJSK_REQ_RETRY 默认值 从 2 改为 1
    • PJSK_ASSETS_PERFIXPJSK_REPO_PREFIX 默认值 删除 ghproxy

0.2.10

  • 修复指定保存格式无效的 Bug
  • 添加指令参数 --auto-adjust-A
  • 其他小修改

0.2.9

  • 指令参数增加与变更:
    • 修改 --line-spacing 参数简写为 -S
    • 增加 --stroke-color-C)参数
    • 增加 --font-color-c)参数
    • 增加 --format-f)参数
  • 配置项增加与变更:
    • 增加 PJSK_REQ_RETRYPJSK_REQ_PROXYPJSK_STICKER_FORMAT
    • 修改 PJSK_ASSETS_PREFIXPJSK_REPO_PREFIX 类型为 List[str]
  • 其他小修复,小优化

0.2.8

  • 修复无法自定义表情源的 bug

0.2.7

  • 修复参数为 0 时不生效的 Bug
  • 现在可以关闭回复消息发送者的特性了
  • 命令参数调整:
    • 删除 --weight 参数,因为没有实际意义
    • --rotate 参数可以接受小数了
    • --stroke-width 参数添加简写 -W
    • --line-spacing 参数添加简写 -C

0.2.6

  • 插件会按角色名重新排序表情列表与表情 ID,以防数据源表情 ID 冲突
  • 角色列表名称展示优化

0.2.5

  • 使用自己合并的字体文件避免某些字不显示的问题

0.2.4

  • 在交互模式中提供的参数会去掉指令前缀,以防 Adapter 删掉参数开头的 Bot 昵称,导致参数不对的情况
  • 重写帮助图片的渲染(个人感觉效果还不是很好……)

0.2.3

  • 限制了贴纸文本大小,以免 Bot 瞬间爆炸
  • 未提供字体大小时适应性调节 (#14)
  • 参数 --rotate 改为提供角度值,正数为顺时针旋转
  • 将指令帮助渲染为图片发送(可以关)
  • 丢掉了 pil-utils 依赖

0.2.2

  • 修改了 0.2.1 版的交互创建模式的触发方式
  • 试验性地支持了 Emoji

0.2.1

  • 更改指令 pjsk列表 的交互方式

0.2.0

  • 重构插件