The Storyboard Player is a versatile tool designed to help creators visualize their storytelling ideas through the use of Markdown. Whether you're a filmmaker, game designer, or content creator, this tool streamlines the process of turning your storyboard concepts into actionable visual formats. With support for console display, graphical user interfaces, QML generation, and video rendering, the Storyboard Player enables a seamless storytelling workflow.
test-storyboard_output.mp4
- Features
- Requirements
- Installation
- Usage
- Configuration
- Logging
- Directory Structure
- Contributing
- License
- Display in Console: Quickly view your storyboard's content directly in the terminal for easy debugging and review.
- Display in GUI: Visualize your storyboard in a user-friendly graphical interface, allowing for a more interactive experience.
- Generate QML: Create a QML file to display your storyboard in any QML viewer, making integration into other applications straightforward.
- Render to Video: Convert your storyboard into a video file, complete with images and text-to-speech audio, for easy sharing and presentation.
- Python 3.8 or higher
- Required Python packages:
markdownFreeSimpleGUIPillowrequeststorchkokorosoundfilesubprocess
To install the Storyboard Player, follow these steps:
- Clone the repository:
git clone https://github.com/deniskropp/storyboard-player.git
- Navigate to the project directory:
cd storyboard-player - Install the required dependencies:
pip install markdown FreeSimpleGUI Pillow requests torch kokoro soundfile
To use the Storyboard Player, you can run commands in your terminal. Here are some common functionalities:
-
In Console:
python main.py test/test-storyboard.md --display
-
In GUI:
python main.py test/test-storyboard.md --display_gui
- QML File:
python main.py test/test-storyboard.md --display_qml --qml_output my_player.qml
- Render Video:
python main.py test/test-storyboard.md --render_video --output my_video.mp4
filename: The path to the storyboard markdown file.--display: Display the storyboard in the console.--display_gui: Display the storyboard in a GUI window.--display_qml: Generate and display the storyboard in a QML viewer.--render_video: Render the storyboard to a video file.--output: The output video filename (default:output.mp4).--qml_output: The output QML filename (default:storyboard.qml).
Enjoy using the Storyboard Player!
Configuration constants for the storyboard player are defined in the Config class within the storyboard/config.py file. You can modify these constants to suit your needs.
The application uses a custom logger defined in storyboard/logger.py. Logs are output to the console by default. You can also configure the logger to write logs to a file by uncommenting the relevant line in the logger initialization.
storyboard/: Contains the main modules and classes.images/: Directory for downloaded images.sound/: Directory for generated sound files.logs/: Directory for log files (if logging to a file is enabled).
Happy coding!
Contributions are welcome! Please feel free to submit issues or pull requests to improve the Storyboard Player.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or inquiries, please contact the maintainer:
- Name: Denis O Kropp
- Email: [email protected]
- GitHub: deniskropp
| Issue | Solution |
|---|---|
| FFmpeg Not Found | Ensure that FFmpeg is installed and added to your system's PATH. You can download it from FFmpeg's official website. |
| Kokoro Installation Issues | Ensure that Kokoro is installed correctly using pip: pip install kokoro. |
| Image Download Errors | Verify that the image URLs in your storyboard file are correct and accessible. Check your internet connection and firewall settings. |
| Sound Generation Errors | Ensure that the Kokoro library is properly installed and that the text-to-speech pipeline is initialized correctly. |
- Enable debug logging by setting the logging level to
DEBUGin theLoggerclass. - Check the console output for any error messages or warnings.
- Review the log files (if logging to a file is enabled) for more detailed information.
- Added support for displaying storyboard in the console.
- Added support for displaying storyboard in a GUI window.
- Added support for generating QML files.
- Added support for rendering storyboard to a video file.
- Implemented image downloading and conversion.
- Implemented text-to-speech generation and audio file saving.
- Added configuration constants and logging functionality.
- Created a comprehensive README with usage instructions and troubleshooting tips.
- Improved GUI: Enhance the GUI with more interactive elements and better user experience.
- Additional Export Formats: Support exporting storyboard to other formats such as HTML, PDF, etc.
- Enhanced TTS: Improve text-to-speech quality and add support for more languages.
- Cloud Integration: Integrate cloud services for image storage and TTS processing.
- User Authentication: Add user authentication for personalized storyboard management.
Stay tuned for updates and new features!
- Fork the Repository: Create a fork of the repository on GitHub.
- Clone the Fork: Clone your fork to your local machine.
git clone https://github.com/yourusername/storyboard-player.git
- Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b feature/your-feature-name
- Make Changes: Make your changes and commit them.
git commit -m "Add your commit message here" - Push Changes: Push your changes to your fork.
git push origin feature/your-feature-name
- Create a Pull Request: Open a pull request to the main repository.
- Ensure that your changes do not break existing functionality.
- Write unit tests for new features if applicable.
Thank you for your contributions to the Storyboard Playe