diff --git a/README.md b/README.md index 295f668..57ef1b1 100644 --- a/README.md +++ b/README.md @@ -52,22 +52,21 @@ > 🚀 **一站式短剧工程**:从文本到角色,从分镜到视频,0门槛全流程AI化,创作效率提升10倍+! - --- # 🌐 多语言支持 Toonflow 支持以下语言界面: -| 语言 | Language | -|------|----------| -| 简体中文 | Chinese (Simplified) | -| 繁體中文 | Chinese (Traditional) | -| English | English | -| ไทย | Thai | -| Tiếng Việt | Vietnamese | -| 日本語 | Japanese | -| Русский | Russian | +| 语言 | Language | +| ---------- | --------------------- | +| 简体中文 | Chinese (Simplified) | +| 繁體中文 | Chinese (Traditional) | +| English | English | +| ไทย | Thai | +| Tiếng Việt | Vietnamese | +| 日本語 | Japanese | +| Русский | Russian | > 💡 更多语言适配中,欢迎贡献翻译! @@ -75,7 +74,7 @@ Toonflow 支持以下语言界面: # 🌟 主要功能 -Toonflow v1.0.8 是面向短剧生产的 AI 工作台,围绕“策划 → 编剧 → 分镜 → 出片”构建完整闭环,并支持本地化、可编程、可持续迭代的生产流程。 +Toonflow 是面向短剧生产的 AI 工作台,围绕“策划 → 编剧 → 分镜 → 出片”构建完整闭环,并支持本地化、可编程、可持续迭代的生产流程。 - ✅ **无限画布生产工作台** 以类无限画布形式组织剧本、角色、分镜、素材与视频节点,支持自由编排、回溯与并行生产,不受线性步骤限制。 @@ -94,12 +93,11 @@ Toonflow v1.0.8 是面向短剧生产的 AI 工作台,围绕“策划 → 编 # 📦 应用场景 -- 网文/小说快速影视化改编 -- 短剧团队流水线协作生产 -- 多项目并行的 AI 内容工厂 -- 私有化部署的企业级内容平台 -- 低成本验证剧情与镜头方案 -- 教学与研究场景下的 AIGC 创作实验 +- 短视频内容创作 +- 小说影视化实验 +- AI 文学改编工具 +- 剧本开发与快速原型 +- 视频素材生成 --- @@ -114,7 +112,6 @@ Toonflow v1.0.8 是面向短剧生产的 AI 工作台,围绕“策划 → 编 5. 切换到 ProductionAgent,在无限画布中组织分镜、素材与视频节点。 6. 对分镜图进行节点化精调后回流工作台,完成视频拼接与导出。 - ## 📺 视频教程(待更新,老版本教程已无参考价值) https://www.bilibili.com/video/BV1na6wB6Ea2 @@ -129,8 +126,6 @@ https://www.bilibili.com/video/BV1na6wB6Ea2 --- - - # 🚀 安装 ## 前置条件 @@ -145,7 +140,7 @@ https://www.bilibili.com/video/BV1na6wB6Ea2 ### 1. 下载与安装 -| 操作系统 | GitHub | Atomgit | 夸克网盘下载 | 说明 | +| 操作系统 | GitHub | Atomgit | 夸克网盘下载 | 说明 | | :------: | :----------------------------------------------------------- | :------------------------------------------------------------ | :---------------------------------------------- | :------------- | | Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克网盘](https://pan.quark.cn/s/94ef07509df0) | 官方发布安装包 | | Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克网盘](https://pan.quark.cn/s/94ef07509df0) | 官方发布安装包 | @@ -525,6 +520,12 @@ pm2 monit # 监控面板 Toonflow QR +也可以点击图标加入 Discord: + +[![Join our Discord](https://cdn.prod.website-files.com/6257adef93867e50d84d30e2/67d00cf7266d2c75571aebde_Example.svg)](https://discord.gg/HEjKmpNpAZ) + +或点击邀请连接: [https://discord.gg/HEjKmpNpAZ](https://discord.gg/HEjKmpNpAZ) + --- # 💌 联系我们 diff --git a/docs/README.en.md b/docs/README.en.md index 02ee01d..a9be70f 100644 --- a/docs/README.en.md +++ b/docs/README.en.md @@ -8,18 +8,17 @@  |  - Atomgit - Atomgit + Atomgit

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

@@ -33,9 +32,9 @@ AI Short Drama Factory
- With a tap, novels instantly become episodes! + Turn your novel into episodes with just a few clicks!
- AI scripts × AI visuals × Turbo generation 🔥 + AI Scripts × AI Visuals × Ultra-fast Generation 🔥

@@ -50,49 +49,57 @@

- > 🚀 **One-stop short drama production**: From text to characters, from storyboard to video, 0 barrier full-process AI, 10x+ creation efficiency! +> 🚀 **All-in-One Short Drama Studio**: From text to characters, from storyboard to final video. +> Fully AI-powered workflow with zero barrier to entry — boosting your creative efficiency by 10x or more! --- -# 🌐 Multilingual Support +# 🌐 Multi-Language Support Toonflow supports the following interface languages: -| Language | Native Name | -|----------|-------------| -| Chinese (Simplified) | 简体中文 | -| Chinese (Traditional) | 繁體中文 | +| Language | Language Name | +|------|----------| +| 简体中文 | Chinese (Simplified) | +| 繁體中文 | Chinese (Traditional) | | English | English | -| Thai | ไทย | -| Vietnamese | Tiếng Việt | -| Japanese | 日本語 | -| Russian | Русский | +| ไทย | Thai | +| Tiếng Việt | Vietnamese | +| 日本語 | Japanese | +| Русский | Russian | + +> 💡 More languages are on the way. Translation contributions are highly welcome! --- -# �🌟 Main Features +# 🌟 Main Features -Toonflow is an AI short drama comic tool that leverages AI technology to automatically convert novels into scripts, and uses AI-generated images and videos for efficient short drama creation. With Toonflow, you can easily complete the entire process from text to images, making short drama production more intelligent and convenient. +Toonflow is an AI-powered tool for creating short dramas, short films, and comics. It can automatically transform novels into scripts, then combine AI-generated characters, images, and videos to produce high-quality content efficiently. + +With Toonflow, you can complete the entire workflow from text to final video with ease — making short-form video and drama production significantly smarter and more convenient. - ✅ **Character Generation** - Automatically analyzes the original novel text, intelligently identifies and generates character settings, including appearance, personality, identity, etc., providing a reliable foundation for subsequent script and visual creation. + Automatically analyzes the original novel text, intelligently identifies key elements, and generates detailed character profiles including appearance, personality, background, and relationships — laying a strong foundation for scriptwriting and visual production. + - ✅ **Script Generation** - Based on selected events and chapters, the system automatically generates structured scripts, covering dialogue, scene descriptions, and plot direction, enabling efficient transformation from literary texts to film/TV scripts. -- ✅ **Storyboard Production** - Based on the script content, intelligently generates storyboard prompts and visual design, detailing foreground/midground/background, character dynamics, prop settings, and scene layout; automatically turns scripts into storyboards, providing a complete route blueprint for video production. -- ✅ **Video Composition** - Integrates AI image and video technologies to generate video clips using AI. Includes online editing and supports personalized output adjustments, making film & TV production collaborative and efficient. + Based on selected events and chapters, the system automatically creates well-structured scripts with natural dialogue, scene descriptions, and plot development, enabling efficient adaptation from literature to cinematic format. + +- ✅ **Storyboard Creation** + From the generated script, Toonflow intelligently creates storyboard prompts and visual layouts. It details foreground, midground, and background elements, character movements, props, and scene composition — providing a complete and ready-to-use blueprint for video production. + +- ✅ **Video Synthesis** + Integrates advanced AI image and video generation technologies to produce high-quality video clips. The built-in online editor allows flexible personalization and fine-tuning, making the entire creative process smooth, fast, and highly efficient. --- -# 📦 Application Scenarios +# 📦 Use Cases -- Short video content creation -- Novel-to-film/TV experiments -- AI literature adaptation tools +- Short video content creation (Shorts, Reels, TikTok) +- Novel-to-film / drama adaptation experiments +- AI-powered literary adaptation tool - Script development and rapid prototyping -- Video material generation +- Video asset and footage generation --- @@ -100,15 +107,15 @@ Toonflow is an AI short drama comic tool that leverages AI technology to automat ## 📺 Video Tutorial -https://www.bilibili.com/video/BV1na6wB6Ea2 -[![Toonflow 8-Minute Quick Start AI Video](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) +[https://www.bilibili.com/video/BV1na6wB6Ea2](https://www.bilibili.com/video/BV1na6wB6Ea2) +[![Toonflow 8-Minute AI Video Quick Start](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) -**Toonflow 8-Minute Quick Start AI Video** -👉 [Click to watch](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) +**Toonflow: 8-Minute AI Video Quick Start** +👉 [Click to Watch](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) -📱 Scan with WeChat on your phone to watch +📱 Scan the QR code to watch on mobile -Scan WeChat to Watch +Scan QR code to watch on mobile --- @@ -116,34 +123,34 @@ https://www.bilibili.com/video/BV1na6wB6Ea2 ## Prerequisites -Before installing and using this software, please prepare the following: +Before installing and using Toonflow, please prepare the following: -- ✅ Large language model AI service API address -- ✅ Sora or Doubao video service API address -- ✅ Nano Banana Pro image generation model service API +- ✅ API endpoint for Large Language Model (LLM) +- ✅ API endpoint for video generation services (Sora or Doubao) +- ✅ API endpoint for image generation model (Nano Banana Pro) ## Local Installation -### 1. Download & Install +### 1. Download and Install -| Operating System | GitHub | Atomgit | Quark Cloud Download | Description | -| :--------------: | :------------------------------------------------------ | :---------------------------------------------------- | :------------------------------------------------------ | :-------------------- | -| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Cloud](https://pan.quark.cn/s/94ef07509df0) | Official release package | -| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Cloud](https://pan.quark.cn/s/94ef07509df0) | Official release package | -| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Cloud](https://pan.quark.cn/s/94ef07509df0) | Official release package | +| OS | GitHub | Atomgit | Quark Drive Download | Description | +| :------: | :----------------------------------------------------------- | :------------------------------------------------------------ | :---------------------------------------------- | :------------- | +| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Official Installer | +| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Official Installer | +| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Official Installer | > [!CAUTION] -> On MacOS, please go to Settings - Privacy & Security to configure security settings, otherwise, you may not be able to open the app due to certificate issues. +> **MacOS Users:** Please go to `System Settings > Privacy & Security` to allow the application to run; otherwise, it may fail to open due to certificate issues. > -> See Zhihu documentation: [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) +> Reference (Zhihu): [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) -> Due to Gitee OS environment and Release file upload size limits, Gitee Release download is currently not available. +> Due to Gitee OS environment constraints and Release file size upload limits, Gitee Release download links are currently unavailable. -### 2. Start Service +### 2. Start the Service -After installation, launch the program to start using this service. +After installation, simply launch the program to start using the service. -> ⚠️ **First-time Login** +> ⚠️ **Default Login** > Username: `admin` > Password: `admin123` @@ -151,45 +158,45 @@ After installation, launch the program to start using this service. ### Prerequisites -- [Docker](https://docs.docker.com/get-docker/) installed (version 20.10+) +- [Docker](https://docs.docker.com/get-docker/) installed (Version 20.10+) ### Method 1: Online Deployment -To be developed; please use local build for now. +To be updated. Please use local build for now. ### Method 2: Local Build -Build directly from local source code, suitable for developers or users who have cloned the repo; requires Git installed locally: +Build directly using the local source code. This is suitable for developers or users who have cloned the repository. You will need `git` installed locally: ```shell -# Clone the project (skip if already cloned) +# Clone the repository first (skip if already cloned) git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app -# Build and start locally with docker-compose +# Build and start locally using docker-compose yarn docker:local # Or build manually docker build -t toonflow . -docker run -d -p :10588 -v :/app/data toonflow +docker run -d -p :10588 -v :/app/data toonflow -# After this, the site can be accessed at /web/index.html on the mapped port -# e.g. http://localhost:10588/web/index.html +# You can now access the page at the corresponding port at /web/index.html +# Example: http://localhost:10588/web/index.html ``` ### Service Port Description -| Port | Purpose | Deployment Mapping | -| -------- | ------------ | -------------------- | -| `10588` | App Interface | `10588:10588` | +| Port | Purpose | Deployment Mapping | +| ------- | -------- | ------------- | +| `10588` | Software UI | `10588:10588` | -**Environment variable descriptions:** +**Environment Variables:** -| Variable | Description | -| ------------- | ------------------------------------------- | -| `NODE_ENV` | Environment; `prod` for production | -| `PORT` | Service listening port (default 10588) | -| `OSSURL` | File storage access address for static files | +| Variable | Description | +| ---------- | ----------------------------------------- | +| `NODE_ENV` | Operating environment, `prod` for production | +| `PORT` | Service listening port (Default: 10588) | +| `OSSURL` | File storage access URL, used for static resources | --- @@ -197,9 +204,9 @@ docker run -d -p :10588 -v :/app/data toonflow ### 1. Server Requirements -- **OS:** Ubuntu 20.04+ / CentOS 7+ -- **Node.js:** 24.x (recommended, minimum 23.11.1+) -- **RAM:** 2GB+ +- **OS**: Ubuntu 20.04+ / CentOS 7+ +- **Node.js**: 24.x (Recommended, Minimum 23.11.1+) +- **Memory**: 2GB+ ### 2. Server Deployment @@ -226,7 +233,7 @@ yarn install yarn build ``` -**Clone from Gitee (Mainland China recommended):** +**Clone from Gitee (Recommended for users in China):** ```bash cd /opt @@ -254,17 +261,17 @@ Create a `pm2.json` file: } ``` -**Environment variable descriptions:** +**Environment Variables:** -| Variable | Description | -| ------------- | ------------------------------------------- | -| `NODE_ENV` | Environment; `prod` for production | -| `PORT` | Service listening port | -| `OSSURL` | File storage access address for static files | +| Variable | Description | +| ---------- | ----------------------------------------------------- | +| `NODE_ENV` | Operating environment (`prod` = Production) | +| `PORT` | Service listening port (default: 10588) | +| `OSSURL` | Object Storage URL for storing and serving static files | --- -#### 4. Start Service +#### 4. Start the Service ```bash pm2 start pm2.json @@ -275,147 +282,150 @@ pm2 save #### 5. Common Commands ```bash -pm2 list # View process list +pm2 list # View processes pm2 logs toonflow-app # View logs -pm2 restart all # Restart service -pm2 monit # Monitoring panel +pm2 restart all # Restart services +pm2 monit # Monitoring dashboard ``` -> ⚠️ **First-time Login** +> ⚠️ **Default Login** > Username: `admin` > Password: `admin123` -#### 6. Deploying the Frontend Website +#### 6. Deploy Frontend -For standalone frontend deployment or customization, refer to the frontend repository: +If you need to deploy or customize the frontend interface separately, please refer to the frontend repository: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -> 💡 **Note:** This repo already contains a compiled frontend by default. Regular users do NOT need to separately deploy the frontend. The frontend repo is for developers requiring secondary development. +> 💡 **Note**: This repository already includes the compiled frontend resources. +> Regular users do not need to deploy the frontend separately. The Toonflow-web repository is intended only for developers who want to make custom modifications or contribute to the frontend. --- -# 🔧 Developer Guide +# 🔧 Development Workflow Guide > [!CAUTION] > 🚧 **PR Submission Guidelines** 🚧 > -> ⛔ `master` branch does NOT accept PRs | ✅ Please submit PRs to the `develop` branch -> -> Developers are invited to co-develop Toonflow. To join, contact owner ACT in the group chat. +> ⛔ **No PRs accepted on the `master` branch** +> ✅ **Please submit all Pull Requests to the `develop` branch** + +We welcome all developers who want to contribute to Toonflow. +If you're interested in joining, please contact the project maintainer (ACT) in our community group. ## 🛠️ Tech Stack -| Category | Technology | -| ------------ | --------------------------------------------------------------------------------------- | -| Runtime | Node.js 23.11.1+ | -| Language | TypeScript 5.x | -| Backend | Express 5 | -| Database | SQLite (better-sqlite3 / knex) | -| AI Integration | Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhipu / MiniMax / Qwen / xAI)| -| Local Inference | @huggingface/transformers (ONNX) | -| Real-Time | Socket.IO | -| Desktop | Electron 40 | -| Image Proc. | Sharp | -| Container | Docker | +| Category | Technology | +| ---------- | ----------------------------------------------------------------------------------------- | +| Runtime | Node.js 23.11.1+ | +| Language | TypeScript 5.x | +| Backend | Express 5 | +| Database | SQLite (better-sqlite3 / knex) | +| AI Integ. | Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhipu / MiniMax / Qwen / xAI) | +| Local Inf. | @huggingface/transformers (ONNX) | +| Real-time | Socket.IO | +| Desktop UI | Electron 40 | +| Image Proc.| Sharp | +| Container | Docker | -## Development Environment Preparation +## Development Environment Prep -- **Node.js:** version 23.11.1 or above required -- **Yarn:** recommended as the package manager +- **Node.js**: Version 23.11.1 or higher required +- **Yarn**: Recommended package manager ## Quick Start -1. **Clone the project** +1. **Clone the Project** - **Clone from GitHub:** + **From GitHub:** ```bash git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` - **Clone from Gitee (Mainland China recommended):** + **From Gitee (Recommended for China):** ```bash git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` -2. **Install dependencies** +2. **Install Dependencies** - In the project root directory, install dependencies: + Run the following command in the project root directory: ```bash yarn install ``` -3. **Start development environment** +3. **Start the Development Environment** - This project includes both **backend API service** and **frontend interface**. Start as needed: + This project consists of two parts: the **Backend API Service** and the **Frontend Pages**. Choose your startup method based on your needs: - - **Option 1: Start backend service only** + - **Method 1: Start Backend Service Only** ```bash yarn dev ``` - > ⚠️ This command starts only the backend API (port 10588), **without the web interface**. Accessing `http://localhost:10588` allows API calls only; the full web UI is unavailable. To use the frontend, start the frontend project separately or use GUI mode below. + > ⚠️ This command only starts the backend API service (Port 10588) and **does not include the frontend pages**. Visiting `http://localhost:10588` directly will only allow API calls without a UI. To use the frontend, start the frontend project separately or use the GUI mode below. - - **Option 2: Start Electron desktop client** + - **Method 2: Start Electron Desktop Client** ```bash yarn dev:gui ``` - > This command starts both backend and Electron window, with built-in web UI. Out-of-the-box, no extra config needed. Recommended for a full experience. + > This command launches both the backend service and the Electron desktop window simultaneously. It comes with built-in frontend pages ready out-of-the-box, requiring no extra configuration. Ideal for developers who want to experience the full feature set. - - **Option 3: Production mode** + - **Method 3: Start in Production Mode** ```bash yarn start ``` - > Runs compiled service in production mode (requires `yarn build` first). + > Run the compiled service directly in production mode (requires running `yarn build` first). -4. **Build the project** +4. **Project Build & Packaging** - - Compile TypeScript files: + - Compile and generate TypeScript files: ```bash yarn build ``` - - Build executable for Windows: + - Package as a Windows executable: ```bash yarn dist:win ``` - - Build executable for Mac: + - Package as a Mac executable: ```bash yarn dist:mac ``` - - Build executable for Linux: + - Package as a Linux executable: ```bash yarn dist:linux ``` -5. **Code quality check** +5. **Code Quality Checks (Linting)** - - Perform lint check: + - Run global syntax and styling checks: ```bash yarn lint ``` -6. **AI Debug panel (Optional)** +6. **AI Debug Panel (Optional)** - Start the Vercel AI SDK visual debugging tool for easier AI integration debugging: + Launch the AI SDK visual debugging tool to easily trace AI calls: ```bash yarn debug:ai @@ -423,129 +433,131 @@ For standalone frontend deployment or customization, refer to the frontend repos ## Frontend Development -To modify the frontend UI, develop in the frontend repository: +If you need to modify or customize the frontend interface, please go to the frontend repository: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -After frontend build, copy the `dist` contents to this project's `data/web` to integrate. +After building the frontend, copy the entire `dist` folder into the `data/web` directory of this project to integrate it. ## Project Structure ``` -📂 build/ # Compiled output +📂 build/ # Build artifacts 📂 data/ # Runtime data -│ ├─ 📂 models/ # Local inference models (ONNX) -│ ├─ 📂 oss/ # Object storage (assets/characters/scenes) -│ ├─ 📂 serve/ # Production entry -│ ├─ 📂 skills/ # Agent skill prompts -│ └─ 📂 web/ # Built-in frontend assets -📂 ./ # Documentation assets -📂 env/ # Environment configs -📂 scripts/ # Build and helper scripts +│ ├─ 📂 models/ # Local inference models (ONNX) +│ ├─ 📂 oss/ # Object storage (images, characters, scenes) +│ ├─ 📂 serve/ # Production environment entry point +│ ├─ 📂 skills/ # Agent skill prompts +│ └─ 📂 web/ # Built frontend assets (embedded) +📂 docs/ # Documentation and resources +📂 env/ # Environment configurations +📂 scripts/ # Build and utility scripts 📂 src/ -├─ 📂 agents/ # AI Agent modules -│ ├─ 📂 productionAgent/ # Production Agent -│ └─ 📂 scriptAgent/ # Script Agent -├─ 📂 lib/ # Common libraries (db, responses) -├─ 📂 middleware/ # Middleware -├─ 📂 routes/ # API routes -│ ├─ 📂 agents/ # Agent memory management -│ ├─ 📂 artStyle/ # Art style management -│ ├─ 📂 assets/ # Asset management -│ ├─ 📂 assetsGenerate/ # Asset generation -│ ├─ 📂 cornerScape/ # Storyboard management -│ ├─ 📂 general/ # General APIs -│ ├─ 📂 login/ # Auth -│ ├─ 📂 migrate/ # Data migration -│ ├─ 📂 modelSelect/ # Model selection -│ ├─ 📂 novel/ # Novel management -│ ├─ 📂 other/ # Other features -│ ├─ 📂 production/ # Production management -│ ├─ 📂 project/ # Project management -│ ├─ 📂 script/ # Script generation -│ ├─ 📂 scriptAgent/ # Script Agent APIs -│ ├─ 📂 setting/ # System settings -│ ├─ 📂 task/ # Task management -│ └─ 📂 test/ # Test APIs -├─ 📂 socket/ # WebSocket comms -├─ 📂 types/ # TypeScript types -├─ 📂 utils/ # Utility functions -├─ 📄 app.ts # App entry point -├─ 📄 core.ts # Core initialization -├─ 📄 env.ts # Env vars -├─ 📄 err.ts # Error handling -├─ 📄 logger.ts # Logging module -├─ 📄 router.ts # Route registration -└─ 📄 utils.ts # General tools -📄 Dockerfile # Docker build config -📄 electron-builder.yml # Electron packaging config -📄 skillList.json # Skills list -📄 LICENSE # (Apache-2.0) License -📄 NOTICES.txt # Third-party dependencies -📄 package.json # Project config -📄 tsconfig.json # TypeScript config +├─ 📂 agents/ # AI Agent modules +│ ├─ 📂 productionAgent/ # Production Agent +│ └─ 📂 scriptAgent/ # Script Agent +├─ 📂 lib/ # Shared libraries (DB initialization, response formatting) +├─ 📂 middleware/ # Express middlewares +├─ 📂 routes/ # Routing modules +│ ├─ 📂 agents/ # Agent memory management +│ ├─ 📂 artStyle/ # Art style management +│ ├─ 📂 assets/ # Asset management +│ ├─ 📂 assetsGenerate/ # Asset generation +│ ├─ 📂 cornerScape/ # Storyboard management +│ ├─ 📂 general/ # General APIs +│ ├─ 📂 login/ # Authentication +│ ├─ 📂 migrate/ # Data migration +│ ├─ 📂 modelSelect/ # Model selection +│ ├─ 📂 novel/ # Novel management +│ ├─ 📂 other/ # Other functionalities +│ ├─ 📂 production/ # Production and editing management +│ ├─ 📂 project/ # Project management +│ ├─ 📂 script/ # Script generation +│ ├─ 📂 scriptAgent/ # Script Agent interface +│ ├─ 📂 setting/ # System settings +│ ├─ 📂 task/ # Task management +│ └─ 📂 test/ # Test APIs +├─ 📂 socket/ # Real-time communication via WebSocket +├─ 📂 types/ # TypeScript type declarations +├─ 📂 utils/ # Utility functions +├─ 📄 app.ts # Application entry point +├─ 📄 core.ts # Core system initialization +├─ 📄 env.ts # Environment variables handling +├─ 📄 err.ts # Error handling +├─ 📄 logger.ts # Logging module +├─ 📄 router.ts # Route registration +└─ 📄 utils.ts # General utilities +📄 Dockerfile # Docker build file +📄 electron-builder.yml # Electron packaging configuration +📄 skillList.json # Skill list +📄 LICENSE # License (Apache-2.0) +📄 NOTICES.txt # Third-party dependency notices +📄 package.json # Project configuration +📄 tsconfig.json # TypeScript configuration ``` --- # 🔗 Related Repositories -| Repository | Description | GitHub | Gitee | -| ---------------- | ---------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| **Toonflow-app** | Full client (this repo, for users) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app)| [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | -| **Toonflow-web** | Frontend source (for FE devs) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web)| [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | +| Repository | Description | GitHub | Gitee | +|------------------|-----------------------------------------------------------------------------|----------------------------------------------------|--------------------------------------------------| +| **Toonflow-app** | Full client (This repository — recommended for most users) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | +| **Toonflow-web** | Frontend source code (For frontend developers) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | -> 💡 **Tip:** If you just want to use Toonflow, download the client from this repo directly. The frontend repo is for developers needing secondary dev or UI customization. +> 💡 **Tip**: If you just want to use Toonflow, downloading the client from this repository is sufficient. The Toonflow-web repository is intended only for developers who need to customize the UI or perform secondary development. --- -# 👨‍👩‍👧‍👦 WeChat Groups +# 👨‍👩‍👧‍👦 Discord Community -Group Assistant: +Click the icon below to join our Discord: -Toonflow QR +[![Join our Discord](https://cdn.prod.website-files.com/6257adef93867e50d84d30e2/67d00cf7266d2c75571aebde_Example.svg)](https://discord.gg/HEjKmpNpAZ) + +Or click the direct link: [https://discord.gg/HEjKmpNpAZ](https://discord.gg/HEjKmpNpAZ) --- # 💌 Contact Us -📧 Email: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow inquiry) +📧 Email: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow%20Inquiry) --- # 📜 License -Toonflow is open source under Apache-2.0 with a supplementary commercial agreement. +Toonflow is open-sourced under the Apache-2.0 License with an additional supplementary commercial agreement. License details: https://www.apache.org/licenses/LICENSE-2.0 -## Supplementary Agreement +## Supplementary Commercial Agreement -- If you distribute this software as a product to **2 or more independent third parties**, you must obtain **written commercial authorization** from HBAI-Ltd. -- **≤ 5 legal entities** operating jointly for internal use without providing services externally are considered **internal use and require no authorization**. -- You may not remove or modify any trademarks, logos, or copyright notices in Toonflow. +- If this software is distributed as a product to **2 or more independent third parties**, a **written commercial license** from HBAI-Ltd is required. +- Joint operation and internal use by **≤ 5 legal entities** (without providing services to external users) is considered internal use and **does not require a license**. +- It is strictly prohibited to remove or modify any logos or copyright information within Toonflow. -## Always Free — No Authorization Required +## Forever Free Usage Scenarios -- ✅ Using Toonflow to produce content and earn platform revenue shares +- ✅ Using Toonflow to create content and earning revenue share from video platforms - ✅ Secondary development for internal team use -- ✅ ≤ 5 legal entities operating jointly, internally only +- ✅ Joint/internal use by up to 5 legal entities - ✅ Personal learning, research, and non-commercial purposes -## Licensing Pricing +## Commercial License Pricing -| Stage | Annual Revenue | Annual Fee | -|------|---------|------| -| 🌱 Nurture | < $10k | **Free** | -| 🚀 Startup | $10k–$50k | ¥5,000/year | -| 📈 Growth | $50k–$150k | ¥20,000/year | -| 🏢 Scale | $150k–$500k | ¥80,000/year | -| 🌐 Enterprise | > $500k | Negotiable | +| Phase | Annual Revenue | Annual Fee | +|----------------|-------------------------|---------------------| +| 🌱 Incubation | < $15,000 | **Free** | +| 🚀 Startup | $15,000 – $75,000 | $750 / year | +| 📈 Growth | $75,000 – $200,000 | $2,900 / year | +| 🏢 Scale | $200,000 – $750,000 | $11,500 / year | +| 🌐 Enterprise | > $750,000 | Negotiable | -> **Non-Retroactivity Clause**: Users who used Toonflow under AGPL-3.0 prior to the v1.0.8 release are not affected by this change. Their existing usage continues under AGPL-3.0. +> **Non-Retroactivity Clause**: Users who were using Toonflow under the AGPL-3.0 license before version v1.0.8 will continue to be governed by AGPL-3.0 and are not affected by this agreement change. -See the full [LICENSE](../LICENSE) file for details. +For the full agreement, please refer to the [LICENSE](./LICENSE) file. --- @@ -555,34 +567,34 @@ See the full [LICENSE](../LICENSE) file for details. --- -# 🙏 Thanks +# 🙏 Acknowledgements -Thank you to the following open-source projects for supporting Toonflow: +We sincerely thank the following open-source projects for providing robust support to Toonflow: -- [Express](https://expressjs.com/) - Fast, open, minimalist Node.js Web framework -- [AI SDK](https://ai-sdk.dev/) - TypeScript-first AI toolkit -- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - High-performance SQLite3 bindings -- [Sharp](https://sharp.pixelplumbing.com/) - High-performance Node.js image toolkit +- [Express](https://expressjs.com/) - Fast, unopinionated, minimalist web framework for Node.js +- [AI SDK](https://ai-sdk.dev/) - The AI toolkit for TypeScript +- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - High-performance SQLite3 binding library +- [Sharp](https://sharp.pixelplumbing.com/) - High-performance Node.js image processing - [Axios](https://axios-http.com/) - Promise-based HTTP client -- [Zod](https://zod.dev/) - TypeScript-first schema validation library -- [Socket.IO](https://socket.io/) - Real-time bidirectional event framework -- [Electron](https://www.electronjs.org/) - Cross-platform desktop app framework -- [Hugging Face Transformers](https://huggingface.co./transformers.js) - Local ML inference library +- [Zod](https://zod.dev/) - TypeScript-first schema validation +- [Socket.IO](https://socket.io/) - Real-time bidirectional event-based communication +- [Electron](https://www.electronjs.org/) - Cross-platform desktop application framework +- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - State-of-the-art Machine Learning for the web -Thanks to the following organizations/individuals for their support: +Thanks to the following organizations/individuals for supporting Toonflow:
- SophNet Logo + Sophgo Logo - SophNet Cloud provides computing power sponsorship - [Official Website] + Sophnet for providing computing power sponsorship + [Website]
-For a complete list of third-party dependencies, see `NOTICES.txt` +For a complete list of third-party dependencies, please refer to `NOTICES.txt`. -##### copyright © 淮北艾阿网络科技有限公司 \ No newline at end of file +##### Copyright © Huaibei AIA Network Technology Co., Ltd. \ No newline at end of file diff --git a/docs/README.ja.md b/docs/README.ja.md index 7d2325d..e639351 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -1,4 +1,4 @@ -

