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)

vector-search
Searching Database…

What is this?Toonflow is an open-source AI workbench for producing short dramas and motion comics: scriptwriting, storyboarding, character and scene assets, and image and video generation chained into one pipeline on an infinite canvas.
Is this a desktop app or something I run on a server?Both. It ships as Electron installers for Windows, Linux, and macOS, and it can also be self-hosted via Docker or on a Node.js cloud server (2GB+ RAM), with the web UI served on port 10588 and data stored in SQLite.
How do I get my first project going?Install a Release build and log in with admin / admin123, then configure your text, image, and video model providers in the settings center. Create a project and import your source material for chapter event extraction, let ScriptAgent draft the script, and ProductionAgent assembles storyboards and video on the canvas.
Which AI services do I need to plug in?You need an LLM API endpoint, a Sora or Doubao video API, and a Nano Banana Pro image-generation API. It integrates via the Vercel AI SDK with OpenAI, Anthropic, Google, DeepSeek, Zhipu, MiniMax, Qwen, and xAI — and you can code custom provider logic in TypeScript right in the settings, effective immediately with no restart.
Anything tricky about installing it?On macOS you must allow the app under Settings - Privacy & Security, or certificate issues will keep it from opening. Docker's online deployment is not finished yet, so container users currently build the image locally from source.
What do the AI agents actually do?They cooperate in three layers — decision, execution, and supervision — handling task breakdown, content generation, quality review, and revisions; ScriptAgent drafts the story and script while ProductionAgent builds storyboards and video on the canvas. Both agents' core prompts are Markdown skill files you can edit online.
How does it turn a novel into a script?It auto-extracts events from the source chapters into a structured event graph, and script adaptation pulls precise context from that graph — which, per the README, reduces information loss in long texts.
Do the agents remember earlier sessions?Yes — cross-session memory combines short-term messages, long-term summaries, and semantic recall, running on local ONNX vector retrieval so multi-round creation stays consistent.
What does a real production run cost?The authors' demo took about 2 hours and roughly ¥130 in API spend: about ¥120 for full video generation (Seedance 2.0), ¥10 for the LLM (Claude Opus 4.6), and under ¥1 for images (GPT Image 2), yielding a 2-minute episode.
Creator
HBAI-Ltd
Size
290 MB
Stars
18.1K
Age
8mo
Commits · 90 Days