Toonflow-app README

The project's README from github.com/HBAI-Ltd/Toonflow-app. As one markdown file: README.md.

GitHub  |  Gitee  |  Atomgit

简体中文 | 繁體中文 | English | ไทย | Tiếng Việt | 日本語 | Русский

Toonflow Logo

Typing SVG

Stars Badge Apache-2.0 License Badge release

Forks Badge AtomGit G-Star No.540 Discord

Issues Contributors Last Commit

TypeScript  Node.js  Docker  Electron

🚀 一站式短剧工程：从文本到角色，从分镜到视频，0门槛全流程AI化，创作效率提升10倍+！

AtomGit G-Star 认证证书 Gitee GVP 认证证书

🌐 多语言支持

Toonflow 支持以下语言界面：

语言 Language
简体中文 Chinese (Simplified)
繁體中文 Chinese (Traditional)
English English
ไทย Thai
Tiếng Việt Vietnamese
日本語 Japanese
Русский Russian

💡 更多语言适配中，欢迎贡献翻译！

🌟 主要功能

Toonflow 是面向短剧生产的 AI 工作台，围绕“策划 → 编剧 → 分镜 → 出片”构建完整闭环，并支持本地化、可编程、可持续迭代的生产流程。

📦 应用场景

🔰 使用指南

快速上手

  1. 启动应用并登录（默认账号：admin / admin123）。
  2. 在设置中心完成模型供应商配置（文本/图像/视频模型）。
  3. 新建项目并导入原著，执行章节事件提取。
  4. 进入 ScriptAgent 生成故事骨架、改编策略与结构化剧本。
  5. 切换到 ProductionAgent，在无限画布中组织分镜、素材与视频节点。
  6. 对分镜图进行节点化精调后回流工作台，完成视频拼接与导出。

📺 视频教程

https://www.bilibili.com/video/BV1oXD7BqEqJ Toonflow 12 分钟快速上手 AI 视频

Toonflow 12 分钟快速上手 AI 视频 👉 点击观看

📱 手机微信扫码观看

微信扫码观看

📸 演示截图与视频

以下截图及视频来自使用 Toonflow 制作的一段 AI 短剧 Demo，全程约 2 小时完成，涵盖剧本生成、分镜制作及剪辑环节。

🎬 Demo 视频

https://github.com/user-attachments/assets/2d9fddac-dfdf-4640-b030-b09d7f7287e9

如无法播放，请点击下载视频

Demo 信息

项目 详情
制作周期 约 2 小时
视频模型 Seedance 2.0
图片模型 GPT Image 2
语言模型 Claude Opus 4.6
成片总时长 约 2 分钟（原始素材 3 分钟，剪除废片约 1 分钟）

成本明细

模型类型 费用
语言模型 约 ¥10
视频模型（全量生成） 约 ¥120
图片模型 不足 ¥1
合计 约 ¥130

声明：Demo 原始分辨率为 1080×1882，发布版本已压缩至 480p。如涉及版权问题，请联系我们删除处理。

🚀 安装

前置条件

在安装和使用本软件之前，请准备以下内容：

本机安装

1. 下载与安装

操作系统 GitHub 说明
Windows Release 官方发布安装包
Linux Release 官方发布安装包
macOS Release 官方发布安装包

[!CAUTION] MacOS 系统请到 设置-隐私与安全性 配置安全性否则可能因证书问题无法正常打开

参考知乎文档：https://www.zhihu.com/question/433389276

因 Gitee OS 环境限制及 Release 文件上传大小限制，暂不提供 Gitee Release 下载地址。

2. 启动服务

安装完成后，启动程序即可开始使用本服务。

⚠️ 首次登录
账号：admin
密码：admin123

Docker 部署

前置条件

方式一：在线部署

待完善，暂时使用本地构建。

方式二：本地构建

使用本地已有的源码直接构建，适合开发者或已克隆仓库的用户，这需要你在本地安装 git：

# 先克隆项目（如已有则跳过）
git clone https://github.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app

# 使用 docker-compose 本地构建并启动
yarn docker:local

# 或者手动构建
docker build -t toonflow .
docker run -d -p <本地端口>:10588 -v <本地数据路径>:/app/data toonflow

# 此时在相应端口的 /web/index.html 路径即可访问页面
# 例如 http://localhost:10588/web/index.html

服务端口说明

端口 用途 部署映射
10588 软件界面 10588:10588

环境变量说明：

