gitmyhub

CorridorKey

Python ★ 14k updated 23d ago

Perfect Green Screen Keys

A neural-network VFX tool that cleanly removes green or blue screen backgrounds from footage, preserving soft details like hair and motion blur that traditional keying tools miss.

PythonPyTorchOpenEXRuvsetup: moderatecomplexity 3/5

CorridorKey is a tool for visual effects work that removes a green screen background from footage. The README starts with the problem: when you film someone in front of a green screen, the edges of the person blend with the green, creating pixels that are a mix of both colors. Traditional tools struggle with these edges and force artists to spend hours cleaning them up by hand, while many newer automatic tools produce a harsh cutout that ruins soft, see-through details like loose hair or motion blur.

CorridorKey uses a neural network, a kind of trained AI model, to do what the author calls unmixing. For every pixel, including the partly transparent ones, it works out the true color of the foreground subject as if the green screen had never been there, along with a clean transparency channel. The aim is a realistic result you can drop onto a new background without obvious fringing. You give it a raw frame plus a hint of what you want to keep, and it separates the subject for you. It handles both green and blue screens and can read and write the high-quality EXR image files used in professional software such as Nuke, Fusion, and Resolve.

The README is candid that this is a brand new release that will have rough edges, and it invites people to report problems, contribute fixes, and join a Discord community. A separate, more beginner-friendly version with an easy installer, called EZ-CorridorKey, is linked for artists who do not want to deal with setup.

Installation is handled by a tool called uv, which sets up Python and all the needed parts in one step, with double-click scripts provided for Windows, Mac, and Linux. The hardware notes are honest: it was built on a very high-end machine, but recent versions are said to run on computers with far less graphics memory and on Apple Silicon Macs. The main model downloads automatically on first use, and some heavier optional components are available for those with powerful hardware.

Where it fits