Skip to content

README_CN.md

Latest commit

 

History

History
144 lines (103 loc) · 4.55 KB

README_CN.md

File metadata and controls

144 lines (103 loc) · 4.55 KB

Draw Things for AI Agents (面向 AI 代理的本地图像生成接口)

English Version

这是一个为 AI Agent (包括 OpenClaw, Claude, Gemini CLI, OpenCode 等) 开发的高性能 Node.js 接口，旨在连接并管理 macOS 上的 Draw Things 官方 gRPC 后端，实现本地 AI 图像生成。

该技能将 Draw Things 的专业级本地生成能力转化为“AI 原生 (AI-native)”的 CLI 接口，方便各类支持工具调用的 AI 代理直接使用。

🤖 AI 代理集成 (AI Agent Integration)

该工具包提供两种主要方式将你的 AI 代理连接到 Draw Things：

1. MCP 协议 (Model Context Protocol) —— 最佳实践 (The Golden Path)

适用于 Claude Desktop, Cursor, Zed 等现代 AI 客户端。这会将 Draw Things 变成这些客户端中的“原生工具”。如果你的 AI 代理支持 MCP，这是进行图像生成的首选且唯一的接口。

全局安装:

npm install -g @mijuu/drawthings

Claude Desktop 配置: 在你的 claude_desktop_config.json 中添加：

{
  "mcpServers": {
    "drawthings": {
      "command": "dt-mcp"
    }
  }
}

2. OpenClaw / Gemini CLI 技能

对于 OpenClaw 用户，在你的技能目录中安装：

cd ~/.openclaw/skills
# 推荐：如果你想使用仓库进行开发：
git clone https://github.com/mijuu/drawthings-agent.git drawthings
cd drawthings && npm install

🚀 核心特性

  • 集中式 CLI：强大的 dt-skill 命令，集成了生成、配置和服务器管理功能。
  • 自动探测：自动识别 macOS 上 Draw Things 的标准模型存储路径。
  • 内存优化：针对 4K/8K 大图传输进行了深度优化，内存占用极低。
  • 纯 Node.js 实现：无需 Python 或外部图像处理脚本。
  • 高性能：采用 gRPC 协议进行 low-latency 通信，并使用 FlatBuffers 进行高效的二进制序列化。
  • 安全可靠：全面支持 SSL/TLS 加密，并内置了 Draw Things 根证书（Root CA）。
  • 快速生成：针对 "Turbo" 模型（如 SDXL Turbo, Flux）进行了优化，支持实时生成进度更新。

🛠️ 前置条件

  • macOS：Draw Things 是一款 macOS 原生应用。
  • Draw Things App：已安装并下载了所需的模型。
  • gRPCServerCLI (可选，用于后台运行模式)：从 官方 Release 页面 下载。
  • Node.js：版本 16 或更高。
  • 重要设置：在 Draw Things 的设置中，禁用 "Response Compression" (响应压缩) (也称为 FPY)。该脚本目前不支持 FPY 压缩的张量.

📦 安装说明

通过 npm 全局安装：

npm install -g @mijuu/drawthings

如果你克隆了仓库进行本地开发：

# 在项目目录中执行
npm install

安装完成后，即可使用 dt-skill 命令。

⚙️ 配置

该技能使用集中式配置系统，设置存储在 ~/.drawthings-skill/config.json 中。

  1. 自动探测：如果你的模型在标准 macOS 沙盒路径中，技能会自动找到它们。
  2. 诊断检查：运行诊断命令查看你的环境状态： 
    dt-skill doctor
  3. 手动配置：如果需要，可以手动设置 gRPC 服务器路径： 
    dt-skill config --server-path "/你的/路径/gRPCServerCLI-macOS"

🚀 使用方法

1. 启动服务器

方式 A：直接使用 Draw Things App（最简单）

  1. 在你的 Mac 上打开 Draw Things 应用。
  2. 进入 Settings (设置) 并开启 gRPC Server。

方式 B：使用命令行（后台运行）

dt-skill server start

2. 生成图像

# 基础生成
dt-skill gen --prompt "清晨宁静的山湖" --output landscape.png

# 进阶用法 (使用 Turbo 模型, 2倍放大)
dt-skill gen --prompt "赛博朋克城市" --model z_image_turbo_1.0_q6p.ckpt --steps 8 --upscale 2

3. 工具命令

# 检查服务器健康状态
dt-skill server status

# 列出可用模型
dt-skill models

# 运行诊断检查
dt-skill doctor

📂 项目结构

  • scripts/cli.js：dt-skill 的主入口点。
  • scripts/generate.js：核心生成逻辑。
  • scripts/setup.js：配置管理逻辑。
  • scripts/imageService.proto：gRPC 服务定义。
  • references/：关于 gRPC 协议和采样器的详细文档。

🤝 贡献

欢迎提交贡献！请随时提交 Pull Request。

📜 许可证

MIT 许可证。详见 LICENSE。