变量 说明
NODE_ENV 运行环境，prod 表示生产环境
PORT 服务监听端口（默认 10588）
OSSURL 文件存储访问地址，用于静态资源访问

云端部署

云服务器部署

一、服务器环境要求

二、服务器部署

1. 安装环境
# 安装 Node.js
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
source ~/.bashrc
nvm install 24
# 安装 Yarn 和 PM2
npm install -g yarn pm2
2. 部署项目

从 GitHub 克隆：

cd /opt
git clone https://github.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app
yarn install
yarn build

从 Gitee 克隆（国内推荐）：

cd /opt
git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app
yarn install
yarn build
3. 配置 PM2

创建 pm2.json 文件：

{
  "name": "toonflow-app",
  "script": "data/serve/app.js",
  "instances": "max",
  "exec_mode": "cluster",
  "env": {
    "NODE_ENV": "prod",
    "PORT": 10588,
    "OSSURL": "http://127.0.0.1:10588/"
  }
}

环境变量说明：

变量 说明
NODE_ENV 运行环境，prod 表示生产环境
PORT 服务监听端口
OSSURL 文件存储访问地址，用于静态资源访问
4. 启动服务
pm2 start pm2.json
pm2 startup
pm2 save
5. 常用命令
pm2 list              # 查看进程
pm2 logs toonflow-app # 查看日志
pm2 restart all       # 重启服务
pm2 monit             # 监控面板

⚠️ 首次登录
账号：admin
密码：admin123

6. 部署前端网站

如需单独部署或定制前端界面，请参考前端仓库：

💡 说明：本仓库已内置编译好的前端资源，普通用户无需单独部署前端。前端仓库仅供需要二次开发的开发者使用。

云平台部署

🎉 官方认证算力合作平台 —— 智星云

智星云 是 Toonflow 官方授权的商用镜像服务商，已合法搭载、分发并支持商用全套 Toonflow AI 短剧制作镜像，开箱即用，无需手动部署。

📄 点击展开文字版教程

一、租用 GPU 阶段教程

  1. 智星云 - 算力市场 - 4090 / 4090 Plus，点击「立即租用」进入租用详情页。

    💡 建议开启「按小时自动续租」模式，防止正在跑视频时实例到期停工。

  2. 镜像选择：windows10LTSCwin10_Toonflow - 创建实例。
  3. 等待实例启动 30s ~ 60s，查看链接方式 - RDP 登录文件下载 - 点击复制密码 - 双击已下载好的云端连接文件。
  4. 将复制好的密码粘贴并登录，连接进入云端桌面。

    💡 鼠标移到云端桌面顶端稍作停留，会显示切换桌面操作栏，可点击“——”切换回自己的电脑桌面，或点击“□”缩小布置到自己的电脑桌面作为操作窗口。

二、配置 Toonflow、启动 ComfyUI 阶段教程

  1. 先配置调用 Agent 的模型：打开桌面上的 Toonflow - 模型服务 - OpenAI 标准接口 - 填入 API 密钥以及请求地址。 默认账号：admin　密码：admin123（建议登录后修改密码）

    💡 这里直接使用智星云的 AI 大模型 Token 服务，官方接口，稳定安全，低至 6 折（小说转剧本调用一次，约花费 6.4 毛钱）。

    • 智星云调用模型 Token 请求地址：https://token.ai-galaxy.com/v1
    • 智星云 Token 充值步骤：Token 市场 - 账户概览 - 充值 - 将智星云账户余额或算力券充值到 Token 账户中。
    • 充值完成后进入「Key 管理」- 新建 API 管理，名称填 Toonflow 或其他均可，点击确定并复制 API 密钥。
  2. 回到步骤 1，将生成的 API 密钥和请求地址粘贴到 Toonflow 模型服务中，填好后点击空白处，系统会提示「供应商配置已更新」。 点击「手动添加」，回到智星云 - Token 市场页面，复制完整的模型名称。

    💡 一个 Key 可以调用智星云上的所有模型，选择你想用的即可，推荐 deepseek-v4-pro。 将模型名称完整复制粘贴到 Toonflow 中并确认，完成模型配置。

  3. 配置完成后检查两处：
    • 模型服务中的三个模型调用开关是否已开启
    • Agent 配置中调用的模型是否与你配置的一致（不一致时点击选择改正即可）
  4. 启动 ComfyUI：云端桌面 - 绘世启动器 - 一键启动。
  5. 启动大约需要 1~2 分钟，启动完成后保持页面开启状态即可。

