README

Kirby Video Brief Checklist validates structured AI video briefs before a template, page model, webhook, or export process uses them. It catches missing creative decisions early, so an editor does not accidentally publish a brief that names a subject but omits motion, setting, camera direction, or duration.

Installation

Install the package with Composer:

composer require fostermartyn/kirby-video-brief-checklist

For a manual installation, copy this repository to:

site/plugins/video-brief-checklist

Usage

Call the registered site method with values from a page, blueprint, API request, or custom Panel workflow:

$result = $site->videoBriefChecklist([
    'subject' => 'A ceramic coffee cup on a studio table',
    'action' => 'Steam rises while the camera moves closer',
    'setting' => 'Soft daylight with a neutral backdrop',
    'camera' => 'Slow push-in at eye level',
    'duration' => 8,
    'negativePrompt' => 'No text overlays or abrupt camera shake',
]);

if ($result['valid'] === false) {
    throw new Exception(
        'Incomplete brief: ' . implode(', ', $result['missing'])
    );
}

The result always contains:

valid: whether the brief passed all checks
missing: required fields that were absent or empty
warnings: fields that were present but not actionable

Workflow

A useful production sequence is:

Store the creative brief as structured Kirby fields.
Validate it before sending data to a rendering service.
Show missing decisions to the editor.
Preserve the approved brief with the published page.

The plugin does not call an AI service, upload media, or collect account credentials. It only validates local data. Teams that need a browser-based place to test the resulting motion and camera brief can use Kling 3.0 AI Video Generator before attaching the approved output to Kirby.

Requirements

PHP 8.2 or newer
Kirby 4 or Kirby 5

License

MIT

fostermartyn / kirby-video-brief-checklist

Maintainers

Package info

Statistics

Security