HKUDS/ViMax

What is it?

Key features

• 01Generates a complete video from a short idea, with script, storyboard, and shots.
• 02Converts explicit screenplays into multi-scene, multi-shot video.
• 03Adapts long-form fiction into episodic visual narratives.
• 04Keeps a person or pet's appearance consistent across generated scenes.
• 05Provides an interactive TUI and a local Web UI for planning, revision, and rendering control.
• 06Generates compatible shots and media assets in parallel.

Use cases

• Prototyping short films or trailers from a written concept.
• Turning a screenplay into a rough multi-shot video for review.
• Adapting a novel chapter into an episodic animated-style video.
• Creating personalized short stories featuring a user's own photo.

Quick start

1. 1

   Install uv (see the uv docs linked in the README)

2. 2

   Clone the repository

   git clone https://github.com/HKUDS/ViMax.git
3. 3

   Enter the project directory and install dependencies

   cd ViMax && uv sync
4. 4

   Create a local agent config, add your API keys, then start the TUI

   cp configs/agent.example.yaml configs/agent.local.yaml

Things to know

• !Requires API keys for LLM, image, and video generation providers, which may incur significant costs.
• !Setup needs a configured YAML file with model and provider details before anything runs.
• !README lists support only for Linux and Windows.

Topics

FAQ

What is ViMax?

Agentic video generation framework that turns a story idea, screenplay, or novel into a multi-shot video by coordinating script, storyboard, character, and video generation agents. ViMax is an agentic video creation framework that automates the path from a narrative to a finished video. It covers scriptwriting, storyboarding, character and reference design, shot planning, image and video generation, and final assembly, so a user can start from a short concept or a long-form text rather than manually producing each shot.

Is ViMax free to use? What license does it have?

ViMax is open source under the MIT license. Check the license terms before using it in commercial products.

Is ViMax still maintained?

Actively maintained. The last commit to ViMax was on Sep 30, 2026.

What can I use ViMax for?

Prototyping short films or trailers from a written concept. Turning a screenplay into a rough multi-shot video for review. Adapting a novel chapter into an episodic animated-style video. Creating personalized short stories featuring a user's own photo.

How do I install ViMax?

Install uv (see the uv docs linked in the README) Clone the repository: git clone https://github.com/HKUDS/ViMax.git Enter the project directory and install dependencies: cd ViMax && uv sync Create a local agent config, add your API keys, then start the TUI: cp configs/agent.example.yaml configs/agent.local.yaml

Where can I get ViMax?

The source code and installation instructions are on GitHub: https://github.com/HKUDS/ViMax