npm v1.0.1 Koishi ^4.17.0

koishi-plugin-zimage

基于魔搭社区 API 的 Koishi AI 画图插件，支持 Z-Image 系列模型，让你的机器人拥有强大的 AI 绘画能力

2 AI 模型

7 图片尺寸

∞ 创作可能

Terminal

# 安装插件
npm install koishi-plugin-zimage

# 或在 Koishi 插件市场搜索
zimage

# 开始使用
> 画图 一只可爱的猫咪
在画了喵
🎨 [图片已生成]

功能特性

强大的 AI 画图能力，丰富的自定义选项

双模型支持

支持 Z-Image 和 Z-Image-Turbo 两种模型，满足不同场景需求

多种尺寸

支持 7 种图片尺寸，包括正方形、竖版、横版、宽屏等

自定义步长

可调整生成步长，平衡质量与速度

次数限制

支持每日调用次数限制，合理控制使用量

自定义提示语

所有提示语均可自定义，打造个性化体验

Docker 适配

完美支持 Docker 环境，一键部署

安装方法

多种安装方式，选择最适合你的

打开 Koishi 控制台

登录你的 Koishi 实例管理后台

进入插件市场

点击左侧菜单的「插件市场」

搜索并安装

搜索 zimage 并点击安装

手动安装

# 进入 Koishi 的 node_modules 目录
cd /path/to/koishi/node_modules

# 克隆插件
git clone https://github.com/yxl826/koishi-plugin-zimage.git

# 进入目录并安装依赖
cd koishi-plugin-zimage
npm install

# 重启 Koishi

Docker 安装

# 复制插件到容器
docker cp koishi-plugin-zimage <容器名>:/koishi/node_modules/

# 进入容器安装依赖
docker exec -it <容器名> sh
cd /koishi/node_modules/koishi-plugin-zimage
npm install
exit

# 重启容器
docker restart <容器名>

配置说明

灵活的配置选项，满足各种需求

配置示例

~zimage:
  apiKey: ms-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  defaultModel: z-image-turbo
  defaultSize: 1024x1024
  defaultSteps: 8
  dailyLimit: 100
  pollInterval: 3000
  maxPollTime: 120000
  msgGenerating: '在画了喵'
  msgError: '发生错误了喵'
  msgLimitReached: '今天的画图次数用完啦喵，明天再来吧'
  msgNoPrompt: '请输入描述喵，例如：画图 一只猫咪'
  msgSuccess: '喵'

必填配置

apiKey 魔搭 API Key

生成配置

`defaultModel`	默认: z-image-turbo
`defaultSize`	默认: 1024x1024
`defaultSteps`	默认: 8

提示语配置

`msgGenerating`	在画了喵
`msgError`	发生错误了喵
`msgSuccess`	喵

使用方法

简单易用的命令系统

基本命令

画图一只可爱的猫咪 生成图片

画图 -m z-image 夕阳风景 指定模型

画图 -s 1344x768 未来城市 指定尺寸

画图 -t 30 山水画 指定步长

画图模型 查看/设置模型

画图状态 查看调用次数

可用尺寸

尺寸	方向	用途
`1024x1024`	正方形	通用
`768x1344`	竖版	手机壁纸
`1344x768`	横版	电脑壁纸
`1440x720`	宽屏	横幅/封面

模型选择

两种模型，满足不同场景

z-image-turbo

快速模型，速度优先

推荐步长: 8
生成速度快
适合日常使用

z-image

标准模型，质量优先

推荐步长: 20-50
生成质量高
适合精细创作

常见问题

遇到问题？这里可能有答案

提示 "Invalid model id"

确保模型名称正确，可用模型：z-image-turbo、z-image

生成超时怎么办？

可能是网络问题或服务器繁忙，可以尝试增加 maxPollTime 配置值

提示 API 错误

检查 API Key 是否正确，是否还有调用额度

如何获取魔搭 API Key？

访问 modelscope.cn 注册账号，进入"我的 AccessToken"创建 API Key

支持哪些平台？

支持所有 Koishi 支持的平台，包括 QQ、微信、Telegram、Discord 等