+

GitHub @@ -8,19 +8,18 @@  |  - Atomgit - Atomgit + Atomgit

- 簡体字中国語 | - 繁体字中国語 | - 英語 | - タイ語 | - ベトナム語 | + 简体中文 | + 繁體中文 | + English | + ไทย | + Tiếng Việt | 日本語 | - ロシア語 + Русский

@@ -31,9 +30,9 @@

- AI短編ドラマ工場 + AI ショートドラマ制作スタジオ
- 指先ひとつで、小説が瞬時にドラマ化! + 指先一つで、小説があっという間にドラマに!
AI脚本 × AI映像 × 超高速生成 🔥
@@ -50,173 +49,175 @@

- > 🚀 **ワンストップ短編ドラマ制作**:テキストからキャラクター、絵コンテ、映像まで、0知識でAI化された全プロセス。創作効率10倍以上! + > 🚀 **オールインワン制作環境**:テキストからキャラクター、絵コンテから動画まで。 + 専門知識ゼロでも全プロセスをAIが**アシスト**し、創作効率を10倍以上に引き上げます!
--- # 🌐 多言語対応 -Toonflowは以下の言語インターフェースに対応しています: +Toonflow は以下の言語インターフェースに対応しています: | 言語 | Language | |------|----------| -| 简体中文 | 中国語(簡体字) | -| 繁體中文 | 中国語(繁体字) | -| English | 英語 | -| ไทย | タイ語 | -| Tiếng Việt | ベトナム語 | -| 日本語 | 日本語 | -| Русский | ロシア語 | +| 简体中文 | Chinese (Simplified) | +| 繁體中文 | Chinese (Traditional) | +| English | English | +| ไทย | Thai | +| Tiếng Việt | Vietnamese | +| 日本語 | Japanese | +| Русский | Russian | + +> 💡 さらに多くの言語に対応予定です。多言語翻訳へのご協力(貢献)を歓迎します! --- # 🌟 主な機能 -ToonflowはAI短編漫画/ドラマ制作ツールで、小説をAIが自動的に脚本化し、AI生成画像・映像と組み合わせて高効率な短編ドラマ制作を実現します。Toonflowにより、テキストから映像までの流れを簡単に完結でき、短編ドラマ制作がよりスマート&便利になります。 +Toonflow は、AI技術を活用して小説を自動的に脚本へ変換し、AIが生成した画像や動画と組み合わせることで、効率的なショートドラマ制作を強力に**アシスト**するツールです。Toonflow を使えば、テキストから映像までの全工程を簡単に完結でき、ドラマ制作がよりスマートで便利になります。 -- ✅ **キャラクター生成** - 元の小説テキストを自動分析し、外見・性格・身分など詳細なキャラクター設定をスマートに識別・生成。脚本・作画の基盤を提供します。 -- ✅ **脚本生成** - 選択したエピソードや章に基づき、構造化された脚本(セリフ・シーン描写・ストーリー展開など)をシステムが自動生成。小説から映像脚本への効率的な変換を実現します。 -- ✅ **絵コンテ作成** - 脚本内容に基づき、AIが適切な絵コンテプロンプトや画面設計を生成。前景・中景・背景、キャラクター動作、小道具設計、場面レイアウトを細分化し、脚本からビデオへの完全なルートマップを自動構築します。 -- ✅ **動画合成** - AI画像と動画技術を統合し、AI生成により映像クリップの作成が可能。オンライン編集と個別調整にも対応し、映像創作の効率アップ&迅速実現をサポートします。 +- ✅ **キャラクター生成** 原作の小説テキストを自動分析し、容姿、性格、身分などの詳細情報をインテリジェントに認識・生成します。これにより、後の脚本や画面作りにおいて信頼できる土台を提供します。 + +- ✅ **脚本生成** 選択したイベントや章に基づき、セリフ、シーンの描写、ストーリー展開を含む構造化された脚本を自動生成します。文学テキストから映像用脚本への高効率な変換を**アシスト**します。 + +- ✅ **絵コンテ制作** 脚本の内容から、絵コンテ用のプロンプト(指示文)と画面構成をインテリジェントに生成します。前景・中景・背景、キャラクターの動き、小道具の配置などを細分化し、動画制作の道筋を完全に**アシスト**します。 + +- ✅ **動画合成** AI画像および動画技術を統合し、AIによる動画クリップ生成を可能にします。オンライン編集機能も備えており、個別の微調整に対応。映像制作の効率的な連携とスピーディな完成を**アシスト**します。 --- -# 📦 利用シーン +# 📦 活用シーン -- ショート動画コンテンツ制作 -- 小説の映像化実験 -- AI文学改編ツール -- 脚本開発&高速プロトタイピング -- 動画素材生成 +- ショート動画コンテンツの制作 +- 小説の映像化テスト +- AIによる文学作品の翻案(脚色)ツール +- 脚本開発および迅速なプロトタイプ作成 +- 動画素材の生成 --- -# 🔰 使い方ガイド +# 🔰 ご利用ガイド ## 📺 動画チュートリアル -https://www.bilibili.com/video/BV1na6wB6Ea2 -[![Toonflow 8分でAI動画をクイックスタート](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) +[https://www.bilibili.com/video/BV1na6wB6Ea2](https://www.bilibili.com/video/BV1na6wB6Ea2) +[![Toonflow 8分でわかるAI動画作成](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) -**Toonflow 8分クイックスタートAI動画** -👉 [クリックして見る](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) +**Toonflow 8分でわかるクイックスタート AI動画作成** +👉 [クリックして視聴](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) -📱 スマホWeChatでQRコードをスキャンして視聴 +📱 QRコードをスキャンして視聴 -微信扫码观看 +WeChat スキャンして視聴 --- # 🚀 インストール -## 前提条件 +## 必須環境(前提条件) -本ソフトウェアのインストール・利用前に以下をご用意ください: +本ソフトウェアをインストールして使用する前に、以下の準備をお願いします: -- ✅ 大規模言語モデルAIサービスのエンドポイント -- ✅ SoraまたはDoubao動画サービスAPI -- ✅ Nano Banana Pro画像生成モデルAPI +- ✅ 大規模言語モデル (LLM) の AI サービス API エンドポイント +- ✅ Sora または 豆包 (Doubao) の動画サービス API エンドポイント +- ✅ Nano Banana Pro の画像生成モデルサービス API エンドポイント -## ローカルインストール +## ローカル環境へのインストール -### 1. ダウンロード&インストール +### 1. ダウンロードとインストール -| オペレーティングシステム | GitHub | Atomgit | クアークネットディスクダウンロード | 説明 | +| OS | GitHub | Atomgit | Quark Drive | 説明 | | :------: | :----------------------------------------------------------- | :------------------------------------------------------------ | :---------------------------------------------- | :------------- | -| Windows | [リリース](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [リリース](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [クアークネットディスク](https://pan.quark.cn/s/94ef07509df0) | 公式リリースインストールパッケージ | -| Linux | [リリース](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [リリース](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [クアークネットディスク](https://pan.quark.cn/s/94ef07509df0) | 公式リリースインストールパッケージ | -| macOS | [リリース](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [リリース](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [クアークネットディスク](https://pan.quark.cn/s/94ef07509df0) | 公式リリースインストールパッケージ | +| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | 公式インストーラ | +| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | 公式インストーラ | +| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | 公式インストーラ | > [!CAUTION] -> MacOSの場合は、設定→プライバシーとセキュリティでセキュリティ設定を許可してください。証明書問題でアプリが開かない場合があります。 +> MacOS システムをご利用の場合、「システム設定」-「プライバシーとセキュリティ」からセキュリティ設定を行ってください。そうしないと、証明書の問題で正常に開けない場合があります。 > -> 参考:知乎ドキュメント:[https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) +> 参考ドキュメント(Zhihu):[https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) -> Gitee OSの制限とReleaseファイルのサイズ上限により、Gitee側のReleaseダウンロードは現在未提供です。 +> Gitee OS 環境の制限および Release ファイルのアップロード容量制限により、現在 Gitee Release のダウンロードリンクは提供していません。 -### 2. サービス起動 +### 2. サービスの起動 -インストール後、アプリを起動してください。 +インストール完了後、プログラムを起動すればサービスを利用開始できます。 -> ⚠️ **初回ログイン** -> アカウント:`admin` +> ⚠️ **初回ログイン** +> ユーザー名:`admin` > パスワード:`admin123` -## Dockerデプロイ +## Docker を利用した導入 -### 前提条件 +### 必須環境 -- [Docker](https://docs.docker.com/get-docker/)(バージョン 20.10以上)インストール済み +- [Docker](https://docs.docker.com/get-docker/) がインストール済みであること(バージョン 20.10+) -### 方法1:オンラインデプロイ +### 方法1:オンライン展開 -現在準備中。しばらくはローカルビルドをご利用ください。 +現在準備中です。一時的にローカルでのビルドをご利用ください。 -### 方法2:ローカルビルド +### 方法2:ローカルでのビルド -お手持ちのソースコードから直接ビルド。開発者またはリポジトリクローン済ユーザー向け(git要インストール)。 +既存のソースコードを使用して直接ビルドします。開発者やリポジトリをクローンしたユーザーに適しています(ローカルに git がインストールされている必要があります): ```shell -# まずプロジェクトをクローン(既にある場合は省略可) +# まずプロジェクトをクローン(既に存在する場合はスキップ) git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app -# docker-composeでローカルビルド&起動 +# 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 +# これで指定したポートの /web/index.html にアクセスできます +# 例: http://localhost:10588/web/index.html ``` -### サービスポート情報 +### サービスポートの説明 -| ポート | 用途 | デプロイマッピング | +| ポート | 用途 | デプロイマッピング | | ------- | -------- | ------------- | -| `10588` | UI | `10588:10588` | +| `10588` | ソフトウェア画面 | `10588:10588` | -**環境変数メモ:** +**環境変数の説明:** -| 変数 | 説明 | -| ------------ | -------------------------- | -| `NODE_ENV` | 実行環境、`prod`が本番 | -| `PORT` | サービスポート(デフォルト10588) | -| `OSSURL` | ファイル保存URL(静的リソース) | +| 変数名 | 説明 | +| ---------- | ---------------------------------- | +| `NODE_ENV` | 実行環境。`prod` は本番環境を示します | +| `PORT` | サービスの待受ポート(デフォルト 10588) | +| `OSSURL` | ファイルストレージのアクセスURL(静的リソース用) | --- -## クラウドデプロイ +## クラウド(サーバー)への導入 -### 1. サーバー環境要件 +### 1. サーバー環境の要件 -- **OS**:Ubuntu 20.04以上/CentOS 7以上 -- **Node.js**:24.x(推奨、最低23.11.1以上) +- **OS**:Ubuntu 20.04+ / CentOS 7+ +- **Node.js**:24.x(推奨、最低 23.11.1+) - **メモリ**:2GB以上 -### 2. サーバーデプロイ +### 2. サーバーへの配置 -#### 1. 環境インストール +#### 1. 環境構築 ```bash -# Node.jsインストール +# Node.js のインストール curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash source ~/.bashrc nvm install 24 -# YarnとPM2インストール +# Yarn と PM2 のインストール npm install -g yarn pm2 ``` -#### 2. プロジェクト導入 +#### 2. プロジェクトの配置 -**GitHubからクローン:** +**GitHub からクローン:** ```bash cd /opt @@ -226,7 +227,7 @@ yarn install yarn build ``` -**Giteeからクローン(中国国内推奨):** +**Gitee からクローン(中国国内推奨):** ```bash cd /opt @@ -236,9 +237,9 @@ yarn install yarn build ``` -#### 3. PM2構成 +#### 3. PM2 の設定 -`pm2.json`ファイルを作成: +`pm2.json` ファイルを作成します: ```json { @@ -254,17 +255,17 @@ yarn build } ``` -**環境変数説明:** +**環境変数の説明:** -| 変数 | 説明 | -| ------------ | -------------------------- | -| `NODE_ENV` | 実行環境、`prod`が本番 | -| `PORT` | サービスポート | -| `OSSURL` | ファイル保存URL(静的リソース) | +| 変数名 | 説明 | +| ---------- | ---------------------------------- | +| `NODE_ENV` | 実行環境。`prod` は本番環境を示します | +| `PORT` | サービスの待受ポート | +| `OSSURL` | ファイルストレージのアクセスURL(静的リソース用) | --- -#### 4. サービス起動 +#### 4. サービスの起動 ```bash pm2 start pm2.json @@ -275,77 +276,77 @@ pm2 save #### 5. よく使うコマンド ```bash -pm2 list # プロセス一覧 -pm2 logs toonflow-app # ログを見る -pm2 restart all # サービス再起動 -pm2 monit # 監視パネル +pm2 list # プロセス一覧の確認 +pm2 logs toonflow-app # ログの確認 +pm2 restart all # サービスの再起動 +pm2 monit # 監視パネルの表示 ``` -> ⚠️ **初回ログイン** -> アカウント:`admin` +> ⚠️ **初回ログイン** +> ユーザー名:`admin` > パスワード:`admin123` -#### 6. フロントエンドのデプロイ +#### 6. フロントエンドサイトの配置 -前端の分離デプロイやカスタマイズが必要な場合はこちら: +フロントエンド画面を単独で配置、またはカスタマイズしたい場合は、フロントエンドのリポジトリを参照してください: - **GitHub**:[Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**:[Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -> 💡 **補足**:このリポジトリにはビルド済のフロントリソースが内蔵済み。通常ユーザーはフロント分離構築は不要。フロントリポジトリはカスタム開発用です。 +> 💡 **補足**:本リポジトリには既にコンパイル済みのフロントエンド成果物が組み込まれているため、一般ユーザーはフロントエンドを個別に配置する必要はありません。フロントエンドのリポジトリは、二次開発を行う開発者向けです。 --- # 🔧 開発フローガイド > [!CAUTION] -> 🚧 **PR提出ガイドライン** 🚧 +> 🚧 **PR(プルリクエスト)提出のルール** 🚧 > -> ⛔ `master`ブランチはPR不可 | ✅ `develop`ブランチにPR提出 +> ⛔ `master` ブランチへの PR は受け付けていません | ✅ PR は `develop` ブランチへ提出してください > -> 開発者のご参加を歓迎します。参加希望はコミュニティで主催者ACTにご連絡ください。 +> 開発者の皆様の 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 | +| カテゴリ | 技術 | +| ---------- | ----------------------------------------------------------------------------------------- | +| 実行環境 | 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 | -## 開発環境準備 +## 開発環境の準備 -- **Node.js**:バージョン23.11.1以上 -- **Yarn**:パッケージマネージャ推奨 +- **Node.js**:バージョン 23.11.1 以上が必要 +- **Yarn**:プロジェクトのパッケージマネージャーとして推奨 -## プロジェクトのクイック起動 +## プロジェクトのクイックスタート -1. **プロジェクトクローン** +1. **プロジェクトのクローン** - **GitHubからクローン:** + **GitHub からクローン:** ```bash git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` - **Giteeからクローン(中国国内推奨):** + **Gitee からクローン(中国国内推奨):** ```bash git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` -2. **依存パッケージインストール** +2. **依存関係(パッケージ)のインストール** - プロジェクト直下で次を実行: + プロジェクトのルートディレクトリで以下のコマンドを実行します: ```bash yarn install @@ -353,69 +354,69 @@ pm2 monit # 監視パネル 3. **開発環境の起動** - 本プロジェクトは**バックエンドAPIサービス**と**フロントエンド**があります。次から用途を選択。 + 本プロジェクトは **バックエンド API サービス** と **フロントエンド画面** の2つの部分を含みます。必要に応じて起動方法を選択してください: - - **方法1:バックエンドのみ起動** + - **方法1:バックエンドサービスのみ起動** ```bash yarn dev ``` - > ⚠️ このコマンドはAPIサーバー(ポート10588)のみ起動。`http://localhost:10588`でAPIのみ利用。GUI表示にはフロントプロジェクトの起動または下記のGUIモードをご利用ください。 + > ⚠️ このコマンドはバックエンド API サービス(ポート 10588)のみを起動し、**フロントエンド画面は含まれません**。直接 `http://localhost:10588` にアクセスしても API を呼び出せるだけで、完全な Web 画面は見えません。画面を利用する場合はフロントエンドプロジェクトを別途起動するか、以下の GUI モードを使用してください。 - - **方法2:Electronデスクトップクライアント** + - **方法2:Electron デスクトップクライアントの起動** ```bash yarn dev:gui ``` - > バックエンドとElectronウィンドウが同時起動。内蔵フロント付きで即利用OK。すべての機能を体験したい方向け。 + > このコマンドはバックエンドサービスと Electron のデスクトップウィンドウを同時に起動します。フロントエンド画面が内蔵されており、追加の設定なしですぐに使えます。すべての機能を体験したい開発者に最適です。 - - **方法3:本番モードで起動** + - **方法3:本番(Production)モードで起動** ```bash yarn start ``` - > 本番モードでビルド済サービスを直接起動(`yarn build`が必要)。 + > コンパイル済みのサービスを本番モードで直接実行します(事前に `yarn build` を実行しておく必要があります)。 -4. **プロジェクトパッケージ化** +4. **プロジェクトのパッケージ化(ビルド)** - - TypeScriptファイルのビルド: + - コンパイルして TypeScript ファイルを生成: ```bash yarn build ``` - - Windows用実行ファイル化: + - Windows 用の実行ファイルをパッケージ化: ```bash yarn dist:win ``` - - Mac用実行ファイル化: + - Mac 用の実行ファイルをパッケージ化: ```bash yarn dist:mac ``` - - Linux用実行ファイル化: + - Linux 用の実行ファイルをパッケージ化: ```bash yarn dist:linux ``` -5. **コード品質チェック** +5. **コード品質チェック(Lint)** - - グローバルLintチェック: + - グローバルな構文およびコーディング規約のチェックを実行: ```bash yarn lint ``` -6. **AIデバッグパネル(任意)** +6. **AI デバッグパネル(オプション)** - AI SDKのGUIデバッグツール。AI呼び出しのデバッグに便利。 + AI SDK のビジュアルデバッグツールを起動し、AI の呼び出しを簡単にデバッグできます: ```bash yarn debug:ai @@ -423,68 +424,68 @@ pm2 monit # 監視パネル ## フロントエンド開発 -フロントUIの修正はフロントエンドリポジトリへ: +フロントエンド画面を修正する必要がある場合は、フロントエンドのリポジトリで開発を行ってください: - **GitHub**:[Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**:[Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -ビルド後、`dist`以下を本プロジェクト `data/web`へコピーで統合完了。 +フロントエンドのビルド後、`dist` ディレクトリの内容を本プロジェクトの `data/web` ディレクトリにコピーするだけで統合できます。 ## プロジェクト構成 ``` 📂 build/ # ビルド成果物 📂 data/ # 実行時データ -│ ├─ 📂 models/ # ローカル推論モデル(ONNX) -│ ├─ 📂 oss/ # オブジェクトストレージ(素材/キャラ/背景) -│ ├─ 📂 serve/ # 本番エントリ -│ ├─ 📂 skills/ # Agentプロンプト集 -│ └─ 📂 web/ # ビルトインフロント -📂 docs/ # ドキュメントリソース +│ ├─ 📂 models/ # ローカル推論モデル(ONNX) +│ ├─ 📂 oss/ # オブジェクトストレージ(素材/キャラクター/背景) +│ ├─ 📂 serve/ # 本番環境のエントリー +│ ├─ 📂 skills/ # Agent スキルのプロンプト +│ └─ 📂 web/ # フロントエンドビルド成果物(内蔵) +📂 docs/ # ドキュメントや画像リソース 📂 env/ # 環境設定 -📂 scripts/ # ビルド&ツールスクリプト +📂 scripts/ # ビルドや補助スクリプト 📂 src/ -├─ 📂 agents/ # AI Agentモジュール -│ ├─ 📂 productionAgent/ # プロダクション用Agent -│ └─ 📂 scriptAgent/ # 脚本Agent -├─ 📂 lib/ # 共通ライブラリ(DB初期化等) -├─ 📂 middleware/ # ミドルウェア -├─ 📂 routes/ # ルーティングモジュール -│ ├─ 📂 agents/ # Agentメモリ管理 -│ ├─ 📂 artStyle/ # 画風管理 -│ ├─ 📂 assets/ # 素材管理 -│ ├─ 📂 assetsGenerate/ # 素材生成 -│ ├─ 📂 cornerScape/ # 絵コンテ管理 -│ ├─ 📂 general/ # 共通API -│ ├─ 📂 login/ # ログイン認証 -│ ├─ 📂 migrate/ # データ移行 -│ ├─ 📂 modelSelect/ # モデル選択 -│ ├─ 📂 novel/ # 小説管理 -│ ├─ 📂 other/ # その他機能 -│ ├─ 📂 production/ # 制作管理 -│ ├─ 📂 project/ # プロジェクト管理 -│ ├─ 📂 script/ # 脚本生成 -│ ├─ 📂 scriptAgent/ # 脚本AgentAPI -│ ├─ 📂 setting/ # システム設定 -│ ├─ 📂 task/ # タスク管理 -│ └─ 📂 test/ # テストAPI -├─ 📂 socket/ # WebSocket通信 -├─ 📂 types/ # TypeScript型 -├─ 📂 utils/ # ユーティリティ -├─ 📄 app.ts # アプリエントリ -├─ 📄 core.ts # コア初期化 -├─ 📄 env.ts # 環境変数処理 -├─ 📄 err.ts # エラーハンドラ -├─ 📄 logger.ts # ロギング -├─ 📄 router.ts # ルート登録 -└─ 📄 utils.ts # 共通ツール -📄 Dockerfile # Dockerビルド -📄 electron-builder.yml # Electronパッケージ設定 +├─ 📂 agents/ # AI Agent モジュール +│ ├─ 📂 productionAgent/ # 制作 Agent +│ └─ 📂 scriptAgent/ # 脚本 Agent +├─ 📂 lib/ # 共通ライブラリ(DB初期化、レスポンス形式など) +├─ 📂 middleware/ # ミドルウェア +├─ 📂 routes/ # ルーティングモジュール +│ ├─ 📂 agents/ # Agent メモリ管理 +│ ├─ 📂 artStyle/ # 画風(アートスタイル)管理 +│ ├─ 📂 assets/ # 素材管理 +│ ├─ 📂 assetsGenerate/ # 素材生成 +│ ├─ 📂 cornerScape/ # 絵コンテ管理 +│ ├─ 📂 general/ # 汎用 API +│ ├─ 📂 login/ # ログイン認証 +│ ├─ 📂 migrate/ # データ移行 +│ ├─ 📂 modelSelect/ # モデル選択 +│ ├─ 📂 novel/ # 小説管理 +│ ├─ 📂 other/ # その他機能 +│ ├─ 📂 production/ # 制作進行管理 +│ ├─ 📂 project/ # プロジェクト管理 +│ ├─ 📂 script/ # 脚本生成 +│ ├─ 📂 scriptAgent/ # 脚本 Agent インターフェース +│ ├─ 📂 setting/ # システム設定 +│ ├─ 📂 task/ # タスク管理 +│ └─ 📂 test/ # テスト用 API +├─ 📂 socket/ # WebSocket リアルタイム通信 +├─ 📂 types/ # TypeScript 型定義 +├─ 📂 utils/ # ユーティリティ関数 +├─ 📄 app.ts # アプリケーションエントリー +├─ 📄 core.ts # コア初期化 +├─ 📄 env.ts # 環境変数の処理 +├─ 📄 err.ts # エラーハンドリング +├─ 📄 logger.ts # ログモジュール +├─ 📄 router.ts # ルーティング登録 +└─ 📄 utils.ts # 汎用ツール +📄 Dockerfile # Docker ビルドファイル +📄 electron-builder.yml # Electron パッケージ設定 📄 skillList.json # スキルリスト 📄 LICENSE # ライセンス(Apache-2.0) -📄 NOTICES.txt # サードパーティ依存リスト +📄 NOTICES.txt # 依存パッケージに関する表記 📄 package.json # プロジェクト設定 -📄 tsconfig.json # TypeScript設定 +📄 tsconfig.json # TypeScript 設定 ``` --- @@ -492,64 +493,66 @@ pm2 monit # 監視パネル # 🔗 関連リポジトリ | リポジトリ | 説明 | GitHub | Gitee | -| ------------------ | ---------------------------------- | -------------------------------------------------- | ------------------------------------------------ | -| **Toonflow-app** | フルクライアント(本リポジトリ、一般ユーザー向け) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | -| **Toonflow-web** | フロントエンドソース(フロントエンド開発者向け) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | +| ---------------- | ---------------------------------- | -------------------------------------------------- | ------------------------------------------------ | +| **Toonflow-app** | 完全版クライアント(本リポジトリ、一般ユーザー向け) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | +| **Toonflow-web** | フロントエンドソースコード(フロントエンド開発者向け) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | -> 💡 **ヒント**:Toonflowを利用したいだけなら本リポジトリをそのままダウンロードすればOK。フロントリポジトリはフロントカスタマイズや2次開発者向けです。 +> 💡 **ヒント**:Toonflow を使用するだけであれば、本リポジトリのクライアントを直接ダウンロードするだけで十分です。フロントエンドのリポジトリは、二次開発やフロントエンド画面のカスタマイズが必要な開発者向けです。 --- -# 👨‍👩‍👧‍👦 WeChatコミュニティグループ +# 👨‍👩‍👧‍👦 Discord 交流グループ -グループ招待アシスタント: +下のアイコンをクリックして Discord に参加: -Toonflow QR +[![Join our Discord](https://cdn.prod.website-files.com/6257adef93867e50d84d30e2/67d00cf7266d2c75571aebde_Example.svg)](https://discord.gg/HEjKmpNpAZ) + +または直接リンクをクリック: [https://discord.gg/HEjKmpNpAZ](https://discord.gg/HEjKmpNpAZ) --- # 💌 お問い合わせ -📧 メール:[ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow相談) +📧 メール:[ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflowのお問い合わせ) --- # 📜 ライセンス -ToonflowはApache-2.0ライセンス+補足商業契約でオープンソース公開されています。 +Toonflow は Apache-2.0 ライセンスに基づいてオープンソースとして公開されており、補足的な商業契約が付随しています。 -ライセンス詳細:https://www.apache.org/licenses/LICENSE-2.0 +ライセンスの詳細:https://www.apache.org/licenses/LICENSE-2.0 -## 補足契約 +## 補足条項 -- 本ソフトウェアを製品として**2つ以上の独立した第三者**に配布する場合、HBAI-Ltdの**書面による商業許諾**が必要です。 -- **5法人以下**の共同運営で内部利用のみの場合は、**商業許諾不要**です。 -- Toonflowの商標・ロゴ・著作権情報の削除・改変は禁止です。 +- 本ソフトウェアを製品として **2つ以上の独立した第三者** に配布・提供する場合、HBAI-Ltd からの **書面による商業ライセンス(許諾)** を取得する必要があります。 +- **5法人以下** が共同で運営し、外部にサービスを提供せずに内部利用のみとする場合は、内部利用と見なされ、**商業ライセンスの取得は不要**です。 +- Toonflow 内のロゴや著作権情報を削除または変更することは禁止されています。 -## 永久無料シーン +## 永久無料となるケース -- ✅ Toonflowでコンテンツを制作しプラットフォーム収益を得る -- ✅ 自チーム内部利用の二次開発 -- ✅ ≤ 5法人の共同運営内部利用 -- ✅ 個人学習・研究・非商用利用 +- ✅ Toonflow を利用してコンテンツを制作し、プラットフォームから収益分配を得る場合 +- ✅ 自分のチーム内で使用するために二次開発を行う場合 +- ✅ 5法人以下の共同運営による内部利用 +- ✅ 個人の学習、研究、非営利目的 ## 商業ライセンス価格 -| 段階 | 年間売上高 | 年間費用 | +| フェーズ | 年間売上高 | 年間費用 | |------|---------|------| -| 🌱 育成期 | < ¥10万 | **無料** | -| 🚀 スタートアップ | ¥10〜50万 | ¥5,000/年 | -| 📈 成長期 | ¥50〜150万 | ¥20,000/年 | -| 🏢 拡大期 | ¥150〜500万 | ¥80,000/年 | -| 🌐 エンタープライズ | > ¥500万 | 要相談 | +| 🌱 支援期 | 200万円 未満 | **無料** | +| 🚀 創業期 | 200万円 ~ 1,000万円 | 108,000 円/年 | +| 📈 成長期 | 1,000万円 ~ 3,000万円 | 420,000 円/年 | +| 🏢 規模拡大期 | 3,000万円 ~ 1億円 | 1,680,000 円/年 | +| 🌐 エンタープライズ | 1億円 超 | 応相談 | -> **不遡及条項**:v1.0.8リリース前にAGPL-3.0でToonflowを使用していたユーザーは、本変更の影響を受けません。既存の利用はAGPL-3.0に基づき継続されます。 +> **遡及(そきゅう)適用除外条項**:v1.0.8 リリース以前に AGPL-3.0 に基づいて使用していたユーザーは、引き続き AGPL-3.0 に従い、本契約変更の制約を受けません。 -完全な契約内容は [LICENSE](../LICENSE) をご覧ください。 +契約の全文については [LICENSE](./LICENSE) ファイルを参照してください。 --- -# ⭐️ スター履歴 +# ⭐️ Star 獲得履歴 [![Star History Chart](https://api.star-history.com/svg?repos=HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left)](https://www.star-history.com/#HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left) @@ -557,34 +560,32 @@ ToonflowはApache-2.0ライセンス+補足商業契約でオープンソー # 🙏 謝辞 -以下のオープンソースプロジェクトの強力な支援に感謝します: +Toonflow に強力なサポートを提供してくださる以下のオープンソースプロジェクトに感謝いたします: -- [Express](https://expressjs.com/) - 高速・オープンなNode.js Webフレームワーク -- [AI SDK](https://ai-sdk.dev/) - TypeScript向けAIツールキット -- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - 高性能SQLite3バインディング -- [Sharp](https://sharp.pixelplumbing.com/) - 高速Node.js画像処理 -- [Axios](https://axios-http.com/) - PromiseベースHTTPクライアント -- [Zod](https://zod.dev/) - TypeScript優先のバリデーション -- [Socket.IO](https://socket.io/) - リアルタイム双方向通信エンジン -- [Electron](https://www.electronjs.org/) - クロスプラットフォームデスクトップ開発 -- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - ローカル機械学習推論ライブラリ +- [Express](https://expressjs.com/) - 高速でオープン、ミニマルな Node.js Web フレームワーク +- [AI SDK](https://ai-sdk.dev/) - TypeScript 向け AI ツールキット +- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - 高性能 SQLite3 バインディングライブラリ +- [Sharp](https://sharp.pixelplumbing.com/) - 高性能 Node.js 画像処理ライブラリ +- [Axios](https://axios-http.com/) - Promise ベースの HTTP クライアント +- [Zod](https://zod.dev/) - TypeScript ファーストのスキーマ検証ライブラリ +- [Socket.IO](https://socket.io/) - リアルタイムの双方向イベント通信エンジン +- [Electron](https://www.electronjs.org/) - クロスプラットフォームデスクトップアプリ開発フレームワーク +- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - ローカル ML 推論ライブラリ -以下の組織・団体・個人によるToonflowへの協力に感謝します: +Toonflow を支援してくださる以下の組織・団体・個人に感謝いたします:
- 算能云 Logo + 算能雲 Logo - 算能云 よりコンピューティング協賛 - [公式サイト] + 算能雲 (Sophnet) 様より計算リソースの提供をいただいております + [公式サイト]
-第三者依存リストは `NOTICES.txt` をご覧ください +完全なサードパーティの依存関係リストについては `NOTICES.txt` をご参照ください。 - - -##### copyright © 淮北艾阿网络科技有限公司 \ No newline at end of file +##### copyright © Huaibei AIA Network Technology Co., Ltd. \ No newline at end of file diff --git a/docs/README.ru.md b/docs/README.ru.md index db4583a..8b9ba80 100644 --- a/docs/README.ru.md +++ b/docs/README.ru.md @@ -8,13 +8,12 @@  |  - Atomgit - Atomgit + Atomgit

