| 1 | ======================================== |
| 2 | Pixelle-Video - Windows Portable |
| 3 | ======================================== |
| 4 | |
| 5 | AI-powered video creation platform |
| 6 | |
| 7 | Version: {VERSION} |
| 8 | Build Date: {BUILD_DATE} |
| 9 | |
| 10 | ======================================== |
| 11 | Quick Start |
| 12 | ======================================== |
| 13 | |
| 14 | 1. Double-click "start.bat" to launch the Web UI |
| 15 | 2. Browser will open automatically |
| 16 | 3. Configure your API keys in the Web UI (Settings section) |
| 17 | |
| 18 | That's it! Just one click to start. |
| 19 | You can launch multiple instances - each will use a different port automatically. |
| 20 | |
| 21 | ======================================== |
| 22 | First-Time Setup |
| 23 | ======================================== |
| 24 | |
| 25 | 1. On first run, the Web UI will start with default configuration |
| 26 | 2. Click on "Settings" in the Web UI to configure: |
| 27 | - LLM API Key (OpenAI/Qwen/DeepSeek/etc) |
| 28 | - LLM Base URL and Model |
| 29 | - ComfyUI settings (use RunningHub or local ComfyUI) |
| 30 | 3. Click "Save Config" to save your settings |
| 31 | 4. Configuration will be automatically saved to config.yaml |
| 32 | |
| 33 | ======================================== |
| 34 | Configuration |
| 35 | ======================================== |
| 36 | |
| 37 | Configuration is done through the Web UI: |
| 38 | |
| 39 | 1. Launch the application using start.bat |
| 40 | 2. Click on "Settings" in the Web UI |
| 41 | 3. Fill in the required fields: |
| 42 | - LLM API Key: Your LLM provider API key |
| 43 | - LLM Base URL: LLM API endpoint |
| 44 | - LLM Model: Model name (e.g., gpt-4o, qwen-max) |
| 45 | - ComfyUI URL: For local ComfyUI (default: http://127.0.0.1:8188) |
| 46 | - RunningHub API Key: For cloud image generation (optional) |
| 47 | 4. Click "Save Config" to save |
| 48 | |
| 49 | The configuration will be automatically saved to Pixelle-Video/config.yaml. |
| 50 | |
| 51 | Note: You can also manually edit config.yaml if needed, but the Web UI is recommended. |
| 52 | |
| 53 | ======================================== |
| 54 | Folder Structure |
| 55 | ======================================== |
| 56 | |
| 57 | python/ - Python 3.11 embedded runtime |
| 58 | tools/ - FFmpeg and other utilities |
| 59 | Pixelle-Video/ - Main application |
| 60 | data/ - User data (BGM, templates, workflows) |
| 61 | output/ - Generated videos |
| 62 | |
| 63 | ======================================== |
| 64 | System Requirements |
| 65 | ======================================== |
| 66 | |
| 67 | - Windows 10/11 (64-bit) |
| 68 | - 4GB RAM minimum (8GB recommended) |
| 69 | - Internet connection (for API calls and ComfyUI cloud) |
| 70 | - Modern web browser (Chrome/Edge/Firefox) |
| 71 | |
| 72 | ======================================== |
| 73 | Troubleshooting |
| 74 | ======================================== |
| 75 | |
| 76 | Problem: "Python not found" |
| 77 | Solution: Ensure python/ folder exists and is not corrupted |
| 78 | |
| 79 | Problem: "Failed to start" |
| 80 | Solution: Check if Python and dependencies are installed correctly |
| 81 | |
| 82 | Problem: "Port already in use" |
| 83 | Solution: Streamlit automatically uses the next available port. You can run multiple instances simultaneously. |
| 84 | |
| 85 | Problem: "Module not found" |
| 86 | Solution: Re-extract the package completely, don't move files |
| 87 | |
| 88 | ======================================== |
| 89 | Support |
| 90 | ======================================== |
| 91 | |
| 92 | GitHub: https://github.com/AIDC-AI/Pixelle-Video |
| 93 | Documentation: https://aidc-ai.github.io/Pixelle-Video |
| 94 | Issues: https://github.com/AIDC-AI/Pixelle-Video/issues |
| 95 | |
| 96 | ======================================== |
| 97 | License |
| 98 | ======================================== |
| 99 | |
| 100 | See LICENSE file in Pixelle-Video/ folder |
| 101 | |
| 102 | Copyright (c) 2025 Pixelle.AI |
| 103 | |
| 104 |