README.txt 3.2 KB

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