- 简体中文 | + 简体中文 | 繁體中文 | English | ไทย | @@ -31,11 +30,11 @@

- AI-фабрика коротких сериалов + Фабрика AI-мини-сериалов и короткометражных фильмов
- Одним движением — роман за секунду становится сериалом! + Всего несколько кликов — и ваша новелла превращается в фильм или сериал!
- AI-сценарий × AI-изображения × Молниеносная генерация 🔥 + AI-сценарий × AI-изображения × Сверхбыстрая генерация 🔥

@@ -50,65 +49,71 @@

- > 🚀 **Универсальный конвейер коротких сериалов**: от текста к персонажам, от раскадровки к видео, 0 порога по всему процессу на базе AI, рост эффективности творчества 10× и более! +> 🚀 **All-in-One платформа для коротких сериалов и фильмов**: От текста до персонажей, от раскадровки до готового видео. Полная автоматизация с помощью ИИ с нулевым порогом входа — повышает эффективность творчества в 10 раз и более! --- -# 🌐 Многоязычная поддержка +# 🌐 Мультиязычная поддержка Toonflow поддерживает следующие языки интерфейса: -| Язык | Language | -|------|----------| -| 简体中文 | Китайский (упрощённый) | -| 繁體中文 | Китайский (традиционный) | -| English | Английский | -| ไทย | Тайский | -| Tiếng Việt | Вьетнамский | -| 日本語 | Японский | -| Русский | Русский | +| Язык | Language | +|---------------|---------------------------| +| 简体中文 | Chinese (Simplified) | +| 繁體中文 | Chinese (Traditional) | +| English | English | +| ไทย | Thai | +| Tiếng Việt | Vietnamese | +| 日本語 | Japanese | +| Русский | Russian | + +> 💡 В настоящее время мы активно добавляем новые языки. Будем рады вашей помощи с переводами! --- -# 🌟 Основные функции +# 🌟 Основные возможности -Toonflow — инструмент для создания коротких сериалов и комиксов с помощью AI, позволяющий автоматически превращать романы в сценарии и генерировать изображения и видео с помощью нейросетей. Используя Toonflow, вы легко пройдёте путь от текста к видео: создание коротких фильмов становится умнее и удобнее. +Toonflow — это мощный ИИ-инструмент для создания коротких видео, мини-сериалов и комиксов. Он автоматически превращает новеллы в сценарии, а затем с помощью ИИ генерирует изображения и видео, позволяя быстро и эффективно создавать качественный контент. +С Toonflow вы можете пройти весь цикл производства — от текста до готового видео — легко и удобно, без специальных навыков. - ✅ **Генерация персонажей** - Автоматически анализирует исходный текст романа, интеллектуально идентифицирует и генерирует параметры персонажей, включая внешний вид, характер, социальный статус и др., формируя прочную основу для дальнейшей разработки сценария и визуала. + Автоматический анализ оригинального текста новеллы, интеллектуальное распознавание и создание подробных профилей персонажей (внешность, характер, личность, отношения и другие детали). Это закладывает прочную основу для сценария и визуальной части. + - ✅ **Генерация сценария** - На основе выбранных событий и глав система автоматически создает структурированный сценарий, включая диалоги, описание сцен и развитие сюжета, обеспечивая эффективную трансформацию из литературного текста в кинематографический сценарий. -- ✅ **Раскадровка** - На основе сценария AI генерирует креативные промпты и дизайн кадров, прорабатывает передний-средний-задний план, динамику персонажей, реквизит и компоновку сцен, автоматически создаёт раскадровку для дальнейшей видеосборки. -- ✅ **Видеосборка** - Интегрирует AI-технологии генерации изображений и видео. Позволяет создавать фрагменты видео с помощью ИИ. Системы онлайн-редактирования поддерживают индивидуальные настройки и быстрый вывод конечного результата. + На основе выбранных событий и глав система автоматически создаёт структурированный сценарий с естественными диалогами, описаниями сцен и развитием сюжета, обеспечивая эффективную адаптацию литературного произведения в видеоформат. + +- ✅ **Создание раскадровки (Storyboard)** + Автоматическая генерация промптов и дизайн кадров на основе сценария. Детальная проработка переднего, среднего и заднего планов, движений персонажей, реквизита и композиции — готовая раскадровка становится точным планом для производства видео. + +- ✅ **Синтез видео** + Интеграция современных ИИ-технологий для генерации изображений и видеоклипов. Встроенный онлайн-редактор позволяет гибко настраивать результат, делая процесс создания видео быстрым, удобным и плавным. --- -# 📦 Области применения +# 📦 Сценарии использования -- Создание коротких видео-контента -- Эксперименты по экранизации романов -- Инструмент AI для литературных адаптаций -- Разработка сценариев и быстрые прототипы -- Генерация видеоматериалов +- Создание контента для коротких видео (Shorts, Reels, TikTok) +- Экранизация и визуализация новелл +- ИИ-инструмент для адаптации литературных произведений +- Разработка сценариев и быстрое прототипирование +- Генерация видеоматериалов и футажей --- # 🔰 Руководство пользователя -## 📺 Видеоруководство +## 📺 Видеоуроки -https://www.bilibili.com/video/BV1na6wB6Ea2 -[![Toonflow — Быстрый старт с AI-видео за 8 минут](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) +[https://www.bilibili.com/video/BV1na6wB6Ea2](https://www.bilibili.com/video/BV1na6wB6Ea2) +[![Toonflow: Быстрый старт за 8 минут](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) -**Toonflow: 8 минут до полного освоения AI-видео** -👉 [Смотреть видео](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) +**Toonflow: Быстрый старт в AI-видео за 8 минут** +👉 [Нажмите для просмотра](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) -📱 Сканируйте WeChat QR-код для просмотра на телефоне +📱 Отсканируйте QR-код для просмотра видео на телефоне -微信扫码观看 +Сканировать QR-код для просмотра видео --- @@ -116,34 +121,34 @@ https://www.bilibili.com/video/BV1na6wB6Ea2 ## Предварительные требования -Перед установкой и использованием программы подготовьте следующее: +Перед установкой и использованием Toonflow подготовьте следующее: -- ✅ Адрес API сервиса языковой AI-модели -- ✅ Адрес API Sora или Doubao для видео -- ✅ Адрес API сервиса модели Nano Banana Pro для генерации изображений +- ✅ URL API для LLM (большой языковой модели) +- ✅ URL API для генерации видео (Sora или Doubao) +- ✅ URL API для генерации изображений (Nano Banana Pro) -## Установка локально +## Локальная установка (на ПК) ### 1. Скачивание и установка -| Операционная система | GitHub | Atomgit | Скачать из Quark Net Disk | Описание | -| :------------------: | :---------------------------------------------------------- | :------------------------------------------------------------- | :-------------------------------------------------- | :------------------ | -| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Net Disk](https://pan.quark.cn/s/94ef07509df0) | Официальный установочный пакет | -| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Net Disk](https://pan.quark.cn/s/94ef07509df0) | Официальный установочный пакет | -| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Net Disk](https://pan.quark.cn/s/94ef07509df0) | Официальный установочный пакет | +| ОС | GitHub | Atomgit | Скачать (Quark Drive) | Описание | +| :------: | :----------------------------------------------------------- | :------------------------------------------------------------ | :---------------------------------------------- | :------------- | +| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Официальный установщик | +| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Официальный установщик | +| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Официальный установщик | > [!CAUTION] -> Для macOS: откройте "Настройки → Конфиденциальность и безопасность" и настройте параметры безопасности, иначе может не открыться из-за проблемы с сертификатом. +> Пользователям macOS необходимо перейти в **Системные настройки → Конфиденциальность и безопасность** и разрешить запуск приложения. В противном случае программа может не открыться из-за проблем с сертификатом. > -> См. на Zhihu: [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) +> Подробнее (на китайском): [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) -> Из-за ограничений Gitee OS и лимита по размеру файлов Release — отдельная ссылка для загрузки с Gitee временно недоступна. +> Из-за технических ограничений Gitee Release (размер файлов и окружение) ссылки для скачивания на Gitee временно недоступны. ### 2. Запуск сервиса -После установки запустите приложение для начала работы. +После завершения установки просто откройте программу Toonflow — сервис будет готов к работе. -> ⚠️ **Первый вход** +> ⚠️ **Данные для первого входа** > Логин: `admin` > Пароль: `admin123` @@ -151,56 +156,59 @@ https://www.bilibili.com/video/BV1na6wB6Ea2 ### Предварительные требования -- Установлен [Docker](https://docs.docker.com/get-docker/) (версия 20.10+) +- Установлен [Docker](https://docs.docker.com/get-docker/) версии 20.10 или выше ### Способ 1: Онлайн-развертывание -В разработке — пока используйте локальную сборку. +В настоящее время в стадии разработки. +Рекомендуется использовать локальную сборку. ### Способ 2: Локальная сборка -Собирается локально из скачанного репозитория, подходит для разработчиков либо скачавших код через git: +Сборка проекта непосредственно из исходного кода на вашем компьютере. +Подходит для разработчиков и пользователей, которые уже клонировали репозиторий. Требуется установленная система контроля версий Git: ```shell -# Клонировать проект (если уже есть — пропустите) +# Сначала клонируйте проект (пропустите, если уже сделано) git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app -# Запускаем сборку и запуск с помощью docker-compose +# Локальная сборка и запуск с помощью docker-compose yarn docker:local -# Или вручную +# Или ручная сборка docker build -t toonflow . -docker run -d -p <локальный_порт>:10588 -v <путь_к_данным>:/app/data toonflow +docker run -d -p <локальный_порт>:10588 -v <путь_к_локальным_данным>:/app/data toonflow -# Доступ по адресу: http://localhost:10588/web/index.html +# После этого интерфейс будет доступен по пути /web/index.html на указанном порту +# Пример: http://localhost:10588/web/index.html ``` -### Описание портов +### Описание портов сервиса -| Порт | Назначение | Мэппинг в контейнере | -| -------- | ------------- | ---------------------------- | -| `10588` | Web-интерфейс | `10588:10588` | +| Порт | Назначение | Маппинг | +| ------- | --------------------------- | ---------------- | +| `10588` | Основной порт сервиса (API) | `10588:10588` | -**Переменные окружения:** +**Переменные окружения (Environment Variables):** -| Переменная | Описание | -| ------------ | --------------------------------------- | -| `NODE_ENV` | Среда запуска, `prod` — продуктивная | -| `PORT` | Порт службы (по умолчанию 10588) | -| `OSSURL` | Доступ к хранилищу файлов, для статики | +| Переменная | Описание | +| ---------- | ----------------------------------------------------- | +| `NODE_ENV` | Среда выполнения (`prod` = Production) | +| `PORT` | Порт сервиса (по умолчанию 10588) | +| `OSSURL` | Адрес Object Storage для хранения и отдачи статических файлов | --- -## Развёртывание в облаке +## Облачное развертывание / Установка на сервер -### 1. Требования к серверу +### I. Требования к серверу -- **ОС**: Ubuntu 20.04+ / CentOS 7+ -- **Node.js**: 24.x (рекомендуется; минимум 23.11.1+) -- **ОЗУ**: от 2 ГБ +- **Операционная система**: Ubuntu 20.04+ / CentOS 7+ +- **Node.js**: 24.x (рекомендуется, минимум 23.11.1+) +- **ОЗУ**: 2 ГБ и более -### 2. Развёртывание на сервере +### II. Развертывание #### 1. Установка окружения @@ -213,9 +221,9 @@ nvm install 24 npm install -g yarn pm2 ``` -#### 2. Развёртывание проекта +#### 2. Загрузка и сборка проекта -**Клонировать из GitHub:** +**Клонирование с GitHub:** ```bash cd /opt @@ -225,7 +233,7 @@ yarn install yarn build ``` -**Клонировать из Gitee (для пользователей из Китая):** +**Клонирование с Gitee (рекомендуется для Китая):** ```bash cd /opt @@ -253,13 +261,13 @@ yarn build } ``` -**Описание переменных:** +**Переменные окружения (Environment Variables):** -| Переменная | Описание | -| ------------ | --------------------------------| -| `NODE_ENV` | Среда запуска, `prod` — продакшн | -| `PORT` | Слушаемый порт | -| `OSSURL` | Адрес доступа к статике | +| Переменная | Описание | +| ---------- | ----------------------------------------------------- | +| `NODE_ENV` | Среда выполнения (`prod` = Production) | +| `PORT` | Порт сервиса (по умолчанию 10588) | +| `OSSURL` | Адрес Object Storage для хранения и отдачи статических файлов | --- @@ -276,57 +284,58 @@ pm2 save ```bash pm2 list # Список процессов pm2 logs toonflow-app # Просмотр логов -pm2 restart all # Перезапуск сервиса -pm2 monit # Мониторинг +pm2 restart all # Перезапуск сервисов +pm2 monit # Панель мониторинга ``` -> ⚠️ **Первый вход** +> ⚠️ **Данные для первого входа** > Логин: `admin` > Пароль: `admin123` -#### 6. Развёртывание фронта +#### 6. Развертывание Frontend -Если нужна кастомизация интерфейса или отдельное развертывание фронта — используйте репозиторий фронтенда: +Если вам нужно отдельно развернуть или кастомизировать фронтенд, перейдите в репозиторий Toonflow-web: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -> 💡 **Примечание:** В этот репозиторий уже встроен скомпилированный фронт. Обычным пользователям отдельная установка канала не требуется. Фронт-репозиторий — только для тех, кто хочет разрабатывать/модифицировать UI. +> 💡 **Примечание**: Этот репозиторий уже содержит скомпилированные файлы Frontend. Обычным пользователям не требуется отдельно устанавливать фронтенд. Репозиторий Toonflow-web предназначен только для разработчиков, которые хотят внести изменения или доработать интерфейс. --- -# 🔧 Руководство по процессу разработки +# 🔧 Руководство разработчика > [!CAUTION] -> 🚧 **Правила по PR** 🚧 +> 🚧 **Правила отправки Pull Request** 🚧 > -> ⛔ В `master` запрещены любые PR | ✅ Создавайте PR только в ветку `develop` +> ⛔ **Ветка `master` не принимает PR** | ✅ **Отправляйте все PR в ветку `develop`** > -> Разработчиков приглашаем к со-разработке Toonflow! Для участия пишите главному админу ACT в группу. +> Приглашаем всех желающих разработчиков присоединиться к развитию Toonflow. +> Если вы хотите участвовать, свяжитесь с куратором проекта ACT в нашей группе сообщества. -## 🛠️ Технологический стек +## 🛠️ Стек технологий -| Категория | Технологии | -| ------------ | ------------------------------------------------------------------------------------------------------------------- | -| Рантайм | Node.js 23.11.1+ | -| Язык | TypeScript 5.x | -| Бэкенд | Express 5 | -| БД | SQLite (better-sqlite3 / knex) | -| AI-интеграции| Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhihu / MiniMax / Tongyi Qianwen / xAI) | -| Локальный AI | @huggingface/transformers (ONNX) | -| RTC | Socket.IO | -| Десктоп-клиент| Electron 40 | -| Графика | Sharp | -| Контейнеризация| Docker | +| Категория | Технология | +|------------------------|-----------------------------------------------------------------------------------------| +| Runtime | Node.js 23.11.1+ | +| Язык | TypeScript 5.x | +| Backend-фреймворк | Express 5 | +| База данных | SQLite (better-sqlite3 / knex) | +| Интеграция ИИ | Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhipu / MiniMax / Qwen / xAI) | +| Локальный инференс | @huggingface/transformers (ONNX) | +| Real-time связь | Socket.IO | +| Desktop-клиент | Electron 40 | +| Обработка изображений | Sharp | +| Контейнеризация | Docker | ## Подготовка среды разработки -- **Node.js**: не ниже 23.11.1 -- **Yarn**: рекомендуется менеджер пакетов +- **Node.js**: версия 23.11.1 и выше +- **Yarn**: рекомендуется использовать в качестве пакетного менеджера -## Быстрый старт проекта +## Быстрый запуск проекта -1. **Клонируйте проект** +1. **Клонирование проекта** **С GitHub:** @@ -342,9 +351,9 @@ pm2 monit # Мониторинг cd Toonflow-app ``` -2. **Установите зависимости** +2. **Установка зависимостей** - В корне проекта выполните: + Выполните следующую команду в корневой папке проекта: ```bash yarn install @@ -352,203 +361,209 @@ pm2 monit # Мониторинг 3. **Запуск среды разработки** - Проект состоит из backend API и frontend. Возможные варианты запуска: + Проект состоит из **Backend API** и **Frontend страниц**. Выберите нужный способ запуска: - - **1: Только backend** + - **Способ 1: Запуск только Backend** ```bash yarn dev ``` - > ⚠️ Запускает только backend API (порт 10588); без интерфейса. Для доступа к UI — используйте отдельный frontend проект или запускайте через GUI-модули ниже. + > ⚠️ Эта команда запускает **только Backend API** (порт 10588) **без интерфейса Frontend**. + > При переходе по адресу `http://localhost:10588` вы сможете только обращаться к API. Полноценный графический интерфейс отображаться не будет. + > Чтобы работать с UI, запустите Frontend отдельно или используйте режим GUI (см. ниже). - - **2: Electron-desktop-клиент** + - **Способ 2: Запуск клиента Electron (GUI)** ```bash yarn dev:gui ``` - > Открывает backend и Electron GUI-окно — всё встроено, без доп. настроек. Рекомендуется для полноценного использования. + > Эта команда одновременно запускает Backend и десктопное приложение Electron со встроенным Frontend. + > Программа готова к работе сразу после запуска, без дополнительных настроек. + > Идеально подходит для разработчиков, которые хотят быстро протестировать весь функционал приложения. - - **3: Режим продакшн** + - **Способ 3: Запуск в режиме Production** ```bash yarn start ``` - > Запуск производственной сборки (предварительно `yarn build` обязателен). + > Запуск скомпилированного сервиса в режиме Production (сначала необходимо выполнить `yarn build`). -4. **Сборка проекта** +4. **Сборка проекта (Build & Package)** - - Компиляция .ts файлов: + - Компиляция и генерация TypeScript: ```bash yarn build ``` - - Сборка exe для Windows: + - Сборка исполняемого файла для Windows: ```bash yarn dist:win ``` - - Сборка для Mac: + - Сборка исполняемого файла для Mac: ```bash yarn dist:mac ``` - - Сборка для Linux: + - Сборка исполняемого файла для Linux: ```bash yarn dist:linux ``` -5. **Lint и проверка кода** +5. **Проверка качества кода (Linting)** - - Проверка кода на ошибки и стиль: + - Запуск глобальной проверки синтаксиса: ```bash yarn lint ``` -6. **AI Debug-панель (по желанию)** +6. **Панель отладки AI (Опционально)** - Запуск GUI для отладки AI SDK: + Запуск визуального инструмента отладки AI SDK: ```bash yarn debug:ai ``` -## Фронтенд разработка +## Разработка Frontend -Для редактирования интерфейса используйте фронт-репозиторий: +Если вам нужно внести изменения в пользовательский интерфейс, перейдите в репозиторий фронтенда: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -После сборки фронта (`dist/`) скопируйте его содержимое в `data/web/` основного проекта. +После сборки (build) фронтенда скопируйте всю папку `dist` в директорию `data/web` этого проекта для интеграции. ## Структура проекта ``` -📂 build/ # Скомпилированные файлы -📂 data/ # Данные во время работы -│ ├─ 📂 models/ # Локальные AI-модели (ONNX) -│ ├─ 📂 oss/ # Объектное хранилище (ассеты/персонажи/сцены) -│ ├─ 📂 serve/ # Вход в проде -│ ├─ 📂 skills/ # Prompt-словари умений Agent -│ └─ 📂 web/ # Скомпилированный фронтенд (встроен) -📂 docs/ # Документация -📂 env/ # Переменные окружения -📂 scripts/ # Скрипты и утилиты +📂 build/ # Артефакты сборки +📂 data/ # Данные времени выполнения (Runtime) +│ ├─ 📂 models/ # Локальные модели (ONNX) +│ ├─ 📂 oss/ # Object Storage (изображения, персонажи, сцены) +│ ├─ 📂 serve/ # Точка входа в Production-режим +│ ├─ 📂 skills/ # Промпты навыков Agent +│ └─ 📂 web/ # Скомпилированный Frontend (встроен в проект) +📂 docs/ # Документация и ресурсы +📂 env/ # Конфигурации окружения +📂 scripts/ # Скрипты сборки и вспомогательные скрипты 📂 src/ -├─ 📂 agents/ # AI agent-модули -│ ├─ 📂 productionAgent/ # Агент генерации -│ └─ 📂 scriptAgent/ # Агент сценария -├─ 📂 lib/ # Общие библиотеки -├─ 📂 middleware/ # Мидлвари -├─ 📂 routes/ # Роутинг модули -│ ├─ 📂 agents/ # Память агента -│ ├─ 📂 artStyle/ # Управление стилями -│ ├─ 📂 assets/ # Ассеты -│ ├─ 📂 assetsGenerate/ # Генерация ассетов -│ ├─ 📂 cornerScape/ # Раскадровка -│ ├─ 📂 general/ # Общие эндпоинты -│ ├─ 📂 login/ # Авторизация -│ ├─ 📂 migrate/ # Миграции -│ ├─ 📂 modelSelect/ # Выбор модели -│ ├─ 📂 novel/ # Управление романами -│ ├─ 📂 other/ # Другое -│ ├─ 📂 production/ # Управление производством -│ ├─ 📂 project/ # Управление проектом -│ ├─ 📂 script/ # Генерация сценария -│ ├─ 📂 scriptAgent/ # Эндпоинты агента сценария -│ ├─ 📂 setting/ # Настройки системы -│ ├─ 📂 task/ # Задачи -│ └─ 📂 test/ # Тестовые эндпоинты -├─ 📂 socket/ # RealTime WebSocket -├─ 📂 types/ # TypeScript типы -├─ 📂 utils/ # Утилиты -├─ 📄 app.ts # Точка входа -├─ 📄 core.ts # Инициализация ядра -├─ 📄 env.ts # Работа с окружением -├─ 📄 err.ts # Обработка ошибок -├─ 📄 logger.ts # Модуль логгирования -├─ 📄 router.ts # Регистрация роутов -└─ 📄 utils.ts # Вспомогательные функции -📄 Dockerfile # Dockerfile -📄 electron-builder.yml # Конфиг Electron Builder +├─ 📂 agents/ # Модули AI Agent +│ ├─ 📂 productionAgent/ # Production Agent (агент производства) +│ └─ 📂 scriptAgent/ # Script Agent (агент сценариев) +├─ 📂 lib/ # Общие библиотеки (инициализация БД, форматы ответов) +├─ 📂 middleware/ # Middleware +├─ 📂 routes/ # Модули маршрутизации +│ ├─ 📂 agents/ # Управление памятью Agent +│ ├─ 📂 artStyle/ # Управление художественными стилями +│ ├─ 📂 assets/ # Управление ассетами +│ ├─ 📂 assetsGenerate/ # Генерация ассетов +│ ├─ 📂 cornerScape/ # Управление раскадровкой (Storyboard) +│ ├─ 📂 general/ # Общие API +│ ├─ 📂 login/ # Аутентификация +│ ├─ 📂 migrate/ # Миграция данных +│ ├─ 📂 modelSelect/ # Выбор моделей +│ ├─ 📂 novel/ # Управление новеллами +│ ├─ 📂 other/ # Прочие функции +│ ├─ 📂 production/ # Управление производством и монтажом +│ ├─ 📂 project/ # Управление проектами +│ ├─ 📂 script/ # Генерация сценариев +│ ├─ 📂 scriptAgent/ # Интерфейс Script Agent +│ ├─ 📂 setting/ # Системные настройки +│ ├─ 📂 task/ # Управление задачами +│ └─ 📂 test/ # Тестовые API +├─ 📂 socket/ # Real-time коммуникация через WebSocket +├─ 📂 types/ # Типы TypeScript +├─ 📂 utils/ # Вспомогательные утилиты +├─ 📄 app.ts # Точка входа приложения (App Entry) +├─ 📄 core.ts # Инициализация ядра системы +├─ 📄 env.ts # Обработка переменных окружения +├─ 📄 err.ts # Обработка ошибок +├─ 📄 logger.ts # Модуль логирования +├─ 📄 router.ts # Регистрация маршрутов +└─ 📄 utils.ts # Общие утилиты +📄 Dockerfile # Файл для сборки Docker +📄 electron-builder.yml # Конфигурация сборки Electron 📄 skillList.json # Список навыков 📄 LICENSE # Лицензия (Apache-2.0) -📄 NOTICES.txt # Информация о сторонних зависимостях -📄 package.json # Конфиг пакетов -📄 tsconfig.json # Конфиг TypeScript +📄 NOTICES.txt # Уведомления о сторонних зависимостях +📄 package.json # Конфигурация проекта +📄 tsconfig.json # Конфигурация TypeScript ``` --- # 🔗 Связанные репозитории -| Репозиторий | Описание | GitHub | Gitee | -| ---------------- | ------------------------------------- | -------------------------------------------------- | ------------------------------------------------ | -| **Toonflow-app** | Полный клиент (этот, для обычных пользователей) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | -| **Toonflow-web** | Исходный код фронта (для фронтэндеров) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | +| Репозиторий | Описание | GitHub | Gitee | +|------------------|---------------------------------------------------------------|----------------------------------------------------|--------------------------------------------------| +| **Toonflow-app** | Полноценный клиент (этот репозиторий, рекомендуется для большинства пользователей) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | +| **Toonflow-web** | Исходный код Frontend (для frontend-разработчиков) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | -> 💡 **Подсказка:** если вы просто хотите пользоваться Toonflow — скачайте этот клиент. Отдельный frontend нужен только разработчикам UI. +> 💡 **Совет**: Если вы просто хотите использовать Toonflow, достаточно скачать клиент из этого репозитория. Репозиторий Toonflow-web предназначен только для разработчиков, желающих внести изменения или доработать интерфейс. --- -# 👨‍👩‍👧‍👦 WeChat-группы +# 👨‍👩‍👧‍👦 Discord сообщество -Ассистент по добавлению в группу: +Нажмите на иконку ниже, чтобы присоединиться к Discord: -Toonflow QR +[![Join our Discord](https://cdn.prod.website-files.com/6257adef93867e50d84d30e2/67d00cf7266d2c75571aebde_Example.svg)](https://discord.gg/HEjKmpNpAZ) + +Или перейдите по прямой ссылке: [https://discord.gg/HEjKmpNpAZ](https://discord.gg/HEjKmpNpAZ) --- -# 💌 Обратная связь +# 💌 Свяжитесь с нами -📧 Email: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow咨询) +📧 Email: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Запрос%20Toonflow) --- # 📜 Лицензия -Toonflow распространяется по лицензии Apache-2.0 с дополнительным коммерческим соглашением. +Toonflow распространяется как open-source проект под лицензией Apache-2.0 с дополнительным коммерческим соглашением. -Подробности: https://www.apache.org/licenses/LICENSE-2.0 +Подробнее о лицензии Apache-2.0: https://www.apache.org/licenses/LICENSE-2.0 -## Дополнительное соглашение +## Дополнительное коммерческое соглашение -- Если вы распространяете данное ПО как продукт **2 и более независимым третьим сторонам**, необходимо получить **письменную коммерческую лицензию** от HBAI-Ltd. -- **≤ 5 юридических лиц**, совместно использующих ПО для внутренних нужд без предоставления услуг третьим сторонам — это **внутреннее использование, лицензия не требуется**. -- Запрещено удалять или изменять товарные знаки, логотипы или уведомления об авторских правах Toonflow. +- Если данное ПО распространяется в виде продукта для **2 и более независимых третьих лиц**, необходимо получить **письменную коммерческую лицензию** от HBAI-Ltd. +- Если ПО используется совместно **не более чем 5 юридическими лицами** только для внутренних нужд (без оказания услуг внешним пользователям), это считается внутренним использованием и **лицензия не требуется**. +- Запрещается удалять или изменять логотипы и информацию об авторских правах в Toonflow. -## Всегда бесплатно — без лицензии +## Сценарии бессрочного бесплатного использования -- ✅ Создание контента в Toonflow и получение дохода на платформах -- ✅ Доработка для внутреннего использования команды -- ✅ ≤ 5 юрлиц — совместная внутренняя эксплуатация -- ✅ Личное обучение, исследования, некоммерческое использование +- ✅ Создание контента с помощью Toonflow и монетизация через видеоплатформы +- ✅ Вторичная разработка (secondary development) для внутреннего использования команды +- ✅ Совместное использование группой из ≤ 5 юридических лиц только внутри организации +- ✅ Личное обучение, научные исследования и любые некоммерческие цели -## Цены на коммерческую лицензию +## Тарифы коммерческой лицензии -| Этап | Годовой оборот | Годовая плата | -|------|---------|------| -| 🌱 Старт | < ¥100 тыс. | **Бесплатно** | -| 🚀 Стартап | ¥100–500 тыс. | ¥5 000/год | -| 📈 Рост | ¥500 тыс.–1,5 млн | ¥20 000/год | -| 🏢 Масштаб | ¥1,5–5 млн | ¥80 000/год | -| 🌐 Корпоративный | > ¥5 млн | По договорённости | +| Стадия | Годовая выручка | Годовой взнос | +|---------------------|-----------------------------|-----------------------| +| 🌱 Старт / Поддержка | < ¥100 000 RMB | **Бесплатно** | +| 🚀 Стартап | ¥100 000 – 500 000 RMB | ¥5,000 / год | +| 📈 Рост | ¥500 000 – 1 500 000 RMB | ¥20,000 / год | +| 🏢 Масштабирование | ¥1 500 000 – 5 000 000 RMB | ¥80,000 / год | +| 🌐 Корпоративный | > ¥5 000 000 RMB | Договорная цена | -> **Условие отсутствия обратной силы**: Пользователи, использовавшие Toonflow по AGPL-3.0 до релиза v1.0.8, продолжают работу по AGPL-3.0 и не затрагиваются данным изменением. +> **Оговорка о необратной силе**: Пользователи, которые использовали Toonflow под лицензией AGPL-3.0 до выхода версии v1.0.8, продолжают работать по правилам AGPL-3.0. Изменения данного соглашения на них не распространяются. -Полный текст соглашения см. в файле [LICENSE](../LICENSE). +Полный текст соглашения доступен в файле [LICENSE](./LICENSE). --- -# ⭐️ История звёзд +# ⭐️ История звезд (Star History) [![Star History Chart](https://api.star-history.com/svg?repos=HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left)](https://www.star-history.com/#HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left) @@ -556,32 +571,32 @@ Toonflow распространяется по лицензии Apache-2.0 с д # 🙏 Благодарности -Спасибо нижеперечисленным open-source проектам за мощную поддержку Toonflow: +Выражаем благодарность следующим open-source проектам за мощную поддержку Toonflow: -- [Express](https://expressjs.com/) — быстрый, открытый и лёгкий фреймворк для Node.js -- [AI SDK](https://ai-sdk.dev/) — инструменты AI для TypeScript -- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) — высокопроизводительная обвязка SQLite3 -- [Sharp](https://sharp.pixelplumbing.com/) — быстрая библиотека для работы с изображениями на Node.js -- [Axios](https://axios-http.com/) — HTTP-клиент на промисах -- [Zod](https://zod.dev/) — TS-first валидация схем -- [Socket.IO](https://socket.io/) — обмен событиями в реальном времени -- [Electron](https://www.electronjs.org/) — кроссплатформенный desktop-фреймворк -- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) — фреймворк для локального ML +- [Express](https://expressjs.com/) - Быстрый, гибкий и минималистичный веб-фреймворк для Node.js +- [AI SDK](https://ai-sdk.dev/) - AI инструментарий для TypeScript +- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - Библиотека с высокой производительностью для SQLite3 +- [Sharp](https://sharp.pixelplumbing.com/) - Высокопроизводительная библиотека Node.js для обработки изображений +- [Axios](https://axios-http.com/) - Promise-based HTTP клиент +- [Zod](https://zod.dev/) - Библиотека валидации схем, ориентированная на TypeScript +- [Socket.IO](https://socket.io/) - Движок для двунаправленной real-time связи на основе событий +- [Electron](https://www.electronjs.org/) - Фреймворк для кроссплатформенных десктоп-приложений +- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - Библиотека для локального ML инференса -Спасибо за поддержку проекту Toonflow от следующих организаций: +Спасибо следующим организациям/лицам за поддержку Toonflow:
- 算能云 Logo + Sophnet Logo - Sophnet Cloud — спонсор вычислительных ресурсов - [сайт] + Sophnet (算能云) Спонсор вычислительных мощностей + [Сайт]
-Полный список сторонних зависимостей — в файле `NOTICES.txt` +Полный список зависимостей третьих сторон находится в файле `NOTICES.txt`. -##### copyright © 淮北艾阿网络科技有限公司 \ No newline at end of file +##### copyright © Huaibei AIA Network Technology Co., Ltd. \ No newline at end of file diff --git a/docs/README.th.md b/docs/README.th.md index 9b2c0a4..d14814a 100644 --- a/docs/README.th.md +++ b/docs/README.th.md @@ -1,4 +1,4 @@ -

