Skip to content

taruma/shotbase

Repository files navigation

ShotBase Logo

ShotBase

(previously ShotBuddy V3)

Your AI Filmmaking Asset Manager.
An open-source tool designed to manage, organize, and streamline your entire AI filmmaking asset workflow.

Latest Release License Python Version


ShotBase takes the chaos out of AI filmmaking. Instead of juggling countless generated files in messy folders, ShotBase provides a structured, visual, and intuitive interface to build your stories shot by shot. This fork supercharges the original with powerful project management, advanced version control, and a modern user experience tailored for today's creative workflows.

ShotBase Main Interface with Table of Contents

✨ Key Features

This version of ShotBase is packed with features designed to make your workflow faster and more organized.

πŸ†• What's New in v4

  • Shot Search β€” Press Ctrl+Shift+F to search across all shots' prompts, captions, notes, and names. Filter by content type and archive status for quick shot discovery. Shot Search
  • Visual Reorder Grid β€” Drag-and-drop shot sorting with a responsive 5-column layout, thumbnail type switching, video preview, and inline display name editing. Visual Reorder Grid
  • Alternative Video Asset β€” New alt_video type for storing reference footage, upscales, or any additional video variant alongside your main video. Alternative Video Asset
  • Export Enhancements β€” Display name columns now included in markdown exports, alt video assets exported, and a new "Open Exports Folder" button for quick access.
  • UI Polish β€” Sticky header stays visible on scroll, browser tab shows dynamic project title, and the table of contents has a collapsible archived section.
  • Performance β€” Thumbnails generated lazily on first request, and version scans cached per shot for faster page loads.

πŸš€ Streamlined Project Management

  • Comprehensive Project Dashboard: Get a bird's-eye view of your entire project with the responsive Table of Shots (TOC) panel. Filter, navigate, and see active vs. archived shots at a glance.
  • Effortless Shot Reordering: Simply drag and drop shots to rearrange your sequence. Your story's flow is always just a move away. Effortless Shot Reordering
  • Flexible Archiving & Naming: Keep your main workspace clean by archiving inactive shots. Give shots human-readable names like "Opening Scene" instead of just SH010 for better clarity. Custom Display Names and Archiving
  • Detailed Project Info: Manage metadata for each project, including title, version, description, and tags, all from an intuitive modal. Project Information Management

πŸ–ΌοΈ Powerful Asset & Version Control

  • First & Last Frame Variants: Manage distinct opening and closing frames for each shot, complete with their own versions, prompts, and thumbnails. First and Last Frame Variants
  • Instant Prompt Previews: No more digging for prompt details. Simply hover over a thumbnail to see the exact prompt used to generate it. Instant Prompt Previews
  • Automatic File Organization: Drag and drop your generated images or videos. ShotBase automatically versions them, archives old iterations in a wip folder, and keeps the latest version ready for your pipeline.

πŸ’‘ Enhanced User Experience

  • Advanced Export Options: Precisely select what you want to export. Choose between images, videos, or both, and even include metadata summaries for a complete project handoff. Advanced Export Modal
  • Seamless Light/Dark Theme: Switch between light and dark modes with a single click. Your preference is saved automatically for your next session. Light/Dark Theme Toggle
  • And much more: Enjoy features like dynamic note fields that expand as you type, integrated asset captions, quick access to recent projects, shot search with Ctrl+Shift+F, visual drag-and-drop reorder grid, alternative video asset support, and sticky header.

πŸ”§ Installation

Get started with ShotBase in just a few steps. Using uv is recommended for its speed and efficiency.

  1. Clone the Repository (We use a shallow clone to download faster)

    git clone --depth 1 https://github.com/taruma/shotbase.git
    cd shotbase
  2. Install Dependencies

    • (Recommended) Using uv:
      # Install uv if you haven't: https://docs.astral.sh/uv/
      uv sync
    • Using venv and pip:
      python -m venv .venv
      source .venv/bin/activate  # On Windows: .venv\Scripts\activate
      pip install -r requirements.txt
  3. Run the Server

    # If using uv
    uv run run.py
    
    # If using venv and pip
    python run.py
  4. Open Your Browser Navigate to http://127.0.0.1:5001 to start using ShotBase!

πŸ“ How It Works: Project Folder Structure

ShotBase automatically creates and maintains a clean, predictable folder structure for every project. This ensures your assets are always organized and easy to find.

project_folder/
β”œβ”€β”€ shots/
β”‚   β”œβ”€β”€ latest_images/    # The current, "promoted" image for each shot (e.g., SH010.png)
β”‚   β”œβ”€β”€ latest_videos/    # The current, "promoted" video for each shot (e.g., SH010.mp4)
β”‚   └── wip/              # Work-in-progress and old versions are archived here
β”‚       └── SH010/
β”‚           β”œβ”€β”€ images/   # e.g., SH010_v001.png, SH010_v002.png
β”‚           └── videos/   # e.g., SH010_v001.mp4
└── project_info.json     # Metadata like title, version, and notes

πŸ“œ Attribution and License

This project is a fork that significantly extends and modernizes the original work.

  • Forked from Shotbuddy by Albert Bozesan (@albozes).
  • Maintained and extended by Taruma Sakti.
  • This project is licensed under the MIT License.

This project is developed with AI assistance. For detailed attribution, see the CHANGELOG.md.

About

An open-source tool designed to manage, organize, and streamline your entire AI filmmaking asset workflow.

Resources

License

Stars

Watchers

Forks

Contributors