User Guide

This guide covers everything needed to go from a fresh machine to processed footage. No programming knowledge is required.

Documents in This Section

• Installation - Install CorridorKey on Windows, macOS, or Linux.
• First run - Run corridorkey init to download the model and verify your setup.
• Preparing clips - How to organise your footage before processing.
• Processing clips - Use the wizard to key your footage and understand the results.
• Outputs - What files are written and how to use them in your compositing app.
• Troubleshooting - Common problems and how to fix them.

Quick Start

1. Install using the one-line installer for your platform (see Installation).
2. Run corridorkey init to download the model.
3. Point the wizard at a folder of green screen footage:

corridorkey wizard /path/to/clips