+

GitHub @@ -8,13 +8,12 @@  |  - Atomgit - Atomgit + Atomgit

- 简体中文 | + 简体中文 | 繁體中文 | English | ไทย | @@ -31,11 +30,11 @@

- โรงงานละครสั้น AI + โรงงานผลิตภาพยนตร์สั้น AI
- แตะเพียงครั้งเดียว นิยายกลายเป็นตอนทันที! + เพียงคลิกไม่กี่ครั้ง นิยายก็กลายเป็นภาพยนตร์ได้ในพริบตา!
- สคริปต์ AI × ภาพ AI × สร้างเร็วสายฟ้าแลบ 🔥 + บทภาพยนตร์ AI × ภาพ AI × สร้างวิดีโอความเร็วสูง 🔥

@@ -50,14 +49,14 @@

- > 🚀 **ผลิตละครสั้นครบวงจร:** จากข้อความสู่นักแสดง จากสตอรี่บอร์ดสู่วิดีโอ AI แบบเต็มกระบวนการ ทุกขั้นตอน ไม่มีอุปสรรค ประสิทธิภาพสร้าง 10 เท่าขึ้นไป! +> 🚀 **สตูดิโอภาพยนตร์สั้น All-in-One**: จากข้อความสู่ตัวละคร จากสตอรี่บอร์ดสู่ภาพยนตร์ ใช้ AI อัตโนมัติทั้งกระบวนการ ไม่ต้องมีพื้นฐานใด ๆ เพิ่มประสิทธิภาพการสร้างสรรค์มากกว่า 10 เท่า! --- -# � รองรับหลายภาษา +# 🌐 การรองรับหลายภาษา -Toonflow รองรับภาษาในอินเทอร์เฟซดังนี้: +Toonflow รองรับอินเทอร์เฟซภาษาดังต่อไปนี้: | ภาษา | Language | |------|----------| @@ -69,139 +68,144 @@ Toonflow รองรับภาษาในอินเทอร์เฟซ | 日本語 | Japanese | | Русский | Russian | +> 💡 กำลังเพิ่มการรองรับภาษาอื่นๆ ยินดีต้อนรับผู้ที่ต้องการช่วยแปล! + --- # 🌟 ฟีเจอร์หลัก -Toonflow คือเครื่องมือคอมิกละครสั้น AI ที่ใช้เทคโนโลยี AI แปลงนิยายเป็นสคริปต์โดยอัตโนมัติ และใช้ภาพและวิดีโอ AI เพื่อสร้างละครสั้นได้อย่างมีประสิทธิภาพ ด้วย Toonflow คุณสามารถสร้างผลงานจากข้อความสู่ภาพนิ่งจนถึงวิดีโอ ได้อย่างชาญฉลาดและสะดวก +Toonflow เป็นเครื่องมือ AI สำหรับสร้างภาพยนตร์สั้นและการ์ตูน ที่สามารถแปลงนิยายเป็นภาพยนตร์ได้โดยอัตโนมัติ ด้วยการผสานเทคโนโลยี AI ในการสร้างตัวละคร บทภาพยนตร์ ภาพประกอบ และวิดีโอ ทำให้กระบวนการผลิตภาพยนตร์สั้นมีประสิทธิภาพสูง ด้วย Toonflow คุณสามารถจัดการทุกขั้นตอนตั้งแต่ข้อความต้นฉบับจนถึงวิดีโอสำเร็จรูปได้อย่างง่ายดาย ทำให้การผลิตภาพยนตร์สั้นฉลาด สะดวก และรวดเร็วยิ่งขึ้น - ✅ **สร้างตัวละครอัตโนมัติ** - วิเคราะห์เนื้อหานิยายต้นฉบับ ระบุและสร้างข้อมูลตัวละครอย่างชาญฉลาด ทั้งรูปร่าง นิสัย ตัวตน เป็นต้น สร้างพื้นฐานที่แข็งแรงสำหรับสคริปต์และภาพในขั้นถัดไป -- ✅ **สร้างสคริปต์อัตโนมัติ** - จากเหตุการณ์และบทที่เลือก ระบบจะสร้างสคริปต์เชิงโครงสร้างอัตโนมัติ ครอบคลุมบทสนทนา คำบรรยายฉาก และทิศทางเนื้อเรื่อง เปลี่ยนข้อความวรรณกรรมเป็นสคริปต์ละครได้อย่างรวดเร็ว -- ✅ **ผลิตสตอรี่บอร์ดอัตโนมัติ** - ตามสคริปต์ สร้างพรอมต์สตอรี่บอร์ดและงานออกแบบภาพอัตโนมัติ รายละเอียดองค์ประกอบหน้า/กลาง/หลัง การเคลื่อนไหวตัวละคร อุปกรณ์ประกอบฉาก และการจัดวางฉาก พลิกสคริปต์เป็นสตอรี่บอร์ดวางแผนผลิตวิดีโอได้ครบถ้วน -- ✅ **ประกอบวิดีโอด้วย AI** - ผนวกเทคโนโลยีภาพและวิดีโอ AI สร้างคลิปวิดีโอด้วย AI รวมฟีเจอร์แก้ไขออนไลน์ รองรับการตั้งค่าผลลัพธ์ที่ปรับแต่งได้ ทำให้การสร้างภาพยนตร์/ละครมีประสิทธิภาพและทำงานร่วมทีมได้ + วิเคราะห์ข้อความจากนิยายต้นฉบับโดยอัตโนมัติ ระบุและสร้างโปรไฟล์ตัวละครอย่างชาญฉลาด รวมถึงรูปร่างหน้าตา นิสัย ตัวตน และรายละเอียดอื่น ๆ เพื่อสร้างพื้นฐานที่แข็งแรงสำหรับบทภาพยนตร์และภาพในขั้นตอนต่อไป + +- ✅ **สร้างบทภาพยนตร์** + จากเหตุการณ์และบท (Chapter) ที่เลือก ระบบจะสร้างบทภาพยนตร์ที่มีโครงสร้างชัดเจน ประกอบด้วยบทสนทนา คำอธิบายฉาก และทิศทางเรื่องราว ช่วยแปลงงานวรรณกรรมเป็นบทภาพยนตร์ได้อย่างมีประสิทธิภาพ + +- ✅ **สร้างสตอรี่บอร์ด (Storyboard)** + จากบทภาพยนตร์ ระบบจะสร้างพรอมต์และออกแบบเฟรมภาพสตอรี่บอร์ดโดยอัตโนมัติ โดยระบุรายละเอียดฉากหน้า ฉากกลาง ฉากหลัง การเคลื่อนไหวของตัวละคร พร็อพ และการจัดวางฉาก เพื่อสร้างแผนการผลิตวิดีโอที่สมบูรณ์ + +- ✅ **สังเคราะห์และตัดต่อวิดีโอ** + ใช้เทคโนโลยี AI สร้างคลิปวิดีโอคุณภาพสูง รองรับระบบตัดต่อออนไลน์ที่สามารถปรับแต่งได้ตามต้องการ ช่วยให้กระบวนการสร้างภาพยนตร์สั้นเป็นไปอย่างราบรื่นและรวดเร็ว --- -# 📦 ตัวอย่างการใช้งาน +# 📦 รูปแบบการใช้งาน (Use Cases) -- สร้างวิดีโอละครสั้น -- ทดลองแปลงนิยายสู่ภาพยนตร์/ละคร -- เครื่องมือดัดแปลงวรรณกรรมด้วย AI -- การพัฒนาสคริปต์และต้นแบบผลิตงานเร็ว -- สร้างวัตถุดิบประกอบวิดีโอ +- สร้างคอนเทนต์วิดีโอสั้น +- ทดลองแปลงนิยายเป็นภาพยนตร์สั้น +- เครื่องมือ AI ในการดัดแปลงวรรณกรรมเป็นภาพยนตร์ +- พัฒนาบทภาพยนตร์และสร้างต้นแบบ (Rapid Prototyping) อย่างรวดเร็ว +- สร้างฟุตเทจและวัสดุวิดีโอคุณภาพสูง ---- +# 🔰 คู่มือการใช้งาน -# 🔰 คู่มือผู้ใช้ +## 📺 วิดีโอสอนการใช้งาน -## 📺 วิดีโอสอนใช้งาน +[https://www.bilibili.com/video/BV1na6wB6Ea2](https://www.bilibili.com/video/BV1na6wB6Ea2) +[![เริ่มต้นสร้างวิดีโอ AI กับ Toonflow ใน 8 นาที](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) -https://www.bilibili.com/video/BV1na6wB6Ea2 -[![Toonflow 8-Minute Quick Start AI Video](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) - -**วิดีโอแนะนำ Toonflow ฉบับเร่งด่วน 8 นาที** +**เริ่มต้นสร้างวิดีโอ AI กับ Toonflow ใน 8 นาที** 👉 [คลิกเพื่อรับชม](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) -📱 สแกนด้วย WeChat บนมือถือเพื่อชม +📱 **สแกน QR Code เพื่อรับชมวิดีโอบนมือถือ** -Scan WeChat to Watch +สแกน QR Code เพื่อรับชมวิดีโอ --- # 🚀 การติดตั้ง -## สิ่งที่ต้องเตรียมก่อน +## ข้อกำหนดเบื้องต้น -ก่อนติดตั้งและใช้งานซอฟต์แวร์นี้ กรุณาเตรียมสิ่งเหล่านี้: +ก่อนติดตั้งและใช้งาน Toonflow โปรดเตรียมข้อมูลต่อไปนี้ให้พร้อม: -- ✅ ที่อยู่ API บริการ AI แบบ Large Language Model -- ✅ ที่อยู่ API บริการวิดีโอ Sora หรือ Doubao -- ✅ ที่อยู่ API โมเดลสร้างภาพ Nano Banana Pro +- ✅ ที่อยู่ API ของโมเดลภาษาขนาดใหญ่ (LLM) +- ✅ ที่อยู่ API ของบริการสร้างวิดีโอ (Sora หรือ Doubao) +- ✅ ที่อยู่ API ของโมเดลสร้างภาพ Nano Banana Pro -## ติดตั้งในเครื่อง (Local Installation) +## การติดตั้งบนเครื่อง (Local) ### 1. ดาวน์โหลดและติดตั้ง -| ระบบปฏิบัติการ | GitHub | Atomgit | ดาวน์โหลดผ่าน Quark Netdisk | หมายเหตุ | -| :------------: | :------------------------------------------------------- | :---------------------------------------------------- | :--------------------------------------------------- | :---------------------- | -| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Netdisk](https://pan.quark.cn/s/94ef07509df0) | แพ็กเกจติดตั้งอย่างเป็นทางการ | -| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Netdisk](https://pan.quark.cn/s/94ef07509df0) | แพ็กเกจติดตั้งอย่างเป็นทางการ | -| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Netdisk](https://pan.quark.cn/s/94ef07509df0) | แพ็กเกจติดตั้งอย่างเป็นทางการ | +| ระบบปฏิบัติการ | GitHub | Atomgit | ดาวน์โหลดผ่าน Quark Drive | คำอธิบาย | +| :------: | :----------------------------------------------------------- | :------------------------------------------------------------ | :---------------------------------------------- | :------------- | +| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | ตัวติดตั้งอย่างเป็นทางการ | +| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | ตัวติดตั้งอย่างเป็นทางการ | +| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | ตัวติดตั้งอย่างเป็นทางการ | > [!CAUTION] -> บน MacOS ให้ไปที่ ตั้งค่า - ความเป็นส่วนตัวและความปลอดภัย ตั้งค่าความปลอดภัยก่อน มิฉะนั้นอาจไม่สามารถเปิดแอปได้เพราะปัญหาใบรับรอง +> สำหรับระบบ macOS โปรดไปที่ **การตั้งค่า > ความเป็นส่วนตัวและความปลอดภัย** เพื่ออนุญาตให้แอปพลิเคชันทำงาน มิฉะนั้นอาจเปิดโปรแกรมไม่ได้เนื่องจากปัญหาใบรับรองความปลอดภัย > -> ดูเอกสารฉบับภาษาจีน: [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) +> อ้างอิงเอกสารจาก Zhihu: [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) -> ด้วยข้อจำกัดของสภาพแวดล้อม Gitee OS และขนาดไฟล์ Release การดาวน์โหลดผ่าน Gitee Release ยังไม่เปิดให้บริการในขณะนี้ +> เนื่องจากข้อจำกัดเรื่องสภาพแวดล้อมระบบและขนาดไฟล์ของ Gitee Release ปัจจุบันจึงยังไม่มีลิงก์ดาวน์โหลดบน Gitee -### 2. เปิดใช้งานโปรแกรม +### 2. เริ่มการทำงาน -ติดตั้งเสร็จแล้วให้เปิดโปรแกรมเพื่อเริ่มใช้งาน +หลังจากติดตั้งเสร็จสิ้น เพียงเปิดโปรแกรม Toonflow ก็สามารถเริ่มใช้งานได้ทันที -> ⚠️ **ล็อกอินครั้งแรก** +> ⚠️ **เข้าสู่ระบบครั้งแรก** > ชื่อผู้ใช้: `admin` > รหัสผ่าน: `admin123` -## การใช้ Docker +## การใช้งานผ่าน Docker -### สิ่งที่ต้องเตรียม +### ข้อกำหนดเบื้องต้น -- ติดตั้ง [Docker](https://docs.docker.com/get-docker/) (เวอร์ชัน 20.10+) +- ติดตั้ง [Docker](https://docs.docker.com/get-docker/) เวอร์ชัน 20.10 ขึ้นไป เรียบร้อยแล้ว -### วิธีที่ 1: ติดตั้งออนไลน์ +### วิธีที่ 1: การติดตั้งออนไลน์ -กำลังพัฒนา; ขณะนี้ให้ใช้การ build ในเครื่อง +กำลังพัฒนา +ปัจจุบันแนะนำให้ใช้วิธี Build บนเครื่องก่อน -### วิธีที่ 2: สร้างเองในเครื่อง +### วิธีที่ 2: การ Build บนเครื่อง -สำหรับนักพัฒนา หรือผู้ที่ clone repo แล้ว ต้องติดตั้ง Git ที่เครื่อง +ใช้วิธี Build จากซอร์สโค้ดที่มีอยู่ในเครื่องโดยตรง +เหมาะสำหรับนักพัฒนาหรือผู้ใช้ที่โคลน Repository มาแล้ว (ต้องติดตั้ง Git บนเครื่องก่อน) ```shell -# clone โปรเจกต์ (ถ้าทำแล้วข้าม) +# โคลนโปรเจกต์ก่อน (ข้ามขั้นตอนนี้ถ้ามีอยู่แล้ว) git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app -# สร้างและเริ่มผ่าน docker-compose +# ใช้ docker-compose ในการ Build และรันบนเครื่อง yarn docker:local -# หรือสร้างแบบ manual +# หรือทำการ Build แบบแมนนวล docker build -t toonflow . -docker run -d -p :10588 -v :/app/data toonflow +docker run -d -p <พอร์ตบนเครื่อง>:10588 -v <พาธข้อมูลบนเครื่อง>:/app/data toonflow -# ใช้งานที่ /web/index.html ในพอร์ตที่แม็ปไว้ เช่น -# http://localhost:10588/web/index.html +# จากนั้นสามารถเข้าถึงหน้าเว็บผ่านพอร์ตที่ระบุ ที่พาธ /web/index.html +# ตัวอย่าง: http://localhost:10588/web/index.html ``` -### รายละเอียดพอร์ตบริการ +### คำอธิบายพอร์ตบริการ -| พอร์ต | วัตถุประสงค์ | Mapping ในการติดตั้ง | -| -------- | ------------ | -------------------- | -| `10588` | ส่วนติดต่อแอป | `10588:10588` | +| พอร์ต | การใช้งาน | การจับคู่พอร์ต (Mapping) | +| ------- | ---------------------- | ------------------------ | +| `10588` | พอร์ตบริการหลัก (API) | `10588:10588` | -**รายละเอียดตัวแปรแวดล้อม:** +**คำอธิบายตัวแปรสภาพแวดล้อม (Environment Variables):** -| ตัวแปร | รายละเอียด | -| ------------- | ----------------------------------------- | -| `NODE_ENV` | สภาพแวดล้อม เลือก `prod` คือ production | -| `PORT` | พอร์ตการฟังบริการ (ค่าเริ่มต้น 10588) | -| `OSSURL` | ที่อยู่สำหรับเข้าถึงไฟล์ static | +| ตัวแปร | คำอธิบาย | +| ---------- | ----------------------------------------------------- | +| `NODE_ENV` | สภาพแวดล้อมการทำงาน (`prod` = Production) | +| `PORT` | พอร์ตสำหรับให้บริการ (ค่าเริ่มต้น 10588) | +| `OSSURL` | ที่อยู่ OSS สำหรับเก็บและโหลดไฟล์สาธารณะ (Static files) | --- -## ติดตั้งบน Cloud +## การติดตั้งบนคลาวด์ / เซิร์ฟเวอร์ -### 1. ข้อกำหนดเครื่องเซิร์ฟเวอร์ +### 1. ข้อกำหนดสภาพแวดล้อมเซิร์ฟเวอร์ -- **ระบบปฏิบัติการ:** Ubuntu 20.04+ / CentOS 7+ -- **Node.js:** 24.x (แนะนำ ขั้นต่ำ 23.11.1+) -- **RAM:** 2GB ขึ้นไป +- **ระบบปฏิบัติการ**: Ubuntu 20.04+ / CentOS 7+ +- **Node.js**: 24.x (แนะนำ, ขั้นต่ำ 23.11.1+) +- **RAM**: 2GB+ -### 2. วิธีติดตั้ง +### 2. การติดตั้งบนเซิร์ฟเวอร์ #### 1. ติดตั้งสภาพแวดล้อม @@ -214,9 +218,9 @@ nvm install 24 npm install -g yarn pm2 ``` -#### 2. ติดตั้งโปรเจกต์ +#### 2. ดึงโค้ดโปรเจกต์ -**Clone จาก GitHub:** +**โคลนจาก GitHub:** ```bash cd /opt @@ -226,7 +230,7 @@ yarn install yarn build ``` -**Clone จาก Gitee (แนะนำในจีนแผ่นดินใหญ่):** +**โคลนจาก Gitee (แนะนำสำหรับประเทศจีน):** ```bash cd /opt @@ -254,17 +258,17 @@ yarn build } ``` -**รายละเอียดตัวแปรแวดล้อม:** +**คำอธิบายตัวแปรสภาพแวดล้อม (Environment Variables):** -| ตัวแปร | รายละเอียด | -| ------------- | ---------------------------------------- | -| `NODE_ENV` | สภาพแวดล้อม เลือก `prod` คือ production | -| `PORT` | พอร์ตให้บริการ | -| `OSSURL` | ที่อยู่สำหรับเข้าถึงไฟล์ static | +| ตัวแปร | คำอธิบาย | +| ---------- | ----------------------------------------------------- | +| `NODE_ENV` | สภาพแวดล้อมการทำงาน (`prod` = Production) | +| `PORT` | พอร์ตสำหรับให้บริการ (ค่าเริ่มต้น 10588) | +| `OSSURL` | ที่อยู่ OSS สำหรับเก็บและโหลดไฟล์สาธารณะ (Static files) | --- -#### 4. เริ่มบริการ +#### 4. เริ่มการทำงาน ```bash pm2 start pm2.json @@ -275,281 +279,290 @@ pm2 save #### 5. คำสั่งที่ใช้บ่อย ```bash -pm2 list # ดูรายชื่อโปรเซส -pm2 logs toonflow-app # ดู Log -pm2 restart all # รีสตาร์ทบริการ -pm2 monit # ดูระบบแบบเรียลไทม์ +pm2 list # ดู Process ทั้งหมด +pm2 logs toonflow-app # ดู Logs +pm2 restart all # รีสตาร์ทเซอร์วิส +pm2 monit # เปิดหน้าต่าง Monitoring ``` -> ⚠️ **ล็อกอินครั้งแรก** +> ⚠️ **เข้าสู่ระบบครั้งแรก** > ชื่อผู้ใช้: `admin` > รหัสผ่าน: `admin123` -#### 6. ติดตั้งส่วนหน้าเว็บไซต์ +#### 6. การติดตั้งเว็บไซต์ฟรอนต์เอนด์ (Frontend) -ถ้าต้องการใช้ Frontend แยก หรือปรับแต่ UI ศึกษาที่ repo ส่วน frontend: +หากต้องการติดตั้งหรือปรับแต่งอินเทอร์เฟซฟรอนต์เอนด์แยกต่างหาก โปรดอ้างอิง Repository ฟรอนต์เอนด์ดังนี้: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -> 💡 **หมายเหตุ:** รีโปนี้ใส่ frontend ที่ compile แล้วมาด้วย ผู้ใช้ทั่วไปไม่จำเป็นต้องติดตั้ง frontend แยก Repo frontend ใช้สำหรับนักพัฒนาที่ต้องการพัฒนาต่อ +> 💡 **หมายเหตุ**: Repository นี้มาพร้อมไฟล์ฟรอนต์เอนด์ที่คอมไพล์เสร็จสมบูรณ์แล้ว +> ผู้ใช้ทั่วไปไม่จำเป็นต้องติดตั้งฟรอนต์เอนด์แยก Repository นี้มีไว้สำหรับนักพัฒนาที่ต้องการปรับแต่งหรือพัฒนาเพิ่มเติมเท่านั้น --- -# 🔧 คู่มือนักพัฒนา +# 🔧 คู่มือสำหรับนักพัฒนา (Development Workflow Guide) > [!CAUTION] -> 🚧 **แนวทางการส่ง PR** 🚧 +> 🚧 **ข้อบังคับในการส่ง Pull Request** 🚧 > -> ⛔ `master` ไม่รับ PR | ✅ ส่ง PR ที่ `develop` +> ⛔ **ไม่รับ PR ใน branch `master`**|✅ **โปรดส่ง PR ไปที่ branch `develop`** > -> เชิญนักพัฒนาร่วมพัฒนา Toonflow ติดต่อเจ้าของ ACT ในแชทกลุ่ม +> ยินดีต้อนรับนักพัฒนาทุกท่านที่สนใจร่วมพัฒนา Toonflow +> หากต้องการเข้าร่วม โปรดติดต่อผู้ดูแลโปรเจกต์ (ACT) ในกลุ่มพูดคุย -## 🛠️ Tech Stack +## 🛠️ เทคโนโลยีที่ใช้ (Tech Stack) -| หมวด | เทคโนโลยี | -| ------------ | ------------------------------------------------------------------------------------ | -| Runtime | Node.js 23.11.1+ | -| Language | TypeScript 5.x | -| Backend | Express 5 | -| Database | SQLite (better-sqlite3 / knex) | -| AI Integration | Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhipu / MiniMax / Qwen / xAI) | -| Local Inference | @huggingface/transformers (ONNX) | -| Real-Time | Socket.IO | -| Desktop | Electron 40 | -| Image Proc. | Sharp | -| Container | Docker | +| ประเภท | เทคโนโลยี | +| ---------- | ----------------------------------------------------------------------------------------- | +| Runtime | Node.js 23.11.1+ | +| Language | TypeScript 5.x | +| Backend | Express 5 | +| Database | SQLite (better-sqlite3 / knex) | +| AI Integ. | Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhipu / MiniMax / Qwen / xAI) | +| Local Inf. | @huggingface/transformers (ONNX) | +| Real-time | Socket.IO | +| Desktop | Electron 40 | +| Image Proc.| Sharp | +| Container | Docker | -## เตรียมสภาพแวดล้อม +## การเตรียมสภาพแวดล้อมการพัฒนา -- **Node.js:** ต้องใช้ 23.11.1 ขึ้นไปเท่านั้น -- **Yarn:** แนะนำให้ใช้เป็น package manager +- **Node.js**: ต้องใช้เวอร์ชัน 23.11.1 ขึ้นไป +- **Yarn**: แนะนำให้ใช้เป็น Package Manager -## เริ่มพัฒนาอย่างรวดเร็ว +## การเริ่มโปรเจกต์อย่างรวดเร็ว -1. **Clone โปรเจกต์** +1. **โคลนโปรเจกต์** - **GitHub:** + **โคลนจาก GitHub:** ```bash git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` - **Gitee (ในจีนแผ่นดินใหญ่แนะนำ):** + **โคลนจาก Gitee (แนะนำสำหรับประเทศจีน):** ```bash git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` -2. **ติดตั้ง dependencies** +2. **ติดตั้ง Dependencies** - รันที่ root directory: + ให้รันคำสั่งด้านล่างนี้ใน root ของโปรเจกต์เพื่อติดตั้ง Dependencies: ```bash yarn install ``` -3. **เริ่มสภาพแวดล้อมพัฒนา** +3. **เริ่มใช้งานในโหมด Development** - โปรเจกต์นี้มี **backend API service** และ **frontend interface** เลือกวิธีเริ่มต้นได้: + โปรเจกต์นี้ประกอบด้วย **บริการ Backend API** และ **หน้า Frontend** คุณสามารถเลือกวิธีการเปิดใช้งานได้ตามต้องการ: - - **ตัวเลือก 1: เริ่ม backend อย่างเดียว** + - **วิธีที่ 1: รันเฉพาะ Backend อย่างเดียว** ```bash yarn dev ``` - > ⚠️ คำสั่งนี้เปิดเฉพาะ backend API (พอร์ต 10588) **ไม่มี web UI** การเข้า http://localhost:10588 คือเรียก API เท่านั้น การใช้ web UI เต็มรูปแบบใช้วิธีด้านล่าง + > ⚠️ คำสั่งนี้จะรัน **เฉพาะ Backend API** (พอร์ต 10588) **โดยไม่มีหน้า Frontend** + > เมื่อเข้าถึง `http://localhost:10588` จะสามารถเรียกใช้งาน API ได้เท่านั้น + > หากต้องการใช้งานพร้อมกับหน้าเว็บ Frontend โปรดรัน Frontend แยกต่างหาก หรือใช้โหมด GUI ด้านล่างนี้ - - **ตัวเลือก 2: เริ่ม Electron desktop client** + - **วิธีที่ 2: รัน Electron Desktop Client** ```bash yarn dev:gui ``` - > คำสั่งนี้เปิดทั้ง backend และ Electron window มี web UI built-in พร้อมใช้งาน + > คำสั่งนี้จะรันทั้ง Backend และหน้าต่าง Electron Desktop พร้อมกัน โดยมี Frontend ฝังมาในตัว + > โปรแกรมพร้อมใช้งานทันทีโดยไม่ต้องตั้งค่าเพิ่มเติม + > เหมาะสำหรับนักพัฒนาที่ต้องการทดสอบฟีเจอร์ทั้งหมดของแอปพลิเคชัน - - **ตัวเลือก 3: โหมด production** + - **วิธีที่ 3: รันโหมด Production** ```bash yarn start ``` - > รันทั้ง backend แบบโปรดักชั่น (ต้อง `yarn build` ก่อน) + > รันโปรแกรมในโหมด Production ทันทีหลังจากที่คอมไพล์เสร็จ (ต้องรัน `yarn build` ก่อน) -4. **คอมไพล์โปรเจกต์** +4. **การแพ็คโปรเจกต์ (Build/Dist)** - - คอมไพล์ TypeScript: + - คอมไพล์และสร้างไฟล์ TypeScript: ```bash yarn build ``` - - สร้าง executable สำหรับ Windows: + - แพ็คโปรเจกต์เป็นไฟล์รัน (Executable) สำหรับ Windows: ```bash yarn dist:win ``` - - สร้าง executable สำหรับ Mac: + - แพ็คโปรเจกต์สำหรับ macOS: ```bash yarn dist:mac ``` - - สร้าง executable สำหรับ Linux: + - แพ็คโปรเจกต์สำหรับ Linux: ```bash yarn dist:linux ``` -5. **ตรวจสอบคุณภาพโค้ด** +5. **ตรวจสอบคุณภาพโค้ด (Lint)** - - เช็ค lint: + - ทำการตรวจสอบไวยากรณ์และข้อกำหนดโค้ด (Linting) ทั้งหมด: ```bash yarn lint ``` -6. **AI Debug panel (ไม่บังคับ)** +6. **แผงควบคุมดีบัก AI (ตัวเลือก)** - รัน Visual Debugging Tool ของ Vercel AI SDK เพื่อ debug integration AI ได้ง่ายขึ้น: + เปิดใช้งานเครื่องมือดีบักแบบ Visual ของ AI SDK เพื่อความสะดวกในการดีบักการเรียกใช้ AI: ```bash yarn debug:ai ``` -## การพัฒนา Frontend +## การพัฒนาฟรอนต์เอนด์ (Frontend) -หากต้องการพัฒนา UI แก้ไขที่ frontend repo: +หากต้องการแก้ไขหรือพัฒนาอินเทอร์เฟซฟรอนต์เอนด์ โปรดไปที่ Repository ฟรอนต์เอนด์ดังนี้: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -หลัง build frontend แล้ว ให้นำไฟล์ใน `dist` ไปวางใน `data/web` ของโปรเจกต์นี้ +หลังจาก Build ฟรอนต์เอนด์เสร็จสิ้นแล้ว ให้คัดลอกโฟลเดอร์ `dist` ทั้งหมดไปวางในโฟลเดอร์ `data/web` ของโปรเจกต์นี้เพื่อทำการรวมเข้ากับระบบ ## โครงสร้างโปรเจกต์ ``` -📂 build/ # ผลลัพธ์หลังคอมไพล์ -📂 data/ # ข้อมูล runtime -│ ├─ 📂 models/ # โมเดล inference ในเครื่อง (ONNX) -│ ├─ 📂 oss/ # ที่เก็บวัตถุ (assets/character/scene) -│ ├─ 📂 serve/ # จุดเริ่ม production -│ ├─ 📂 skills/ # เอเจนท์พรอมต์ทักษะต่างๆ -│ └─ 📂 web/ # asset frontend ที่มาในตัว -📂 ./ # เอกสาร -📂 env/ # ไฟล์ config environment -📂 scripts/ # script สร้างและช่วยงาน +📂 build/ # ผลลัพธ์หลัง Build +📂 data/ # ข้อมูล Runtime +│ ├─ 📂 models/ # โมเดล Infer บนเครื่อง (ONNX) +│ ├─ 📂 oss/ # Object Storage (เก็บภาพ ตัวละคร และฉาก) +│ ├─ 📂 serve/ # จุดเข้าใช้งานโหมด Production +│ ├─ 📂 skills/ # Prompt ทักษะของ Agent +│ └─ 📂 web/ # Frontend ที่ Build แล้ว (ฝังมาในตัว) +📂 docs/ # เอกสารและรูปภาพคู่มือ +📂 env/ # การตั้งค่าสภาพแวดล้อม +📂 scripts/ # สคริปต์ช่วยเหลือและ Build 📂 src/ -├─ 📂 agents/ # โมดูล AI Agent ต่างๆ -│ ├─ 📂 productionAgent/ # เอเจนท์ผลิตงาน -│ └─ 📂 scriptAgent/ # เอเจนท์สคริปต์ -├─ 📂 lib/ # ไลบรารีทั่วไป (db, response) -├─ 📂 middleware/ # Middleware ต่างๆ -├─ 📂 routes/ # เส้นทาง API หลัก -│ ├─ 📂 agents/ # จัดการความจำเอเจนท์ -│ ├─ 📂 artStyle/ # จัดการสไตล์ศิลปะ -│ ├─ 📂 assets/ # จัดการ asset -│ ├─ 📂 assetsGenerate/ # สร้าง asset อัตโนมัติ -│ ├─ 📂 cornerScape/ # จัดการสตอรี่บอร์ด -│ ├─ 📂 general/ # API ทั่วไป -│ ├─ 📂 login/ # ยืนยันตัวตนเข้าใช้ -│ ├─ 📂 migrate/ # ย้ายโครงสร้างข้อมูล -│ ├─ 📂 modelSelect/ # จัดการเลือกโมเดล -│ ├─ 📂 novel/ # จัดการนิยาย -│ ├─ 📂 other/ # ฟีเจอร์อื่นๆ -│ ├─ 📂 production/ # จัดการการผลิต -│ ├─ 📂 project/ # จัดการโปรเจกต์ -│ ├─ 📂 script/ # สร้างสคริปต์ -│ ├─ 📂 scriptAgent/ # Endpoint AI Agent สคริปต์ -│ ├─ 📂 setting/ # ตั้งค่าระบบ -│ ├─ 📂 task/ # จัดการงาน -│ └─ 📂 test/ # ทดสอบ API -├─ 📂 socket/ # การสื่อสาร WebSocket -├─ 📂 types/ # TypeScript type definitions -├─ 📂 utils/ # ฟังก์ชันอรรถประโยชน์ -├─ 📄 app.ts # จุดเข้าแอป -├─ 📄 core.ts # core initialization -├─ 📄 env.ts # ตัวแปร env -├─ 📄 err.ts # จัดการ error -├─ 📄 logger.ts # log โมดูล -├─ 📄 router.ts # ลงทะเบียน route ต่าง ๆ -└─ 📄 utils.ts # เครื่องมือทั่วไป -📄 Dockerfile # config สำหรับ docker build -📄 electron-builder.yml # config แพ็ค Electron +├─ 📂 agents/ # โมดูล AI Agent +│ ├─ 📂 productionAgent/ # Agent ฝ่ายผลิต (Production) +│ └─ 📂 scriptAgent/ # Agent ฝ่ายบทภาพยนตร์ (Script) +├─ 📂 lib/ # ไลบรารีส่วนกลาง (Init ฐานข้อมูล, รูปแบบ Response) +├─ 📂 middleware/ # Middleware +├─ 📂 routes/ # โมดูล Routing +│ ├─ 📂 agents/ # จัดการหน่วยความจำ Agent +│ ├─ 📂 artStyle/ # จัดการสไตล์ภาพศิลป์ +│ ├─ 📂 assets/ # จัดการ Asset +│ ├─ 📂 assetsGenerate/ # สร้าง Asset +│ ├─ 📂 cornerScape/ # จัดการสตอรี่บอร์ด (Storyboard) +│ ├─ 📂 general/ # API ทั่วไป +│ ├─ 📂 login/ # การยืนยันตัวตน +│ ├─ 📂 migrate/ # Migration ข้อมูล +│ ├─ 📂 modelSelect/ # เลือกโมเดล +│ ├─ 📂 novel/ # จัดการนวนิยายต้นฉบับ +│ ├─ 📂 other/ # ฟังก์ชันอื่น ๆ +│ ├─ 📂 production/ # จัดการการผลิต/ตัดต่อ +│ ├─ 📂 project/ # จัดการโปรเจกต์ +│ ├─ 📂 script/ # สร้างบทภาพยนตร์ +│ ├─ 📂 scriptAgent/ # Interface ของ Script Agent +│ ├─ 📂 setting/ # ตั้งค่าระบบ +│ ├─ 📂 task/ # จัดการ Task +│ └─ 📂 test/ # API ทดสอบ +├─ 📂 socket/ # การสื่อสารเรียลไทม์ผ่าน WebSocket +├─ 📂 types/ # ประกาศ TypeScript Types +├─ 📂 utils/ # ฟังก์ชันยูทิลิตี้ +├─ 📄 app.ts # จุดเริ่มต้นของแอปพลิเคชัน (App Entry) +├─ 📄 core.ts # เริ่มต้น Core ระบบ +├─ 📄 env.ts # จัดการตัวแปร Environment +├─ 📄 err.ts # จัดการ Error +├─ 📄 logger.ts # โมดูล Logger +├─ 📄 router.ts # ลงทะเบียน Router +└─ 📄 utils.ts # ฟังก์ชันอรรถประโยชน์ทั่วไป +📄 Dockerfile # ไฟล์สร้าง Docker +📄 electron-builder.yml # การตั้งค่าการแพ็ค Electron 📄 skillList.json # รายการทักษะ -📄 LICENSE # ใบอนุญาต Apache-2.0 -📄 NOTICES.txt # รายงานไลบรารีที่ใช้ -📄 package.json # config โปรเจกต์ -📄 tsconfig.json # TypeScript config +📄 LICENSE # สัญญาอนุญาต (Apache-2.0) +📄 NOTICES.txt # ประกาศไลบรารี Third-party +📄 package.json # การตั้งค่าโปรเจกต์ +📄 tsconfig.json # การตั้งค่า TypeScript ``` --- -# 🔗 รีโพที่เกี่ยวข้อง +# 🔗 Repository ที่เกี่ยวข้อง -| รีโพ | คำอธิบาย | GitHub | Gitee | -| ------------ | ----------------- | ----------------------------------------------- | -------------------------------------------- | -| **Toonflow-app** | ตัวเต็ม (รีโปนี้, สำหรับผู้ใช้) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | -| **Toonflow-web** | ซอร์ส frontend (สำหรับ dev FE) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | +| Repository | คำอธิบาย | GitHub | Gitee | +| ---------------- | --------------------------------------------- | -------------------------------------------------- | ------------------------------------------------ | +| **Toonflow-app** | ไคลเอนต์แบบสมบูรณ์ (Repository นี้ แนะนำสำหรับผู้ใช้ทั่วไป) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | +| **Toonflow-web** | ซอร์สโค้ดฟรอนต์เอนด์ (เหมาะสำหรับนักพัฒนาฟรอนต์เอนด์) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | -> 💡 **หมายเหตุ:** ถ้าแค่ต้องการใช้งาน ดาวน์โหลดไคลเอนต์จากรีโปนี้ได้เลย รีโป frontend เหมาะสำหรับ dev ที่จะพัฒนา UI ต่อ +> 💡 **เคล็ดลับ**: หากคุณต้องการใช้งาน Toonflow เพียงดาวน์โหลดไคลเอนต์จาก Repository นี้ก็เพียงพอแล้ว +> Repository Toonflow-web มีไว้สำหรับนักพัฒนาที่ต้องการปรับแต่งหรือพัฒนาต่อยอดอินเทอร์เฟซเท่านั้น --- -# 👨‍👩‍👧‍👦 กลุ่ม WeChat +# 👨‍👩‍👧‍👦 กลุ่ม Discord ชุมชน -ผู้ช่วยกลุ่ม: +คลิกที่ไอคอนด้านล่างเพื่อเข้าร่วม Discord: -Toonflow QR +[![Join our Discord](https://cdn.prod.website-files.com/6257adef93867e50d84d30e2/67d00cf7266d2c75571aebde_Example.svg)](https://discord.gg/HEjKmpNpAZ) + +หรือคลิกลิงก์โดยตรง: [https://discord.gg/HEjKmpNpAZ](https://discord.gg/HEjKmpNpAZ) --- # 💌 ติดต่อเรา -📧 อีเมล: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow inquiry) +📧 อีเมล: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=สอบถาม%20เรื่อง%20Toonflow) --- -# 📜 ใบอนุญาต +# 📜 ใบอนุญาต (License) -Toonflow เป็นโอเพ่นซอร์สภายใต้ Apache-2.0 พร้อมข้อตกลงเชิงพาณิชย์เพิ่มเติม +Toonflow เปิดเผยเป็นโอเพ่นซอร์สภายใต้สัญญาอนุญาต Apache-2.0 พร้อมด้วยข้อตกลงเชิงพาณิชย์เพิ่มเติม -รายละเอียด: https://www.apache.org/licenses/LICENSE-2.0 +รายละเอียดสัญญา Apache-2.0: https://www.apache.org/licenses/LICENSE-2.0 -## ข้อตกลงเพิ่มเติม +## ข้อตกลงเชิงพาณิชย์เพิ่มเติม -- หากแจกจ่ายซอฟต์แวร์นี้ในฐานะผลิตภัณฑ์ให้ **บุคคลที่สามอิสระ 2 รายขึ้นไป** ต้องได้รับ **อนุญาตเชิงพาณิชย์เป็นลายลักษณ์อักษร** จาก HBAI-Ltd -- **≤ 5 นิติบุคคล** ร่วมดำเนินงานภายในโดยไม่ให้บริการภายนอก ถือเป็น **การใช้งานภายใน ไม่ต้องขออนุญาต** -- ห้ามลบหรือแก้ไขเครื่องหมายการค้า โลโก้ หรือข้อมูลลิขสิทธิ์ใน Toonflow +- หากนำซอฟต์แวร์นี้ไปเผยแพร่ในรูปแบบผลิตภัณฑ์ให้กับ **บุคคลที่สามอิสระตั้งแต่ 2 รายขึ้นไป** ต้องได้รับ **การอนุญาตเชิงพาณิชย์เป็นลายลักษณ์อักษร** จาก HBAI-Ltd +- หากใช้งานร่วมกันภายในโดย **นิติบุคคลไม่เกิน 5 ราย** และไม่ให้บริการแก่บุคคลภายนอก จะถือเป็นการใช้งานภายในและ **ไม่ต้องขออนุญาต** +- ห้ามลบหรือแก้ไขโลโก้หรือข้อมูลลิขสิทธิ์ภายใน Toonflow -## ใช้งานฟรีตลอดกาล +## กรณีใช้งานฟรีตลอดชีพ -- ✅ ใช้ Toonflow สร้างเนื้อหาและรับส่วนแบ่งรายได้จากแพลตฟอร์ม -- ✅ พัฒนาต่อยอดสำหรับทีมภายใน -- ✅ ≤ 5 นิติบุคคลร่วมดำเนินงานภายใน -- ✅ เรียนรู้ส่วนตัว วิจัย และใช้งานที่ไม่ใช่เชิงพาณิชย์ +- ✅ ใช้ Toonflow สร้างเนื้อหาเพื่อรับส่วนแบ่งรายได้จากแพลตฟอร์มวิดีโอ +- ✅ นำโค้ดไปพัฒนาต่อยอดเพื่อใช้งานภายในทีม +- ✅ ใช้งานร่วมกันภายในโดยนิติบุคคลไม่เกิน 5 ราย +- ✅ เพื่อการศึกษา การวิจัย และวัตถุประสงค์ที่ไม่ใช่เชิงพาณิชย์ -## ราคาใบอนุญาตเชิงพาณิชย์ +## โครงสร้างราคาการอนุญาตเชิงพาณิชย์ -| ระยะ | ยอดขายต่อปี | ค่าธรรมเนียมต่อปี | -|------|---------|------| -| 🌱 บ่มเพาะ | < ¥100,000 | **ฟรี** | -| 🚀 สตาร์ทอัพ | ¥100,000–500,000 | ¥5,000/ปี | -| 📈 เติบโต | ¥500,000–1,500,000 | ¥20,000/ปี | -| 🏢 ขยายตัว | ¥1,500,000–5,000,000 | ¥80,000/ปี | -| 🌐 องค์กร | > ¥5,000,000 | เจรจา | +| ระยะ | ยอดขายรายปี | ค่าธรรมเนียมรายปี | +|--------------|-----------------------------|-----------------------| +| 🌱 ช่วงเริ่มต้น (Incubation) | < ¥100,000 | **ฟรี** | +| 🚀 ช่วง startup | ¥100,000 – 500,000 | ¥5,000 / ปี | +| 📈 ช่วงเติบโต (Growth) | ¥500,000 – 1,500,000 | ¥20,000 / ปี | +| 🏢 ช่วงขยายขนาด (Scale) | ¥1,500,000 – 5,000,000 | ¥80,000 / ปี | +| 🌐 ระดับองค์กร (Enterprise) | > ¥5,000,000 | เจรจาต่อรอง | -> **เงื่อนไขไม่ย้อนหลัง**: ผู้ใช้ที่ใช้ Toonflow ภายใต้ AGPL-3.0 ก่อนการเผยแพร่ v1.0.8 จะไม่ได้รับผลกระทบจากการเปลี่ยนแปลงนี้ การใช้งานปัจจุบันยังคงเป็นไปตาม AGPL-3.0 +> **ข้อกำหนดไม่ย้อนหลัง (Non-Retroactivity)**: ผู้ใช้ที่เคยใช้งาน Toonflow ภายใต้สัญญา AGPL-3.0 ก่อนเวอร์ชัน v1.0.8 จะยังคงผูกพันตาม AGPL-3.0 ต่อไป และไม่ได้รับผลกระทบจากการเปลี่ยนแปลงข้อตกลงนี้ -ดูข้อตกลงฉบับเต็มที่ [LICENSE](../LICENSE) +ดูรายละเอียดข้อตกลงฉบับเต็มได้ที่ไฟล์ [LICENSE](./LICENSE) --- -# ⭐️ ประวัติการกดดาว +# ⭐️ ประวัติการให้ดาว (Star History) [![Star History Chart](https://api.star-history.com/svg?repos=HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left)](https://www.star-history.com/#HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left) @@ -557,32 +570,32 @@ Toonflow เป็นโอเพ่นซอร์สภายใต้ Apache- # 🙏 ขอขอบคุณ -ขอบคุณโอเพ่นซอร์สต่อไปนี้ที่สนับสนุน Toonflow: +ขอขอบคุณโปรเจกต์โอเพ่นซอร์สต่อไปนี้ที่ช่วยสนับสนุน Toonflow อย่างมาก: -- [Express](https://expressjs.com/) - เฟรมเวิร์ก Node.js ที่เร็ว เล็ก และเปิดกว้าง -- [AI SDK](https://ai-sdk.dev/) - ชุดเครื่องมือ AI-first สำหรับ TypeScript -- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - Binding SQLite3 ประสิทธิภาพสูง -- [Sharp](https://sharp.pixelplumbing.com/) - ไลบรารีจัดการภาพบน Node.js ประสิทธิภาพสูง -- [Axios](https://axios-http.com/) - HTTP client แบบ Promise -- [Zod](https://zod.dev/) - ไลบรารีตรวจสอบชนิด TypeScript เป็นหลัก -- [Socket.IO](https://socket.io/) - เฟรมเวิร์ก event bidirectional แบบเรียลไทม์ -- [Electron](https://www.electronjs.org/) - เฟรมเวิร์กสร้างแอปเดสก์ท็อปข้ามแพลตฟอร์ม -- [Hugging Face Transformers](https://huggingface.co./transformers.js) - ไลบรารี ML inference ในเครื่อง +- [Express](https://expressjs.com/) - Web Framework สำหรับ Node.js ที่รวดเร็ว เปิดกว้าง และใช้งานง่าย +- [AI SDK](https://ai-sdk.dev/) - ชุดเครื่องมือ AI สำหรับ TypeScript +- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - ไลบรารี SQLite3 ประสิทธิภาพสูง +- [Sharp](https://sharp.pixelplumbing.com/) - ไลบรารีประมวลผลภาพบน Node.js ประสิทธิภาพสูง +- [Axios](https://axios-http.com/) - HTTP Client แบบ Promise-based +- [Zod](https://zod.dev/) - ไลบรารีตรวจสอบโครงสร้างข้อมูล (Schema Validation) สำหรับ TypeScript +- [Socket.IO](https://socket.io/) - เอนจินการสื่อสารเรียลไทม์แบบสองทาง +- [Electron](https://www.electronjs.org/) - เฟรมเวิร์กพัฒนาแอปพลิเคชันเดสก์ท็อปข้ามแพลตฟอร์ม +- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - ไลบรารี Machine Learning สำหรับการ Inference บนเครื่อง -ขอบคุณองค์กร/บุคคลต่อไปนี้สนับสนุน Toonflow: +ขอขอบคุณองค์กรและผู้สนับสนุนต่อไปนี้ที่ช่วยเหลือ Toonflow:
- SophNet Logo + Sophnet Logo - SophNet Cloud เป็นผู้สนับสนุนทรัพยากรการประมวลผล - [เว็บไซต์] + Sophnet (算能云) ให้การสนับสนุนด้านพลังการประมวลผล (Computing Power)
+ [เว็บไซต์ทางการ]
-รายชื่อไลบรารีภายนอกทั้งหมด ดูได้ที่ `NOTICES.txt` +รายการ Third-party Dependencies แบบสมบูรณ์ สามารถดูได้ที่ไฟล์ `NOTICES.txt` -##### copyright © 淮北艾阿网络科技有限公司 \ No newline at end of file +##### copyright © Huaibei AIA Network Technology Co., Ltd. \ No newline at end of file diff --git a/docs/README.vi.md b/docs/README.vi.md index e7bafcc..c2e2b36 100644 --- a/docs/README.vi.md +++ b/docs/README.vi.md @@ -8,13 +8,12 @@  |  - Atomgit - Atomgit + Atomgit

