Updated README

Author: latenitefilms

README.md

@@ -1,13 +1,23 @@
 # Corridor Key Toolbox
 
-An FxPlug4 plug-in for Final Cut Pro that ports [CorridorKey](https://github.com/nikopueringer/CorridorKey)'s AI green-screen keying to Apple Silicon.
+**Corridor Key Toolbox** is an Motion Template that brings [CorridorKey](https://github.com/nikopueringer/CorridorKey)'s keying power to Final Cut Pro.
+
+Niko explains:
+
+> When you film something against a green screen, the edges of your subject inevitably blend with the green background. This creates pixels that are a mix of your subject's color and the green screen's color. Traditional keyers struggle to untangle these colors, forcing you to spend hours building complex edge mattes or manually rotoscoping. Even modern "AI Roto" solutions typically output a harsh binary mask, completely destroying the delicate, semi-transparent pixels needed for a realistic composite.
+>
+> I built CorridorKey to solve this *unmixing* problem.
+>
+> You input a raw green screen frame, and the neural network completely separates the foreground object from the green screen. For every single pixel, even the highly transparent ones like motion blur or out-of-focus edges, the model predicts the true, un-multiplied straight color of the foreground element, alongside a clean, linear alpha channel. It doesn't just guess what is opaque and what is transparent; it actively reconstructs the color of the foreground object as if the green screen was never there.
+>
+> No more fighting with garbage mattes or agonizing over "core" vs "edge" keys. Give CorridorKey a hint of what you want, and it separates the light for you.
 
 ---
 
 ## Targets
 
-| Target                      | Product                             | Role                                                                 |
-| --------------------------- | ----------------------------------- | -------------------------------------------------------------------- |
+| Target                          | Product                                 | Role                                                                 |
+| ------------------------------- | --------------------------------------- | -------------------------------------------------------------------- |
 | `Corridor Key Toolbox`          | `Corridor Key Toolbox.app`              | Wrapper application required for App Store packaging and discovery.  |
 | `Corridor Key Toolbox Renderer` | `Corridor Key Toolbox.pluginkit` (XPC)  | The actual FxPlug plug-in Final Cut Pro loads into its plug-in host. |
 
@@ -19,14 +29,14 @@ The wrapper embeds the XPC service inside its `Contents/PlugIns` directory, so a
 
 ```
 Source/
-├── CorridorKeyPro.xcodeproj
+├── CorridorKeyToolbox.xcodeproj
 ├── Configuration/
 │   └── Shared.xcconfig             # Shared build settings
-├── CorridorKeyPro/
+├── CorridorKeyToolbox/
 │   ├── Plugin/
 │   │   ├── main.swift              # XPC entry point
-│   │   ├── CorridorKeyProPlugIn.swift
-│   │   ├── CorridorKeyProPlugIn+*.swift (protocol slices)
+│   │   ├── CorridorKeyToolboxPlugIn.swift
+│   │   ├── CorridorKeyToolboxPlugIn+*.swift (protocol slices)
 │   │   ├── Parameters/             # Identifiers, enums, state, UI
 │   │   ├── Render/
 │   │   │   └── RenderPipeline.swift
@@ -42,12 +52,12 @@ Source/
 │   │   │   └── ScreenColorEstimator.swift
 │   │   ├── Shared/
 │   │   │   ├── CorridorKeyShaderTypes.h
-│   │   │   └── CorridorKeyPro-Bridging-Header.h
+│   │   │   └── CorridorKeyToolbox-Bridging-Header.h
 │   │   ├── Resources/en.lproj/InfoPlist.strings
 │   │   ├── Info.plist
-│   │   └── CorridorKeyPro.entitlements
+│   │   └── CorridorKeyToolbox.entitlements
 │   └── WrapperApp/
-│       ├── CorridorKeyProApp.swift # SwiftUI app entry point
+│       ├── CorridorKeyToolboxApp.swift # SwiftUI app entry point
 │       ├── WelcomeView.swift
 │       ├── Info.plist
 │       ├── WrapperApp.entitlements
@@ -58,13 +68,13 @@ Source/
 
 ## Architecture overview
 
-1. **FxPlug integration** – `CorridorKeyProPlugIn` conforms to both
+1. **FxPlug integration** – `CorridorKeyToolboxPlugIn` conforms to both
    `FxTileableEffect` (render callbacks) and `FxAnalyzer` (pre-render analysis).
    Extensions split the class so each protocol responsibility lives in a
    dedicated file.
 2. **Parameter layer** – `ParameterIdentifiers.swift` assigns every UI control
-   a stable identifier. `CorridorKeyProPlugIn+Parameters.swift` builds the
-   inspector; `CorridorKeyProPlugIn+PluginState.swift` reads those values into
+   a stable identifier. `CorridorKeyToolboxPlugIn+Parameters.swift` builds the
+   inspector; `CorridorKeyToolboxPlugIn+PluginState.swift` reads those values into
    a `PluginStateData` snapshot that the renderer owns for the duration of a
    tile render.
 3. **Render pipeline** – `RenderPipeline` orchestrates the per-frame Metal
@@ -86,7 +96,9 @@ Source/
 
 ## Building
 
-Open `CorridorKeyPro.xcodeproj` in Xcode and build the `Corridor Key Toolbox` scheme. On first open Xcode will resolve the `mlx-swift` Swift package; this takes ~30 seconds over a cold network and is cached thereafter.
+Open `CorridorKeyToolbox.xcodeproj` in Xcode and build the `Corridor Key Toolbox` scheme.
+
+On first open Xcode will resolve the `mlx-swift` Swift package; this takes ~30 seconds over a cold network and is cached thereafter.
 
 ---
 
@@ -95,4 +107,19 @@ Open `CorridorKeyPro.xcodeproj` in Xcode and build the `Corridor Key Toolbox` sc
 - Swift 6 with complete strict-concurrency enabled.
 - Only first-party Apple + `mlx-swift` dependencies.
 - All pixel maths in Metal compute shaders; the CPU side stays on the coordination hot path.
-- Parameter identifiers are never renumbered: add new controls, never move existing ones.
+- Parameter identifiers are never renumbered: add new controls, never move existing ones.
+
+---
+
+## Acknowledgements
+
+Corridor Key Toolbox would NOT be possible without Niko's amazing [Corridor Key](https://github.com/nikopueringer/CorridorKey).
+
+Niko's Corridor Key repo integrates several open-source modules for Alpha Hint generation.
+
+We would like to also explicitly credit and thank the following research teams:
+
+- **Generative Video Matting (GVM):** Developed by the Advanced Intelligent Machines (AIM) research team at Zhejiang University. The GVM code and models are heavily utilized in the `gvm_core` module. Their work is licensed under the [2-clause BSD License (BSD-2-Clause)](https://opensource.org/license/bsd-2-clause). You can find their source repository here: [aim-uofa/GVM](https://github.com/aim-uofa/GVM). Give them a star!
+- **VideoMaMa:** Developed by the CVLAB at KAIST. The VideoMaMa architecture is utilized within the `VideoMaMaInferenceModule`. Their code is released under the [Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/), and their specific foundation model checkpoints (`dino_projection_mlp.pth`, `unet/*`) are subject to the [Stability AI Community License](https://stability.ai/license). You can find their source repository here: [cvlab-kaist/VideoMaMa](https://github.com/cvlab-kaist/VideoMaMa). Give them a star!
+
+By using these optional modules, you agree to abide by their respective Non-Commercial licenses. Please review their repositories for full terms.