🔧 开发流程指南

[!CAUTION] 🚧 PR 提交规范 🚧

⛔ master 分支不接受任何 PR ｜ ✅ 请将 PR 提交到 develop 分支

欢迎开发者们共同参与 Toonflow 的共创。如有兴趣加入，请在交流群内联系主理人 ACT

🛠️ 技术栈

类别 技术
运行时 Node.js 23.11.1+
语言 TypeScript 5.x
后端框架 Express 5
数据库 SQLite（better-sqlite3 / knex）
AI 集成 Vercel AI SDK（OpenAI / Anthropic / Google / DeepSeek / 智谱 / MiniMax / 通义千问 / xAI）
本地推理 @huggingface/transformers（ONNX）
实时通信 Socket.IO
桌面客户端 Electron 40
图像处理 Sharp
容器化 Docker

开发环境准备

快速启动项目

  1. 克隆项目

    从 GitHub 克隆：

    git clone https://github.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app

    从 Gitee 克隆（国内推荐）：

    git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app

  2. 安装依赖

    请先在项目根目录下执行以下命令以安装依赖项：

    yarn install

  3. 启动开发环境

    本项目包含

Toonflow-app (HBAI-Ltd/Toonflow-app)

Searching Database…

18.5K ·GitHub
Toonflow-app
这是什么？Toonflow 是一个开源的 AI 工作台，用于制作短剧和动态漫画：从剧本创作、分镜设计、角色和场景素材，到图片和视频生成，全部串联成一条流水线，运行在无限画布上。
这是桌面应用，还是要部署在服务器上运行？两者都可以。它提供 Windows、Linux 和 macOS 的 Electron 安装包，也可以通过 Docker 或 Node.js 云服务器（2GB 以上内存）自行部署，网页界面运行在 10588 端口，数据存储在 SQLite 中。
怎么开始我的第一个项目？安装 Release 版本并用 admin / admin123 登录，然后在设置中心配置你的文本、图片和视频模型服务商。创建一个项目并导入原始素材进行章节事件提取，让 ScriptAgent 起草剧本，ProductionAgent 就会在画布上生成分镜和视频。
我需要接入哪些 AI 服务？你需要一个 LLM API 接口、一个 Sora 或豆包的视频 API，以及一个 Nano Banana Pro 图片生成 API。它通过 Vercel AI SDK 集成了 OpenAI、Anthropic、Google、DeepSeek、智谱、MiniMax、通义千问和 xAI —— 你还可以直接在设置里用 TypeScript 编写自定义服务商逻辑，立即生效，无需重启。
安装时有什么需要注意的地方？在 macOS 上，你必须在「设置 - 隐私与安全性」中允许运行该应用，否则会因证书问题无法打开。Docker 在线部署尚未完成，目前容器用户需要从源码在本地构建镜像。
这些 AI 智能体具体做什么？它们在决策、执行和监督三个层面协作，负责任务拆解、内容生成、质量审核和修改；ScriptAgent 负责起草故事和剧本，ProductionAgent 负责在画布上生成分镜和视频。两个智能体的核心提示词都是 Markdown 技能文件，可以在线编辑。
它是怎么把小说改编成剧本的？它会自动从原始章节中提取事件，生成结构化的事件图谱，剧本改编时从图谱中提取精确的上下文 —— 据 README 介绍，这样可以减少长文本中的信息丢失。
智能体记得之前会话的内容吗？记得 —— 跨会话记忆结合了短期消息、长期摘要和语义召回，基于本地 ONNX 向量检索运行，让多轮创作保持连贯一致。
实际制作一集要花多少钱？作者的演示大约耗时 2 小时，API 花费约 ¥130：完整视频生成（Seedance 2.0）约 ¥120，LLM（Claude Opus 4.6）约 ¥10，图片（GPT Image 2）不到 ¥1，最终产出一集 2 分钟的成片。
What are similar projects?dramaclaw, huobao-drama, Open-Generative-AI, shuohao-skills, moyin-creator, BeefTV, awesome-short-drama-skills, CodeVideoModel
Which topics is it in?infinite-canvas, storyboarding, short-drama, image-to-video, text-to-video, text-to-image, vector-search, onnx, agent-memory, workflow-automation, video-generation, i18n
Creator
HBAI-Ltd
Size
288.2 MB
Stars
18.5K
Updated
CommitOct 13Releasev2.0.6Oct 13
Age
8mo
Commits · 90 Days