- 简体中文 | + 简体中文 | 繁體中文 | English | ไทย | @@ -31,11 +30,11 @@

- Xưởng sản xuất phim ngắn AI + Nhà máy Phim ngắn AI
- Động ngón tay là tiểu thuyết hóa thành phim ngay! + Chỉ với vài cú click, tiểu thuyết lập tức biến thành phim!
- Kịch bản AI × Hình ảnh AI × Tạo dựng thần tốc 🔥 + Kịch bản AI × Hình ảnh AI × Tạo siêu tốc 🔥

@@ -50,17 +49,17 @@

- > 🚀 **Công cụ sản xuất phim ngắn một cửa**: Từ văn bản tới nhân vật, từ dàn cảnh tới video, toàn bộ quy trình AI hóa không cần kỹ năng, tăng hiệu quả sáng tạo gấp 10 lần+! + > 🚀 **Dự án Phim ngắn All-in-One**: Từ văn bản đến nhân vật, từ storyboard đến video hoàn chỉnh. Tự động hóa toàn bộ quy trình bằng AI – không rào cản, tăng hiệu suất sáng tạo lên gấp 10 lần! --- -# 🌐 Hỗ trợ đa ngôn ngữ +# 🌐 Hỗ trợ Đa ngôn ngữ -Toonflow hỗ trợ các ngôn ngữ giao diện sau: +Toonflow hỗ trợ giao diện với các ngôn ngữ sau: | Ngôn ngữ | Language | -|-----------|----------| +|------|----------| | 简体中文 | Chinese (Simplified) | | 繁體中文 | Chinese (Traditional) | | English | English | @@ -69,46 +68,43 @@ Toonflow hỗ trợ các ngôn ngữ giao diện sau: | 日本語 | Japanese | | Русский | Russian | ---- - -# 🌟 Tính năng chính - -Toonflow là công cụ AI tạo phim truyện tranh ngắn, tận dụng công nghệ AI để chuyển tự động tiểu thuyết thành kịch bản, kết hợp hình ảnh, video AI để sáng tác phim ngắn hiệu quả. Với Toonflow, bạn dễ dàng hoàn thành toàn bộ quy trình từ văn bản tới hình ảnh, khiến chế tác phim ngắn trở nên thông minh và tiện lợi hơn bao giờ hết. - -- ✅ **Tạo nhân vật** - Phân tích tự động văn bản tiểu thuyết gốc, nhận diện thông minh và xây dựng thiết lập nhân vật, gồm ngoại hình, tính cách, thân phận,... cung cấp nền tảng chắc chắn cho sáng tác kịch bản và hình ảnh sau này. -- ✅ **Tạo kịch bản** - Dựa trên sự kiện và chương đã chọn, hệ thống tự động tạo kịch bản có cấu trúc gồm thoại, mô tả cảnh, diễn biến tình tiết, chuyển đổi hiệu quả từ văn học sang kịch bản truyền hình, điện ảnh. -- ✅ **Làm phân cảnh** - Theo nội dung kịch bản, tự động tạo từ khóa phân cảnh, thiết kế hình ảnh, chi tiết tiền trung hậu cảnh, động thái nhân vật, thiết lập đạo cụ và bố trí trường quay, tự động phân cảnh dựa trên kịch bản, tối ưu đường lối sản xuất video. -- ✅ **Tổng hợp video** - Tích hợp công nghệ tạo ảnh và video AI, dùng AI tạo phân đoạn video, biên tập trực tuyến, hỗ trợ điều chỉnh cá nhân hóa đầu ra, giúp sáng tác phim hiệu quả, triển khai nhanh. +> 💡 Đang cập nhật thêm nhiều ngôn ngữ, hoan nghênh bạn đóng góp bản dịch! --- -# 📦 Ứng dụng +# 🌟 Tính năng Chính -- Sáng tác nội dung video ngắn -- Thử nghiệm điện ảnh hóa tiểu thuyết -- Công cụ AI chuyển thể văn học -- Phát triển, dựng mẫu nhanh kịch bản -- Tạo nguyên liệu video +Toonflow là công cụ AI chuyên tạo phim ngắn và truyện tranh, có khả năng tự động biến tiểu thuyết thành phim chỉ trong một quy trình liền mạch. Từ văn bản gốc, AI sẽ tạo nhân vật, viết kịch bản, thiết kế phân cảnh và tổng hợp video hoàn chỉnh – giúp bạn sản xuất phim ngắn nhanh chóng, thông minh và tiết kiệm chi phí tối đa. + +- ✅ **Tạo Nhân vật Tự động** Hệ thống phân tích tiểu thuyết gốc, thông minh nhận diện và xây dựng hồ sơ nhân vật chi tiết (ngoại hình, tính cách, danh tính, mối quan hệ…). Tạo nền tảng vững chắc cho kịch bản và hình ảnh sau này. +- ✅ **Tạo Kịch bản Thông minh** Dựa trên các chương/sự kiện bạn chọn, AI tự động xây dựng kịch bản có cấu trúc rõ ràng, bao gồm hội thoại tự nhiên, mô tả cảnh quay và hướng phát triển cốt truyện – chuyển đổi văn học sang kịch bản phim một cách hiệu quả. +- ✅ **Tạo Phân cảnh (Storyboard)** Từ kịch bản, hệ thống tự động sinh ra các prompt phân cảnh và thiết kế khung hình chi tiết. Bao gồm tiền cảnh/trung cảnh/hậu cảnh, hành động nhân vật, đạo cụ và bố cục điện ảnh – tạo ra lộ trình hoàn chỉnh sẵn sàng cho việc sản xuất video. +- ✅ **Tổng hợp & Chỉnh sửa Video** Tích hợp công nghệ AI hình ảnh và video để tạo ra các đoạn clip chất lượng cao. Hỗ trợ chỉnh sửa trực tuyến linh hoạt, cho phép bạn tinh chỉnh theo ý muốn, giúp toàn bộ quy trình sáng tạo phim diễn ra mượt mà và cực kỳ nhanh chóng. --- -# 🔰 Hướng dẫn sử dụng +# 📦 Ứng dụng Thực tế -## 📺 Video hướng dẫn +- Sáng tạo nội dung video ngắn +- Thử nghiệm chuyển thể tiểu thuyết thành phim ngắn +- Công cụ AI chuyển thể văn học thành video +- Phát triển kịch bản và tạo bản mẫu nhanh (Rapid Prototyping) +- Tạo tài liệu video chất lượng cao -https://www.bilibili.com/video/BV1na6wB6Ea2 -[![Toonflow 8 phút nhanh chóng làm chủ AI Video](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) +--- -**Toonflow 8 phút nhanh chóng bắt đầu với AI Video** -👉 [Click xem tại đây](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) +# 🔰 Hướng dẫn Sử dụng -📱 Quét mã QR trên WeChat để xem trên điện thoại +## 📺 Hướng dẫn bằng Video -微信扫码观看 +[https://www.bilibili.com/video/BV1na6wB6Ea2](https://www.bilibili.com/video/BV1na6wB6Ea2) +[![Toonflow - 8 phút làm quen với Video AI](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) + +**Toonflow - 8 phút làm quen nhanh với Video AI** +👉 [Nhấn để xem](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) + +📱 **Quét mã QR để xem video trên điện thoại** +Quét mã QR để xem video --- @@ -116,105 +112,105 @@ https://www.bilibili.com/video/BV1na6wB6Ea2 ## Điều kiện tiên quyết -Trước khi cài đặt và sử dụng, hãy chuẩn bị: +Trước khi cài đặt và sử dụng phần mềm, vui lòng chuẩn bị: -- ✅ Địa chỉ API dịch vụ mô hình ngôn ngữ lớn (AI) -- ✅ Địa chỉ API dịch vụ video Sora hoặc Đậu Bao -- ✅ Địa chỉ API dịch vụ tạo ảnh Nano Banana Pro +- ✅ Địa chỉ API của Mô hình ngôn ngữ lớn (LLM) +- ✅ Địa chỉ API của dịch vụ video Sora hoặc Doubao +- ✅ Địa chỉ API của dịch vụ tạo ảnh Nano Banana Pro -## Cài đặt tại máy +## Cài đặt trên máy cá nhân (Local) -### 1. Tải về & cài đặt +### 1. Tải xuống & Cài đặt -| Hệ điều hành | GitHub | Atomgit | Tải về trên Quark Drive | Ghi chú | -| :----------: | :------------------------------------------------------- | :----------------------------------------------------- | :--------------------------------------------------- | :-------------- | -| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Gói cài đặt chính thức | -| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Gói cài đặt chính thức | -| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Gói cài đặt chính thức | +| Hệ điều hành | GitHub | Atomgit | Tải qua Quark Drive | Mô tả | +| :------: | :----------------------------------------------------------- | :------------------------------------------------------------ | :---------------------------------------------- | :------------- | +| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Bản cài đặt chính thức | +| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Bản cài đặt chính thức | +| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Drive](https://pan.quark.cn/s/94ef07509df0) | Bản cài đặt chính thức | > [!CAUTION] -> Đối với MacOS, vào Cài đặt - Quyền riêng tư & Bảo mật để cấu hình, nếu không phần mềm có thể không mở được do vấn đề chứng chỉ +> Với hệ điều hành MacOS, vui lòng vào "Cài đặt hệ thống" -> "Quyền riêng tư & Bảo mật" để cấp quyền mở ứng dụng, nếu không phần mềm có thể không mở được do vấn đề chứng chỉ. > -> Tham khảo tài liệu Zhihu: [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) +> Tham khảo hướng dẫn Zhihu: [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) -> Do hạn chế môi trường Gitee OS và kích thước upload Release, hiện chưa cung cấp đường dẫn tải Release tại Gitee. +> Do giới hạn môi trường Gitee OS và giới hạn kích thước tệp tải lên của Release, chúng tôi tạm thời không cung cấp link tải qua Gitee Release. -### 2. Khởi động dịch vụ +### 2. Khởi chạy Dịch vụ -Cài đặt xong, mở chương trình là có thể bắt đầu sử dụng. +Sau khi cài đặt xong, hãy mở chương trình để bắt đầu sử dụng. -> ⚠️ **Đăng nhập lần đầu** +> ⚠️ **Đăng nhập lần đầu** > Tài khoản: `admin` > Mật khẩu: `admin123` -## Triển khai Docker +## Triển khai bằng Docker -### Điều kiện +### Điều kiện tiên quyết -- Đã cài đặt [Docker](https://docs.docker.com/get-docker/) (version 20.10+) +- Đã cài đặt [Docker](https://docs.docker.com/get-docker/) (Phiên bản 20.10+) ### Cách 1: Triển khai trực tuyến -Đang hoàn thiện, tạm thời sử dụng build trên máy. +Đang hoàn thiện, tạm thời sử dụng cách Build tại máy (Local build). -### Cách 2: Build local +### Cách 2: Build tại máy (Local build) -Dùng mã nguồn sẵn có, phù hợp cho dev hoặc người đã clone repo, cần cài git trên máy: +Sử dụng mã nguồn có sẵn để build trực tiếp. Phù hợp với lập trình viên hoặc người dùng đã clone repository. (Yêu cầu cài đặt git trên máy): ```shell -# Clone nếu chưa có +# Clone dự án (Bỏ qua nếu đã clone) git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app -# Build và khởi động bằng docker-compose +# Sử dụng docker-compose để build và chạy yarn docker:local # Hoặc build thủ công docker build -t toonflow . -docker run -d -p :10588 -v <đường dẫn data>: /app/data toonflow +docker run -d -p :10588 -v <Đường dẫn dữ liệu trên máy>:/app/data toonflow -# Sau đó, truy cập trang qua /web/index.html trên cổng phù hợp -# Ví dụ http://localhost:10588/web/index.html +# Sau đó, truy cập giao diện qua đường dẫn /web/index.html bằng Port đã thiết lập +# Ví dụ: http://localhost:10588/web/index.html ``` -### Giải thích cổng dịch vụ +### Cấu hình Cổng dịch vụ (Port) -| Cổng | Mục đích | Mapping deploy | -| --------- | ------------- | ------------------- | -| `10588` | Giao diện | `10588:10588` | +| Cổng (Port) | Chức năng | Port Mapping | +| ------- | -------- | ------------- | +| `10588` | Giao diện phần mềm | `10588:10588` | -**Các biến môi trường:** +**Giải thích Biến môi trường:** -| Biến | Giải thích | -| ----------- | -------------------------------------- | -| `NODE_ENV` | Môi trường chạy, `prod` là production | -| `PORT` | Cổng dịch vụ (mặc định 10588) | -| `OSSURL` | Địa chỉ truy cập tệp tĩnh (OSS) | +| Biến (Variable) | Giải thích | +| ---------- | ---------------------------------- | +| `NODE_ENV` | Môi trường chạy, `prod` là môi trường Product (sản xuất) | +| `PORT` | Port lắng nghe của dịch vụ (Mặc định: 10588) | +| `OSSURL` | Địa chỉ truy cập lưu trữ file, dùng cho các tài nguyên tĩnh (Static) | --- -## Triển khai trên máy chủ +## Triển khai trên Máy chủ Đám mây (Cloud) -### A. Yêu cầu máy chủ +### 1. Yêu cầu Môi trường Máy chủ - **Hệ điều hành**: Ubuntu 20.04+ / CentOS 7+ -- **Node.js**: 24.x (khuyến nghị, tối thiểu 23.11.1+) +- **Node.js**: 24.x (Khuyên dùng, Tối thiểu 23.11.1+) - **RAM**: 2GB+ -### B. Triển khai +### 2. Triển khai Máy chủ -#### 1. Cài đặt môi trường +#### 1. Cài đặt Môi trường ```bash -# Cài Node.js +# Cài đặt Node.js curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash source ~/.bashrc nvm install 24 -# Cài Yarn & PM2 +# Cài đặt Yarn và PM2 npm install -g yarn pm2 ``` -#### 2. Triển khai dự án +#### 2. Triển khai Dự án **Clone từ GitHub:** @@ -226,7 +222,7 @@ yarn install yarn build ``` -**Clone từ Gitee (khuyên dùng tại VN):** +**Clone từ Gitee (Khuyên dùng tại TQ):** ```bash cd /opt @@ -238,7 +234,7 @@ yarn build #### 3. Cấu hình PM2 -Tạo file `pm2.json`: +Tạo tệp `pm2.json`: ```json { @@ -254,17 +250,17 @@ Tạo file `pm2.json`: } ``` -**Giải thích biến môi trường:** +**Giải thích Biến môi trường:** -| Biến | Giải thích | -| ----------- | -------------------------------------- | -| `NODE_ENV` | Môi trường chạy, `prod` là production | -| `PORT` | Cổng dịch vụ | -| `OSSURL` | Địa chỉ truy cập tài nguyên tĩnh | +| Biến (Variable) | Giải thích | +| ---------- | ---------------------------------- | +| `NODE_ENV` | Môi trường chạy, `prod` là môi trường Product | +| `PORT` | Cổng lắng nghe của dịch vụ (Port) | +| `OSSURL` | Địa chỉ truy cập lưu trữ file, dùng cho tài nguyên tĩnh | --- -#### 4. Khởi động dịch vụ +#### 4. Khởi chạy Dịch vụ ```bash pm2 start pm2.json @@ -272,150 +268,150 @@ pm2 startup pm2 save ``` -#### 5. Lệnh thường dùng +#### 5. Các lệnh PM2 thường dùng ```bash pm2 list # Xem danh sách tiến trình -pm2 logs toonflow-app # Xem logs +pm2 logs toonflow-app # Xem log (nhật ký) pm2 restart all # Khởi động lại dịch vụ -pm2 monit # Màn hình monitor +pm2 monit # Mở bảng điều khiển giám sát ``` -> ⚠️ **Đăng nhập lần đầu** +> ⚠️ **Đăng nhập lần đầu** > Tài khoản: `admin` > Mật khẩu: `admin123` -#### 6. Triển khai web frontend +#### 6. Triển khai trang web Frontend -Nếu cần deploy riêng hoặc custom giao diện, tham khảo mã nguồn frontend: +Nếu bạn cần triển khai riêng hoặc tùy chỉnh giao diện Frontend, vui lòng tham khảo Repository Frontend: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -> 💡 **Ghi chú**: Repo này đã chứa sẵn tài nguyên frontend được build, người dùng thông thường không cần deploy thêm phần giao diện, repo frontend chỉ dành cho dev muốn tùy biến sâu. +> 💡 **Lưu ý**: Repository này đã được tích hợp sẵn tài nguyên Frontend đã build. Người dùng thông thường không cần tự triển khai Frontend riêng. Repository Frontend chỉ dành cho các nhà phát triển muốn tùy chỉnh chuyên sâu. --- -# 🔧 Hướng dẫn quy trình phát triển +# 🔧 Hướng dẫn Quy trình Phát triển (Development Workflow) > [!CAUTION] -> 🚧 **Quy tắc gửi PR** 🚧 +> 🚧 **Quy định nộp PR (Pull Request)** 🚧 > -> ⛔ Không nhận PR gửi thẳng vào nhánh `master` | ✅ Gửi PR vào nhánh `develop` +> ⛔ Nhánh `master` KHÔNG chấp nhận bất kỳ PR nào | ✅ Vui lòng gửi PR vào nhánh `develop` > -> Chào mừng các dev cùng góp sức phát triển Toonflow. Muốn tham gia nhóm, liên hệ admin ACT trong group chat. +> Chào mừng các nhà phát triển tham gia đóng góp cho Toonflow. Nếu có hứng thú, vui lòng liên hệ với quản trị viên ACT trong nhóm giao lưu. -## 🛠️ Công nghệ sử dụng +## 🛠️ Công nghệ sử dụng (Tech Stack) -| Loại | Công nghệ | -| ---------- | --------------------------------------------------------------------------------------------- | -| Runtime | Node.js 23.11.1+ | -| Ngôn ngữ | TypeScript 5.x | -| Backend | Express 5 | -| Database | SQLite (better-sqlite3/knex) | -| Tích hợp AI| Vercel AI SDK (OpenAI/Anthropic/Google/DeepSeek/Zhipu/MiniMax/TongyiQianwen/xAI) | -| Suy luận local| @huggingface/transformers (ONNX) | -| Realtime | Socket.IO | -| Desktop | Electron 40 | -| Xử lý ảnh | Sharp | -| Container | Docker | +| Phân loại | Công nghệ | +| ---------- | ----------------------------------------------------------------------------------------- | +| Môi trường | Node.js 23.11.1+ | +| Ngôn ngữ | TypeScript 5.x | +| Backend | Express 5 | +| Cơ sở dữ liệu | SQLite (better-sqlite3 / knex) | +| Tích hợp AI| Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhipu / MiniMax / Qwen / xAI) | +| Suy luận Local| @huggingface/transformers (ONNX) | +| Real-time | Socket.IO | +| Ứng dụng Desktop | Electron 40 | +| Xử lý ảnh | Sharp | +| Container | Docker | -## Chuẩn bị môi trường phát triển +## Chuẩn bị Môi trường Phát triển -- **Node.js**: yêu cầu >= 23.11.1 -- **Yarn**: khuyến nghị quản lý package +- **Node.js**: Yêu cầu phiên bản 23.11.1 trở lên +- **Yarn**: Khuyến nghị sử dụng làm Package Manager -## Khởi động nhanh +## Khởi chạy Dự án nhanh 1. **Clone dự án** - **Từ GitHub:** + **Clone từ GitHub:** ```bash git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` - **Từ Gitee (khuyên dùng VN):** + **Clone từ Gitee:** ```bash git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` -2. **Cài dependency** +2. **Cài đặt Dependencies** - Chạy trong thư mục gốc: + Chạy lệnh sau tại thư mục gốc của dự án: ```bash yarn install ``` -3. **Khởi động môi trường dev** +3. **Khởi chạy môi trường Dev** - Dự án gồm 2 phần: **API backend** và **giao diện frontend**. Tuỳ bạn chọn cách chạy: + Dự án bao gồm **Backend API** và **Trang Frontend**. Tùy nhu cầu mà chọn cách khởi chạy: - - **Cách 1: Chạy chỉ API backend** + - **Cách 1: Chỉ chạy Backend API** ```bash yarn dev ``` - > ⚠️ Lệnh này chỉ khởi động API backend (port 10588), **không gồm frontend** và truy cập `http://localhost:10588` chỉ gọi được API, không có web. Nếu muốn vừa backend vừa giao diện web, chạy GUI hoặc deploy bổ sung frontend. + > ⚠️ Lệnh này chỉ khởi chạy Backend API (Port 10588), không bao gồm giao diện Frontend. Khi truy cập http://localhost:10588 chỉ có thể gọi API. Nếu muốn sử dụng giao diện, vui lòng chạy Frontend riêng hoặc dùng chế độ GUI bên dưới. - - **Cách 2: Chạy GUI ứng dụng desktop Electron** + - **Cách 2: Khởi chạy Client Desktop Electron (Khuyên dùng)** ```bash yarn dev:gui ``` - > Lệnh này khởi động backend đồng thời mở cửa sổ desktop Electron có build frontend sẵn, dùng liền, không cấu hình gì thêm. Dành cho dev muốn trải nghiệm trọn bộ. + > Lệnh này sẽ chạy đồng thời Backend và cửa sổ Desktop Electron với giao diện Frontend đã tích hợp sẵn. Mở lên là có thể sử dụng ngay mà không cần cấu hình thêm. Phù hợp nhất cho lập trình viên muốn trải nghiệm toàn bộ tính năng. - - **Cách 3: Chạy chế độ production** + - **Cách 3: Chạy ở chế độ Product (Sản xuất)** ```bash yarn start ``` - > Chạy trực tiếp bản build (cần build bằng `yarn build` trước). + > Chạy trực tiếp dịch vụ sau khi đã build (Cần chạy lệnh yarn build trước). -4. **Đóng gói dự án** +4. **Đóng gói dự án (Build / Pack)** - - Biên dịch TypeScript: + - Biên dịch tệp TypeScript: ```bash yarn build ``` - - Đóng gói thành exe Windows: + - Đóng gói thành tệp thực thi cho Windows: ```bash yarn dist:win ``` - - Đóng gói MacOS: + - Đóng gói thành tệp thực thi cho MacOS: ```bash yarn dist:mac ``` - - Đóng gói Linux: + - Đóng gói thành tệp thực thi cho Linux: ```bash yarn dist:linux ``` -5. **Kiểm tra chất lượng code** +5. **Kiểm tra chất lượng mã (Lint)** - - Đánh giá tổng thể chuẩn code: + - Kiểm tra cú pháp và quy chuẩn toàn cục: ```bash yarn lint ``` -6. **Bảng debug AI (tùy chọn)** +6. **Bảng điều khiển Debug AI (Tùy chọn)** - Khởi động bảng debug AI SDK, dễ test AI call: + Mở công cụ Debug trực quan của AI SDK để tiện theo dõi các lời gọi AI: ```bash yarn debug:ai @@ -423,166 +419,168 @@ Nếu cần deploy riêng hoặc custom giao diện, tham khảo mã nguồn fro ## Phát triển Frontend -Nếu muốn chỉnh sửa UI, vào repo frontend: +Nếu bạn cần chỉnh sửa giao diện Frontend, vui lòng chuyển sang kho lưu trữ Frontend riêng: - **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) - **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -Sau khi build frontend, copy thư mục `dist` vào `data/web` của repo này để tích hợp. +Sau khi build Frontend xong, hãy copy toàn bộ thư mục dist vào thư mục data/web của dự án này để tích hợp. -## Cấu trúc dự án +## Cấu trúc Dự án ``` -📂 build/ # File build -📂 data/ # Dữ liệu runtime -│ ├─ 📂 models/ # Model local (ONNX) -│ ├─ 📂 oss/ # Lưu trữ asset (media/nhân vật/cảnh) -│ ├─ 📂 serve/ # Entry prod -│ ├─ 📂 skills/ # Prompt kỹ năng Agent -│ └─ 📂 web/ # Thành phẩm frontend (built-in) -📂 docs/ # Tài liệu +📂 build/ # Sản phẩm sau khi build +📂 data/ # Dữ liệu Runtime +│ ├─ 📂 models/ # Mô hình suy luận Local (ONNX) +│ ├─ 📂 oss/ # Lưu trữ Object (ảnh, nhân vật, cảnh) +│ ├─ 📂 serve/ # Cổng vào môi trường Production +│ ├─ 📂 skills/ # Prompt kỹ năng của Agent +│ └─ 📂 web/ # Frontend đã build (tích hợp sẵn) +📂 docs/ # Tài liệu và hình ảnh 📂 env/ # Cấu hình môi trường -📂 scripts/ # Script build & phụ trợ +📂 scripts/ # Script hỗ trợ và Build 📂 src/ -├─ 📂 agents/ # Module AI Agent -│ ├─ 📂 productionAgent/ # Agent sản xuất -│ └─ 📂 scriptAgent/ # Agent kịch bản -├─ 📂 lib/ # Thư viện chung (init db, response...) -├─ 📂 middleware/ # Middleware -├─ 📂 routes/ # Router các module -│ ├─ 📂 agents/ # Quản lý memory Agent -│ ├─ 📂 artStyle/ # Quản lý style tranh -│ ├─ 📂 assets/ # Asset -│ ├─ 📂 assetsGenerate/ # Sinh asset -│ ├─ 📂 cornerScape/ # Quản lý phân cảnh -│ ├─ 📂 general/ # API chung -│ ├─ 📂 login/ # Đăng nhập/ xác thực -│ ├─ 📂 migrate/ # Di trú dữ liệu -│ ├─ 📂 modelSelect/ # Chọn model AI -│ ├─ 📂 novel/ # Quản lý tiểu thuyết -│ ├─ 📂 other/ # Chức năng khác -│ ├─ 📂 production/ # Quản lý sản xuất -│ ├─ 📂 project/ # Quản lý project -│ ├─ 📂 script/ # Tạo kịch bản -│ ├─ 📂 scriptAgent/ # API Agent kịch bản -│ ├─ 📂 setting/ # Thiết lập hệ thống -│ ├─ 📂 task/ # Quản lý task -│ └─ 📂 test/ # API test -├─ 📂 socket/ # WebSocket realtime -├─ 📂 types/ # Định nghĩa TypeScript -├─ 📂 utils/ # Hàm tiện ích -├─ 📄 app.ts # App entry -├─ 📄 core.ts # Init core -├─ 📄 env.ts # Xử lý biến môi trường -├─ 📄 err.ts # Xử lý lỗi -├─ 📄 logger.ts # Ghi log -├─ 📄 router.ts # Đăng ký routes -└─ 📄 utils.ts # Tiện ích chung -📄 Dockerfile # Build Docker -📄 electron-builder.yml # Cấu hình build Electron -📄 skillList.json # Danh sách skill -📄 LICENSE # License (Apache-2.0) -📄 NOTICES.txt # Ghi chú phụ thuộc third-party +├─ 📂 agents/ # Module AI Agent +│ ├─ 📂 productionAgent/ # Agent Sản xuất (Production) +│ └─ 📂 scriptAgent/ # Agent Kịch bản (Script) +├─ 📂 lib/ # Thư viện chung (Khởi tạo Database, định dạng Response) +├─ 📂 middleware/ # Middleware +├─ 📂 routes/ # Các Module Routing +│ ├─ 📂 agents/ # Quản lý bộ nhớ Agent +│ ├─ 📂 artStyle/ # Quản lý phong cách nghệ thuật +│ ├─ 📂 assets/ # Quản lý tài nguyên (Assets) +│ ├─ 📂 assetsGenerate/ # Trình tạo tài nguyên +│ ├─ 📂 cornerScape/ # Quản lý phân cảnh (Storyboard) +│ ├─ 📂 general/ # API chung +│ ├─ 📂 login/ # Xác thực đăng nhập +│ ├─ 📂 migrate/ # Di chuyển dữ liệu (Migration) +│ ├─ 📂 modelSelect/ # Chọn mô hình +│ ├─ 📂 novel/ # Quản lý tiểu thuyết +│ ├─ 📂 other/ # Các tính năng khác +│ ├─ 📂 production/ # Quản lý sản xuất / dựng phim +│ ├─ 📂 project/ # Quản lý dự án +│ ├─ 📂 script/ # Tạo kịch bản +│ ├─ 📂 scriptAgent/ # Interface của Agent kịch bản +│ ├─ 📂 setting/ # Cài đặt hệ thống +│ ├─ 📂 task/ # Quản lý tác vụ (Task) +│ └─ 📂 test/ # API thử nghiệm (Test) +├─ 📂 socket/ # Giao tiếp Real-time qua WebSocket +├─ 📂 types/ # Khai báo Type của TypeScript +├─ 📂 utils/ # Các hàm tiện ích +├─ 📄 app.ts # Entry của ứng dụng +├─ 📄 core.ts # Khởi tạo Core +├─ 📄 env.ts # Xử lý biến môi trường +├─ 📄 err.ts # Xử lý lỗi (Error handling) +├─ 📄 logger.ts # Module ghi log (Logger) +├─ 📄 router.ts # Đăng ký Router +└─ 📄 utils.ts # Công cụ chung +📄 Dockerfile # Tệp cấu hình Build Docker +📄 electron-builder.yml # Cấu hình đóng gói Electron +📄 skillList.json # Danh sách kỹ năng +📄 LICENSE # Giấy phép (Apache-2.0) +📄 NOTICES.txt # Khai báo thư viện bên thứ ba 📄 package.json # Cấu hình dự án 📄 tsconfig.json # Cấu hình TypeScript ``` --- -# 🔗 Repo liên quan +# 🔗 Các Kho lưu trữ Liên quan -| Repo | Giải thích | GitHub | Gitee | -| ---------------- | -------------------------------- | -------------------------------------------------- | ------------------------------------------------ | -| **Toonflow-app** | Ứng dụng client đầy đủ (repo này, người dùng nên dùng) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | -| **Toonflow-web** | Mã nguồn frontend (cho dev UI) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | +| Repository (Kho) | Mô tả | GitHub | Gitee | +| ---------------- | ---------------------------------- | -------------------------------------------------- | ------------------------------------------------ | +| **Toonflow-app** | Client hoàn chỉnh (Repo này, khuyến nghị cho người dùng) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | +| **Toonflow-web** | Mã nguồn Frontend (Dành cho lập trình viên Frontend) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | -> 💡 **Lưu ý**: Nếu chỉ muốn dùng Toonflow, tải về client repo này là đủ. Repo frontend chỉ dành cho ai cần phát triển/custome UI thêm. +> 💡 **Mẹo nhỏ**: Nếu bạn chỉ muốn sử dụng Toonflow, hãy tải Client hoàn chỉnh từ kho này là đủ. Kho Toonflow-web chỉ dành cho các nhà phát triển cần chỉnh sửa hoặc phát triển lại giao diện (secondary development). --- -# 👨‍👩‍👧‍👦 Nhóm chat WeChat +# 👨‍👩‍👧‍👦 Nhóm Discord Cộng đồng -Bot mời tham gia: +Nhấn vào biểu tượng bên dưới để tham gia Discord: -Toonflow QR +[![Join our Discord](https://cdn.prod.website-files.com/6257adef93867e50d84d30e2/67d00cf7266d2c75571aebde_Example.svg)](https://discord.gg/HEjKmpNpAZ) + +Hoặc click trực tiếp vào link: [https://discord.gg/HEjKmpNpAZ](https://discord.gg/HEjKmpNpAZ) --- -# 💌 Liên hệ +# 💌 Liên hệ với chúng tôi -📧 Email: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow咨询) +📧 Email: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow%20%C6%B0%C9%9B) --- -# 📜 Giấy phép +# 📜 Giấy phép (License) -Toonflow phát hành mã nguồn mở theo Apache-2.0, kèm thỏa thuận thương mại bổ sung. +Toonflow được phát hành mã nguồn mở dưới giấy phép Apache-2.0, kèm theo Thỏa thuận thương mại bổ sung. -Chi tiết: https://www.apache.org/licenses/LICENSE-2.0 +Chi tiết giấy phép Apache-2.0: https://www.apache.org/licenses/LICENSE-2.0 ## Thỏa thuận bổ sung -- Nếu phân phối phần mềm này dưới dạng sản phẩm cho **2 bên thứ ba độc lập trở lên**, bạn phải có **ủy quyền thương mại bằng văn bản** từ HBAI-Ltd. -- **≤ 5 pháp nhân** cùng vận hành nội bộ mà không cung cấp dịch vụ ra bên ngoài được coi là **sử dụng nội bộ, không cần ủy quyền**. -- Không được xóa hoặc sửa đổi nhãn hiệu, logo hoặc thông tin bản quyền trong Toonflow. +- Nếu phần mềm này được phân phối dưới dạng sản phẩm cho **2 hoặc nhiều bên thứ ba độc lập** sử dụng, bắt buộc phải có **giấy phép thương mại bằng văn bản** từ HBAI-Ltd. +- Nếu **≤ 5 pháp nhân** hợp tác vận hành để sử dụng nội bộ và không cung cấp dịch vụ ra bên ngoài, thì được coi là sử dụng nội bộ và **không cần cấp phép**. +- Không được phép xóa hoặc sửa đổi logo hoặc thông tin bản quyền trong Toonflow. -## Miễn phí vĩnh viễn +## Các trường hợp Miễn phí Vĩnh viễn -- ✅ Sử dụng Toonflow tạo nội dung và nhận chia sẻ doanh thu nền tảng -- ✅ Phát triển thêm cho sử dụng nội bộ nhóm -- ✅ ≤ 5 pháp nhân vận hành chung nội bộ -- ✅ Học tập cá nhân, nghiên cứu, mục đích phi thương mại +- ✅ Dùng Toonflow để sản xuất nội dung và nhận chia sẻ doanh thu từ các nền tảng video +- ✅ Chỉnh sửa mã nguồn (Secondary development) để dùng cho nhóm nội bộ +- ✅ ≤ 5 pháp nhân hợp tác vận hành để sử dụng nội bộ +- ✅ Phục vụ học tập cá nhân, nghiên cứu và các mục đích phi thương mại -## Bảng giá ủy quyền thương mại +## Bảng giá Cấp phép Thương mại -| Giai đoạn | Doanh thu năm | Phí hàng năm | +| Giai đoạn | Doanh thu Hàng năm | Phí Hàng năm | |------|---------|------| -| 🌱 Ươm tạo | < ¥100,000 | **Miễn phí** | -| 🚀 Khởi nghiệp | ¥100,000–500,000 | ¥5,000/năm | -| 📈 Tăng trưởng | ¥500,000–1,500,000 | ¥20,000/năm | -| 🏢 Mở rộng | ¥1,500,000–5,000,000 | ¥80,000/năm | -| 🌐 Doanh nghiệp | > ¥5,000,000 | Thương lượng | +| 🌱 Ươm mầm | < ¥100k (RMB) | **Miễn phí** | +| 🚀 Khởi nghiệp | ¥100k – 500k (RMB) | ¥5,000 / Năm | +| 📈 Tăng trưởng | ¥500k – 1.5M (RMB) | ¥20,000 / Năm | +| 🏢 Quy mô | ¥1.5M – 5M (RMB) | ¥80,000 / Năm | +| 🌐 Doanh nghiệp | > ¥5M (RMB) | Thương lượng | -> **Điều khoản không hồi tố**: Người dùng đã sử dụng Toonflow theo AGPL-3.0 trước khi phát hành v1.0.8 không bị ảnh hưởng. Việc sử dụng hiện tại tiếp tục theo AGPL-3.0. +> **Điều khoản Không hồi tố**: Những người dùng đã sử dụng Toonflow dưới giấy phép AGPL-3.0 trước khi phát hành phiên bản v1.0.8 sẽ tiếp tục tuân theo AGPL-3.0 và không bị ràng buộc bởi sự thay đổi thỏa thuận này. -Xem thỏa thuận đầy đủ tại [LICENSE](../LICENSE). +Xem toàn bộ thỏa thuận tại tệp [LICENSE](./LICENSE). --- -# ⭐️ Lịch sử đánh dấu sao +# ⭐️ Lịch sử Thả sao (Star History) [![Star History Chart](https://api.star-history.com/svg?repos=HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left)](https://www.star-history.com/#HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left) --- -# 🙏 Lời cảm ơn +# 🙏 Lời Cảm ơn -Cảm ơn các dự án open source sau đã hỗ trợ Toonflow mạnh mẽ: +Xin cảm ơn các dự án mã nguồn mở sau đây đã hỗ trợ đắc lực cho Toonflow: -- [Express](https://expressjs.com/) - Framework Web Node.js nhanh, mở, gọn nhẹ -- [AI SDK](https://ai-sdk.dev/) - Bộ tool AI cho TypeScript -- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - Bindings SQLite3 hiệu năng cao -- [Sharp](https://sharp.pixelplumbing.com/) - Thư viện xử lý ảnh Node.js nhanh +- [Express](https://expressjs.com/) - Web framework cho Node.js cực nhanh và tối giản +- [AI SDK](https://ai-sdk.dev/) - Bộ công cụ AI dành cho TypeScript +- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - Thư viện liên kết SQLite3 hiệu suất cao +- [Sharp](https://sharp.pixelplumbing.com/) - Thư viện xử lý hình ảnh Node.js hiệu suất cao - [Axios](https://axios-http.com/) - HTTP client dựa trên Promise -- [Zod](https://zod.dev/) - Library kiểm tra schema ưu tiên TypeScript -- [Socket.IO](https://socket.io/) - Engine realtime song phương sự kiện -- [Electron](https://www.electronjs.org/) - Framework phát triển desktop app đa nền tảng -- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - Thư viện infer ML local +- [Zod](https://zod.dev/) - Thư viện xác thực Schema ưu tiên TypeScript +- [Socket.IO](https://socket.io/) - Công cụ giao tiếp sự kiện hai chiều thời gian thực +- [Electron](https://www.electronjs.org/) - Framework phát triển ứng dụng Desktop đa nền tảng +- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - Thư viện suy luận Machine Learning tại Local -Cảm ơn các tổ chức/đơn vị/cá nhân sau đã hỗ trợ Toonflow: +Xin cảm ơn các tổ chức/đơn vị/cá nhân sau đây đã hỗ trợ cho Toonflow:
- 算能云 Logo + Sophnet Logo - Suanneng Cloud tài trợ năng lực tính toán - [Trang chủ] + Sophnet (算能云) Tài trợ năng lực tính toán (Computing power) + [Website]
-Danh sách phụ thuộc bên thứ ba, vui lòng xem `NOTICES.txt` +Vui lòng xem danh sách đầy đủ các thư viện phụ thuộc của bên thứ ba trong tệp `NOTICES.txt`. -##### copyright © 淮北艾阿网络科技有限公司 \ No newline at end of file +##### Copyright © Huaibei AIA Network Technology Co., Ltd. \ No newline at end of file diff --git a/docs/README.zhtw.md b/docs/README.zhtw.md index 029312b..4c760aa 100644 --- a/docs/README.zhtw.md +++ b/docs/README.zhtw.md @@ -1,4 +1,4 @@ -

