Guides

Guides

Start with the shortest path to a usable key, then branch into Alpha Hint setup, quality decisions, and support checks only when you need them.

setup

Installation

Get Corridor Key into DaVinci Resolve with the correct installer and the least friction.

Recommended flow

  1. Choose the installer that matches your platform: macOS Apple Silicon or Windows RTX for the official tracks.
  2. Close DaVinci Resolve before running the installer so the OFX scan cache can refresh cleanly.
  3. Install the build, reopen Resolve, and search for Corridor Key in the OpenFX Library.
  4. If the plugin does not appear, move straight to the troubleshooting checklist before forcing other changes.

What matters most

  • Resolve 20 is the officially supported host target.
  • Linux RTX and Windows DirectML are available, but remain experimental.

workflow

First usable result

Build a quick guided setup that gets you to a stable key before you start polishing edges.

Recommended flow

  1. Add Corridor Key to the clip and create a rough matte from a Qualifier, 3D Keyer, or another guide source.
  2. Route that matte into Alpha Hint so the model has a believable subject guide instead of relying on Rough Fallback.
  3. Set Quality to High (1024) as the practical starting point and leave Input Color Space on Auto (Host Managed).
  4. Verify Effective Quality and Guide Source in the runtime panel before changing any refinement controls.

What matters most

  • Trust Effective Quality, not the dropdown alone.
  • Processed is the normal output. Switch views only when diagnosing a specific problem.

workflow

Alpha Hint basics

Feed the plugin the guide matte it expects so the key starts from the right place.

Recommended flow

  1. Prefer a true alpha or single-channel matte whenever possible.
  2. If you feed an RGB guide, make sure the matte lives in the red channel because the current OFX build does not compute luminance from RGB.
  3. Check the runtime panel and look for External Alpha Hint instead of Rough Fallback.
  4. Judge final quality only after the preferred guided path is active.

What matters most

  • Alpha Hint is a setup step, not a finishing pass.
  • A rough but believable guide is better than waiting for perfect hair detail.

support

Troubleshooting

Diagnose the most common install, host, and backend mismatches without guesswork.

Recommended flow

  1. Confirm the installed package matches the hardware path you expect: Windows RTX, macOS Apple Silicon, or an explicitly experimental build.
  2. Run corridorkey doctor when the backend, quality, or package behavior looks wrong outside Resolve.
  3. If you need support, reproduce the issue once and then collect the newest runtime logs for your platform before changing more variables.
  4. Use Resolve logs when the plugin fails to load, register, or initialize inside the host.
  5. Treat DirectML, Linux RTX, and older Resolve versions as lower-confidence paths with explicit caveats.

What matters most

  • The OFX plugin prefers explicit failure over silent CPU fallback.
  • Outdated drivers and the wrong release track are two of the fastest ways to lose time.
  • For support, the most useful package is corridorkey doctor output, the latest runtime logs, and the Resolve host log when the issue is plugin-specific.

What to send for support

Reproduce the issue once, then send the latest evidence instead of screenshots alone. That usually means doctor output, the Corridor Key runtime logs, and the Resolve host log when the issue is specific to plugin loading or registration.

corridorkey doctor output

Run corridorkey doctor and include the full output. It reports hardware, backend selection, packaged artifacts, and fallback conditions.

Corridor Key runtime logs

After reproducing the issue once, send the newest files from the Corridor Key log folder. In current builds this usually includes a versioned ofx_runtime_server_v*.log file and an ofx.log file.

  • macOS: ~/Library/Logs/CorridorKey/
  • Windows: %LOCALAPPDATA%\CorridorKey\Logs\

DaVinci Resolve host logs

On Windows, the safest way to collect this is Help > Create Diagnostics Log on Desktop. If Resolve will not launch, run CaptureLogs from the Resolve install folder instead. Include the Resolve-side log when the plugin does not show up, refuses to load, or fails during OFX initialization.

  • macOS: ~/Library/Application Support/Blackmagic Design/DaVinci Resolve/logs/
  • Windows: Help > Create Diagnostics Log on Desktop
  • Windows fallback: C:\Program Files\Blackmagic Design\DaVinci Resolve\CaptureLogs
  • Windows manual path (typical): %APPDATA%\Blackmagic Design\DaVinci Resolve\Support\logs\

System details

Mention your OS version, GPU model, driver version, Resolve version, and which installer or release track you used.