+

GitHub @@ -8,19 +8,18 @@  |  - Atomgit - Atomgit + Atomgit

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

@@ -31,11 +30,11 @@

- AI短劇工廠 + AI 短劇工廠
- 一鍵點擊,小說秒變短劇! + 動動手指,小說秒變劇集!
- AI劇本 × AI視覺 × 渦輪生成 🔥 + AI 劇本 × AI 影像 × 極速生成 🔥

@@ -50,7 +49,7 @@

- > 🚀 **一站式短劇生產**:從文本到人物、從分鏡到影片,零門檻全流程AI,10倍以上創作效率! + > 🚀 **一站式短劇工程**:從文字到角色,從分鏡到影片,0 門檻全流程 AI 化,創作效率提升 10 倍+!
--- @@ -59,164 +58,169 @@ Toonflow 支援以下語言介面: -| 語言 | Language | -|------|----------| -| 简体中文 | Chinese (Simplified) | -| 繁體中文 | Chinese (Traditional) | -| English | English | -| ไทย | Thai | -| Tiếng Việt | Vietnamese | -| 日本語 | Japanese | -| Русский | Russian | +| 語言 | Language | +|--------------|---------------------------| +| 简体中文 | Chinese (Simplified) | +| 繁體中文 | Chinese (Traditional) | +| English | English | +| ไทย | Thai | +| Tiếng Việt | Vietnamese | +| 日本語 | Japanese | +| Русский | Russian | + +> 💡 更多語言正在適配中,歡迎貢獻翻譯! --- # 🌟 主要功能 -Toonflow 是一款AI短劇漫畫工具,利用AI自動將小說轉換為劇本,並用AI生成圖片、視頻,助力高效短劇製作。有了Toonflow,您可輕鬆完成從文本到圖片的全流程操作,讓短劇製作更智能、更便捷。 +Toonflow 是一款 AI 短劇與漫畫創作工具,能夠利用 AI 技術將小說自動轉化為劇本,並結合 AI 生成的圖像與影片,高效完成短劇製作。透過 Toonflow,您可以輕鬆完成從文字到最終影片的全流程,讓短劇創作變得更加智能與便捷。 + +- ✅ **角色生成** + 自動分析原始小說文本,智能識別並建立角色設定,包含外貌、性格、身份等詳細資訊,為後續劇本與畫面創作提供堅實基礎。 -- ✅ **人物生成** - 自動解析原小說文本,智能識別並生成人物設定,包括外貌、性格、身份等,為後續劇本和視覺創作提供穩固基礎。 - ✅ **劇本生成** - 根據所選事件和章節,系統自動生成結構化劇本,涵蓋對話、場景描述、劇情走向,實現文學文本向影視劇本高效轉化。 -- ✅ **分鏡製作** - 根據劇本內容,智能生成分鏡提示與視覺設計,細化前景/中景/背景、人物動態、道具設定與場景佈局,自動將劇本轉換為分鏡,為影片製作提供完整藍圖。 + 根據選定的事件與章節,系統自動產生結構清晰的劇本,包含自然對白、場景描述與劇情發展,高效將文學作品轉化為影視劇本。 + +- ✅ **分鏡製作 (Storyboard)** + 根據劇本自動生成分鏡提示詞與畫面設計,細化前、中、後景、角色動作、道具與場景佈局,為影片製作提供完整的藍圖。 + - ✅ **影片合成** - 集成AI圖像與視頻技術,通過AI生成視頻片段,支持線上編輯與個性化輸出調整,讓影視製作協同高效。 + 整合 AI 圖像與影片生成技術,可產生高品質影片片段。內建線上剪輯功能,支援個人化調整,讓創作過程更順暢快速。 --- # 📦 應用場景 -- 短視頻內容創作 -- 小說改編影視實驗 -- AI文學改編工具 -- 劇本開發與快速原型 +- 短影音內容創作 +- 小說影視化實驗 +- AI 文學改編工具 +- 劇本開發與快速原型製作 - 影片素材生成 --- -# 🔰 用戶指南 +# 🔰 使用指南 -## 📺 視頻教程 +## 📺 影片教學 -https://www.bilibili.com/video/BV1na6wB6Ea2 -[![Toonflow 8分鐘快速上手AI視頻](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) +[https://www.bilibili.com/video/BV1na6wB6Ea2](https://www.bilibili.com/video/BV1na6wB6Ea2) +[![Toonflow 8 分鐘快速上手 AI 影片](./videoCover.png)](https://www.bilibili.com/video/BV1na6wB6Ea2) -**Toonflow 8分鐘快速上手AI視頻** -👉 [點此觀看](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) +**Toonflow 8 分鐘快速上手 AI 影片** +👉 [點擊觀看](https://www.bilibili.com/video/BV1na6wB6Ea2/?share_source=copy_web&vd_source=5b718c25439a901a34c7bc0c1d35b38e) -📱 用手機微信掃碼觀看 +📱 使用手機掃描 QR Code 觀看 -Scan WeChat to Watch +掃描 QR Code 觀看 --- -# 🚀 安裝方法 +# 🚀 安裝 -## 前置準備 +## 前置條件 -安裝與使用前請準備以下內容: +安裝並使用本軟體前,請先準備以下項目: -- ✅ 大語言模型AI服務API地址 -- ✅ Sora或豆包視頻服務API地址 -- ✅ Nano Banana Pro圖像生成模型API +- ✅ 大型語言模型 (LLM) 的 API 網址 +- ✅ Sora 或豆包影片生成服務的 API 網址 +- ✅ Nano Banana Pro 圖像生成模型的 API 網址 -## 本地安裝 +## 本機安裝 -### 1. 下載安裝 +### 1. 下載與安裝 -| 作業系統 | GitHub | Atomgit | 夸克網盤下載 | 說明 | +| 作業系統 | GitHub | Atomgit | 夸克網碟下載 | 說明 | | :------: | :----------------------------------------------------------- | :------------------------------------------------------------ | :---------------------------------------------- | :------------- | -| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克網盤](https://pan.quark.cn/s/94ef07509df0) | 官方發布安裝包 | -| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克網盤](https://pan.quark.cn/s/94ef07509df0) | 官方發布安裝包 | -| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克網盤](https://pan.quark.cn/s/94ef07509df0) | 官方發布安裝包 | +| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克網碟](https://pan.quark.cn/s/94ef07509df0) | 官方發佈安裝包 | +| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克網碟](https://pan.quark.cn/s/94ef07509df0) | 官方發佈安裝包 | +| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [夸克網碟](https://pan.quark.cn/s/94ef07509df0) | 官方發佈安裝包 | > [!CAUTION] -> MacOS上需進入設定–隱私安全配置安全設定,否則可能因憑證問題無法打開應用。 +> MacOS 系統請至「系統設定」-「隱私權與安全性」設定安全性,否則可能因憑證問題無法正常開啟。 > -> 參考知乎文檔:[https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) +> 參考知乎教學:[https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276) -> 受Gitee作業系統環境與釋出檔案大小限制,目前Gitee釋出下載暫不開放。 +> 因 Gitee OS 環境限制及 Release 檔案上傳大小限制,暫不提供 Gitee Release 下載連結。 ### 2. 啟動服務 安裝完成後,啟動程式即可開始使用本服務。 -> ⚠️ **首次登入** -> 用戶名:`admin` +> ⚠️ **首次登入** +> 帳號:`admin` > 密碼:`admin123` -## Docker部署 +## Docker 部署 -### 前置準備 +### 前置條件 -- 已安裝 [Docker](https://docs.docker.com/get-docker/)(20.10+) +- 已安裝 [Docker](https://docs.docker.com/get-docker/)(版本 20.10+) -### 方法一:線上部署 +### 方式一:線上部署 -待開發,現請使用本地構建。 +待完善,暫時使用本機建置。 -### 方法二:本地構建 +### 方式二:本機建置 -適用於開發者或已克隆源碼的用戶,需本地安裝Git: +使用本機已有的原始碼直接建置,適合開發者或已 Clone 儲存庫的使用者,這需要您在本機安裝 git: ```shell -# 克隆專案(已克隆則略過) +# 先 Clone 專案(若已有則跳過) git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app -# 用docker-compose本地構建啟動 +# 使用 docker-compose 進行本機建置並啟動 yarn docker:local -# 或手動構建 +# 或者手動建置 docker build -t toonflow . -docker run -d -p :10588 -v :/app/data toonflow +docker run -d -p <本機 Port>:10588 -v <本機資料路徑>:/app/data toonflow -# 完成後可通過映射端口/web/index.html訪問 -# 如 http://localhost:10588/web/index.html +# 此時在相應 Port 的 /web/index.html 路徑即可存取頁面 +# 例如 http://localhost:10588/web/index.html ``` -### 服務端口說明 +### 服務 Port 說明 -| 端口 | 用途 | 部署映射 | -| -------- |------------| -------------------- | -| `10588` | 應用介面 | `10588:10588` | +| Port | 用途 | 部署對應 | +| ------- | -------- | ------------- | +| `10588` | 軟體介面 | `10588:10588` | **環境變數說明:** -| 變數 | 說明 | -| -------------- | ------------------------------------------ | -| `NODE_ENV` | 環境,生產用`prod` | -| `PORT` | 服務監聽端口(預設10588) | -| `OSSURL` | 靜態檔案存取地址 | +| 變數 | 說明 | +| ---------- | ---------------------------------- | +| `NODE_ENV` | 執行環境,`prod` 表示正式環境 | +| `PORT` | 服務監聽 Port(預設 10588) | +| `OSSURL` | 檔案儲存存取網址,用於靜態資源存取 | --- -## 雲端部署 +## ☁️ 雲端部署 -### 1. 伺服器需求 +### 一、伺服器環境要求 -- **作業系統:** Ubuntu 20.04+ / CentOS 7+ -- **Node.js:** 24.x(推薦,最低23.11.1+) -- **記憶體:** 2GB+ +- **系統**:Ubuntu 20.04+ / CentOS 7+ +- **Node.js**:24.x(推薦,最低 23.11.1+) +- **記憶體**:2GB+ -### 2. 伺服器部署 +### 二、伺服器部署 #### 1. 安裝環境 ```bash -# 安裝Node.js +# 安裝 Node.js curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash source ~/.bashrc nvm install 24 -# 安裝Yarn與PM2 +# 安裝 Yarn 和 PM2 npm install -g yarn pm2 ``` -#### 2. 專案部署 +#### 2. 部署專案 -**GitHub克隆:** +**從 GitHub Clone:** ```bash cd /opt @@ -226,7 +230,7 @@ yarn install yarn build ``` -**Gitee克隆(中國大陸推薦):** +**從 Gitee Clone(內地網路使用):** ```bash cd /opt @@ -236,9 +240,9 @@ yarn install yarn build ``` -#### 3. 配置PM2 +#### 3. 設定 PM2 -新建`pm2.json`: +建立 `pm2.json` 檔案: ```json { @@ -256,11 +260,11 @@ yarn build **環境變數說明:** -| 變數 | 說明 | -| -------------- | ------------------------------------------ | -| `NODE_ENV` | 環境,生產用`prod` | -| `PORT` | 服務監聽端口 | -| `OSSURL` | 靜態檔案存取地址 | +| 變數 | 說明 | +| ---------- | ---------------------------------- | +| `NODE_ENV` | 執行環境,`prod` 表示正式環境 | +| `PORT` | 服務監聽 Port | +| `OSSURL` | 檔案儲存存取網址,用於靜態資源存取 | --- @@ -272,80 +276,80 @@ pm2 startup pm2 save ``` -#### 5. 常用命令 +#### 5. 常用指令 ```bash -pm2 list # 查看進程列表 +pm2 list # 查看處理程序 pm2 logs toonflow-app # 查看日誌 -pm2 restart all # 重啟服務 +pm2 restart all # 重新啟動服務 pm2 monit # 監控面板 ``` -> ⚠️ **首次登入** -> 用戶名:`admin` +> ⚠️ **首次登入** +> 帳號:`admin` > 密碼:`admin123` -#### 6. 前端網站部署 +#### 6. 部署前端網站 -若需單獨部署前端或自定義,參見前端專案: +若需單獨部署或客製化前端介面,請參考前端儲存庫: -- **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) -- **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) +- **GitHub**:[Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) +- **Gitee**:[Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -> 💡 **注意:** 本專案已預設內建前端,普通用戶無需單獨部署。前端源碼主要供開發者二次開發使用。 +> 💡 **說明**:本儲存庫已內建編譯好的前端資源,一般使用者無需單獨部署前端。前端儲存庫僅供需要二次開發的開發者使用。 --- -# 🔧 開發指南 +# 🔧 開發流程指南 > [!CAUTION] -> 🚧 **PR提交規範** 🚧 +> 🚧 **PR 提交規範** 🚧 > -> ⛔ `master`分支不接受PR | ✅ 請提交至`develop`分支 +> ⛔ `master` 分支不接受任何 PR | ✅ 請將 PR 提交到 `develop` 分支 > -> 歡迎開發者協同合作,共同開發Toonflow。欲加入請聯繫owner ACT入群。 +> 歡迎開發者們共同參與 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 / Qwen / xAI)| -| 本地推理 | @huggingface/transformers(ONNX) | -| 實時通信 | Socket.IO | -| 桌面端 | Electron 40 | -| 影像處理 | Sharp | -| 容器化 | Docker | +| 類別 | 技術 | +| ---------- | ----------------------------------------------------------------------------------------- | +| 執行環境 | 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 | ## 開發環境準備 -- **Node.js**:需23.11.1以上版本 -- **Yarn**:推薦作為包管理器 +- **Node.js**:版本要求 23.11.1 及以上 +- **Yarn**:推薦作為專案套件管理員 -## 快速上手 +## 快速啟動專案 -1. **克隆專案** +1. **Clone 專案** - **GitHub克隆:** + **從 GitHub Clone:** ```bash git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` - **Gitee克隆(大陸推薦):** + **從 Gitee Clone(內地網路使用):** ```bash git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app ``` -2. **安裝依賴** +2. **安裝相依套件** - 在專案根目錄執行: + 請先在專案根目錄下執行以下指令以安裝相依套件: ```bash yarn install @@ -353,69 +357,69 @@ pm2 monit # 監控面板 3. **啟動開發環境** - 本專案包含 **後端API服務** 和 **前端介面**,按需啟動: + 本專案包含 **後端 API 服務** 和 **前端頁面** 兩部分,請根據需要選擇啟動方式: - - **方案1:僅啟動後端服務** + - **方式一:僅啟動後端服務** ```bash yarn dev ``` - > ⚠️ 此命令僅啟動後端API(10588端口),沒有Web介面。僅可存取API,完整UI需啟動前端專案或用下述GUI模式。 + > ⚠️ 此指令僅啟動後端 API 服務(Port 10588),**不包含前端頁面**。直接瀏覽 `http://localhost:10588` 只能呼叫 API 介面,無法看到完整的網頁介面。若需同時使用前端頁面,請配合前端專案單獨啟動,或使用下方的 GUI 模式。 - - **方案2:啟動Electron桌面客戶端** + - **方式二:啟動 Electron 桌面用戶端** ```bash yarn dev:gui ``` - > 此命令即啟動後端又開Electron視窗,內建Web UI。開箱即用,體驗完整。 + > 此指令會同時啟動後端服務和 Electron 桌面視窗,內建前端頁面,開箱即用,無需額外設定。適合想要完整體驗所有功能的開發者。 - - **方案3:生產模式啟動** + - **方式三:正式環境模式啟動** ```bash yarn start ``` - > 編譯後以生產模式運行(需先執行`yarn build`)。 + > 以生產模式直接執行編譯後的服務(需先執行 `yarn build`)。 -4. **構建專案** +4. **專案打包建置** - - 編譯TypeScript: + - 編譯並產生 TypeScript 檔案: ```bash yarn build ``` - - Windows可執行檔打包: + - 打包為 Windows 平台執行檔: ```bash yarn dist:win ``` - - Mac打包: + - 打包為 Mac 平台執行檔: ```bash yarn dist:mac ``` - - Linux打包: + - 打包為 Linux 平台執行檔: ```bash yarn dist:linux ``` -5. **代碼質量檢查** +5. **程式碼品質檢查 (Lint)** - - 執行Lint: + - 進行全域語法和規範檢查: ```bash yarn lint ``` -6. **AI調試面板(可選)** +6. **AI 除錯面板(選用)** - 啟動Vercel AI SDK可視化調試工具,便於AI對接調測: + 啟動 AI SDK 的視覺化除錯工具,方便對 AI 呼叫進行除錯: ```bash yarn debug:ai @@ -423,129 +427,131 @@ pm2 monit # 監控面板 ## 前端開發 -需修改前端UI,請於專用前端專案開發: +若需修改前端介面,請前往前端儲存庫進行開發: -- **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) -- **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) +- **GitHub**:[Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web) +- **Gitee**:[Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web) -前端打包後將`dist`內容複製至本專案`data/web`即可集成。 +前端建置後,將 `dist` 目錄內容複製到本專案的 `data/web` 目錄即可整合。 ## 專案結構 ``` -📂 build/ # 編譯產物 -📂 data/ # 運行時資料 -│ ├─ 📂 models/ # 本地推理模型(ONNX) +📂 build/ # 編譯產物 +📂 data/ # 執行時資料 +│ ├─ 📂 models/ # 本機推論模型(ONNX) │ ├─ 📂 oss/ # 物件儲存(素材/角色/場景) -│ ├─ 📂 serve/ # 生產模式入口 -│ ├─ 📂 skills/ # Agent技能提示 -│ └─ 📂 web/ # 前端資產 -📂 ./ # 文檔資產 -📂 env/ # 環境配置 -📂 scripts/ # 構建與輔助腳本 +│ ├─ 📂 serve/ # 正式環境入口 +│ ├─ 📂 skills/ # Agent 技能提示詞 +│ └─ 📂 web/ # 前端編譯產物(內建) +📂 docs/ # 文件資源 +📂 env/ # 環境設定 +📂 scripts/ # 建置與輔助腳本 📂 src/ -├─ 📂 agents/ # AI Agent模組 -│ ├─ 📂 productionAgent/ # 製作Agent -│ └─ 📂 scriptAgent/ # 劇本Agent -├─ 📂 lib/ # 通用庫(資料庫、響應) -├─ 📂 middleware/ # 中間件 -├─ 📂 routes/ # API路由 -│ ├─ 📂 agents/ # Agent記憶管理 -│ ├─ 📂 artStyle/ # 美術風格管理 +├─ 📂 agents/ # AI Agent 模組 +│ ├─ 📂 productionAgent/ # 製作 Agent +│ └─ 📂 scriptAgent/ # 劇本 Agent +├─ 📂 lib/ # 公用函式庫(資料庫初始化、回應格式) +├─ 📂 middleware/ # 中介軟體 +├─ 📂 routes/ # 路由模組 +│ ├─ 📂 agents/ # Agent 記憶管理 +│ ├─ 📂 artStyle/ # 畫風管理 │ ├─ 📂 assets/ # 素材管理 │ ├─ 📂 assetsGenerate/ # 素材生成 │ ├─ 📂 cornerScape/ # 分鏡管理 -│ ├─ 📂 general/ # 通用API -│ ├─ 📂 login/ # 認證 -│ ├─ 📂 migrate/ # 資料遷移 +│ ├─ 📂 general/ # 通用 API +│ ├─ 📂 login/ # 登入認證 +│ ├─ 📂 migrate/ # 資料轉移 │ ├─ 📂 modelSelect/ # 模型選擇 │ ├─ 📂 novel/ # 小說管理 │ ├─ 📂 other/ # 其他功能 │ ├─ 📂 production/ # 製作管理 │ ├─ 📂 project/ # 專案管理 │ ├─ 📂 script/ # 劇本生成 -│ ├─ 📂 scriptAgent/ # 劇本Agent API +│ ├─ 📂 scriptAgent/ # 劇本 Agent 介面 │ ├─ 📂 setting/ # 系統設定 │ ├─ 📂 task/ # 任務管理 -│ └─ 📂 test/ # 測試API -├─ 📂 socket/ # WebSocket通訊 -├─ 📂 types/ # TypeScript型別 +│ └─ 📂 test/ # 測試介面 +├─ 📂 socket/ # WebSocket 即時通訊 +├─ 📂 types/ # TypeScript 類型宣告 ├─ 📂 utils/ # 工具函式 ├─ 📄 app.ts # 應用入口 ├─ 📄 core.ts # 核心初始化 -├─ 📄 env.ts # 環境變數 +├─ 📄 env.ts # 環境變數處理 ├─ 📄 err.ts # 錯誤處理 ├─ 📄 logger.ts # 日誌模組 ├─ 📄 router.ts # 路由註冊 └─ 📄 utils.ts # 通用工具 -📄 Dockerfile # Docker構建 -📄 electron-builder.yml # Electron打包配置 -📄 skillList.json # 技能列表 -📄 LICENSE # (Apache-2.0) 授權 -📄 NOTICES.txt # 第三方依賴 -📄 package.json # 專案配置 -📄 tsconfig.json # TypeScript配置 +📄 Dockerfile # Docker 建置檔案 +📄 electron-builder.yml # Electron 打包設定 +📄 skillList.json # 技能清單 +📄 LICENSE # 授權條款(Apache-2.0) +📄 NOTICES.txt # 第三方相依套件聲明 +📄 package.json # 專案設定 +📄 tsconfig.json # TypeScript 設定 ``` --- -# 🔗 相關倉庫 +# 🔗 相關儲存庫 -| 倉庫 | 說明 | GitHub | Gitee | -| -------------- | -------------------------- | ------------------------------------------------- | -------------------------------------------------- | -| **Toonflow-app** | 完整客戶端(本倉庫,供用戶) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app)| [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | -| **Toonflow-web** | 前端源碼(前端開發者用) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web)| [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | +| 儲存庫 | 說明 | GitHub | Gitee | +| ---------------- | ---------------------------------- | -------------------------------------------------- | ------------------------------------------------ | +| **Toonflow-app** | 完整用戶端(本儲存庫,推薦一般使用者) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) | +| **Toonflow-web** | 前端原始碼(適合前端開發者) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) | -> 💡 **提醒:** 若僅需使用Toonflow,直接下載本倉庫客戶端即可。前端源碼僅供需二次開發或UI自訂者使用。 +> 💡 **提示**:如果您只是想使用 Toonflow,直接下載本儲存庫的用戶端即可。前端儲存庫僅供需要二次開發或客製化前端介面的開發者使用。 --- -# 👨‍👩‍👧‍👦 微信交流群 +# 👨‍👩‍👧‍👦 Discord 交流群組 -群助手: +點擊下方圖示加入 Discord: -Toonflow QR +[![Join our Discord](https://cdn.prod.website-files.com/6257adef93867e50d84d30e2/67d00cf7266d2c75571aebde_Example.svg)](https://discord.gg/HEjKmpNpAZ) + +或直接點擊連結: [https://discord.gg/HEjKmpNpAZ](https://discord.gg/HEjKmpNpAZ) --- -# 💌 聯繫我們 +# 💌 聯絡我們 -📧 郵箱:[ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow inquiry) +📧 信箱:[ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow諮詢) --- -# 📜 開源協議 +# 📜 授權條款 -Toonflow 基於 Apache-2.0 協議開源發布,並附有補充商業協議。 +Toonflow 基於 Apache-2.0 協定開源發佈,並附有補充商業協議。 -授權詳情:https://www.apache.org/licenses/LICENSE-2.0 +授權條款詳情:https://www.apache.org/licenses/LICENSE-2.0 ## 補充協議 -- 若將本軟體以產品形式分發給 **2 個及以上獨立第三方**使用,須取得 HBAI-Ltd **書面商業授權**。 -- **≤ 5 個法人**聯合運營內部使用,不對外提供服務的,視為內部使用,**無需授權**。 +- 若將本軟體以產品形式散佈給 **2 個及以上獨立第三方**使用,須取得 HBAI-Ltd **書面商業授權**。 +- **≤ 5 個法人**聯合營運內部使用,不對外提供服務的,視為內部使用,**無需授權**。 - 不得刪除或修改 Toonflow 中的標識或版權資訊。 ## 永久免費場景 -- ✅ 用 Toonflow 製作內容並獲得平台分帳 +- ✅ 用 Toonflow 製作內容並獲得平台分潤 - ✅ 二次開發供自己團隊內部使用 -- ✅ ≤ 5 個法人聯合運營內部使用 +- ✅ ≤ 5 個法人聯合營運內部使用 - ✅ 個人學習、研究、非商業用途 -## 商業授權定價 +## 商業授權定價(人民幣) -| 階段 | 年銷售額 | 年費 | -|------|---------|------| -| 🌱 扶持期 | < ¥10 萬 | **免費** | -| 🚀 初創期 | ¥10–50 萬 | ¥5,000/年 | -| 📈 成長期 | ¥50–150 萬 | ¥20,000/年 | -| 🏢 規模期 | ¥150–500 萬 | ¥80,000/年 | -| 🌐 企業級 | > ¥500 萬 | 面議 | +| 階段 | 年營業額 | 年費 | +|------------|---------------------------|-------------------| +| 🌱 扶持期 | < 10 萬人民幣 | **免費** | +| 🚀 初創期 | 10–50 萬人民幣 | ¥5,000 / 年 | +| 📈 成長期 | 50–150 萬人民幣 | ¥20,000 / 年 | +| 🏢 規模期 | 150–500 萬人民幣 | ¥80,000 / 年 | +| 🌐 企業級 | > 500 萬人民幣 | 面議 | -> **不追溯條款**:v1.0.8 發布前基於 AGPL-3.0 使用的用戶,繼續按 AGPL-3.0 執行,不受本協議變更約束。 +> **不溯及既往條款**:v1.0.8 發佈前基於 AGPL-3.0 使用的使用者,繼續按 AGPL-3.0 執行,不受本協議變更約束。 -完整協議詳見 [LICENSE](../LICENSE) 檔案。 +完整協議詳見 [LICENSE](./LICENSE) 檔案。 --- @@ -555,34 +561,34 @@ Toonflow 基於 Apache-2.0 協議開源發布,並附有補充商業協議。 --- -# 🙏 感謝 +# 🙏 致謝 -感謝以下開源專案對Toonflow的支持: +感謝以下開源專案為 Toonflow 提供強大支援: -- [Express](https://expressjs.com/) - 快速、開放、極簡的Node.js Web框架 -- [AI SDK](https://ai-sdk.dev/) - TypeScript優先的AI工具包 -- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - 高效能SQLite3綁定 -- [Sharp](https://sharp.pixelplumbing.com/) - Node.js高性能影像工具 -- [Axios](https://axios-http.com/) - Promise的HTTP用戶端 -- [Zod](https://zod.dev/) - TypeScript優先的型別驗證庫 -- [Socket.IO](https://socket.io/) - 實時雙向事件框架 -- [Electron](https://www.electronjs.org/) - 跨平台桌面應用框架 -- [Hugging Face Transformers](https://huggingface.co./transformers.js) - 本地ML推理庫 +- [Express](https://expressjs.com/) - 快速、開放、極簡的 Node.js Web 框架 +- [AI SDK](https://ai-sdk.dev/) - 面向 TypeScript 的 AI 工具包 +- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) - 高效能 SQLite3 綁定庫 +- [Sharp](https://sharp.pixelplumbing.com/) - 高效能 Node.js 影像處理庫 +- [Axios](https://axios-http.com/) - 基於 Promise 的 HTTP 用戶端 +- [Zod](https://zod.dev/) - TypeScript 優先的結構驗證庫 +- [Socket.IO](https://socket.io/) - 即時雙向事件通訊引擎 +- [Electron](https://www.electronjs.org/) - 跨平台桌面應用開發框架 +- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) - 本機 ML 推論庫 -感謝以下組織/個人的支持: +感謝以下組織/單位/個人為 Toonflow 提供支援:
- SophNet Logo + 算能雲 Logo - SophNet Cloud 提供算力贊助 - [官方網站] + 算能雲 提供算力贊助 + [官網]
-完整第三方依賴列表請見 `NOTICES.txt` +完整的第三方相依性清單請查閱 `NOTICES.txt` -##### copyright © 淮北艾阿网络科技有限公司 \ No newline at end of file +##### copyright © 淮北艾阿網絡科技有限公司 \ No newline at end of file diff --git a/scripts/main.ts b/scripts/main.ts index 873c506..b793b20 100644 --- a/scripts/main.ts +++ b/scripts/main.ts @@ -55,8 +55,6 @@ function initializeData(): void { } } - console.log("%c Line:55 🍕 shouldForceReplace", "background:#2eafb0", shouldForceReplace); - for (const dir of TARGET_ENTRIES) { const targetDir = path.join(destDir, dir); if (shouldForceReplace) {