Add animation-pack validator CLI #76

New issue

Open

opened 2026-05-23 00:43:41 -04:00 by JackFrostbyte · 0 comments

JackFrostbyte commented

2026-05-23 00:43:41 -04:00

Owner

Objective

Add a command-line validator for RGB Aura JSON animation packs.

The validator should allow a user or contributor to validate an animation pack before attempting to run it through the RGB Aura runtime.

Scope

Create a validator script or CLI command that checks an animation pack against:

The JSON animation-pack schema.
The current-machine device profile.
RGB Aura safety rules.

Required validation behavior

The validator should check:

JSON syntax.
Schema compliance.
Required metadata.
Compatible schema version.
Compatible device profile.
Known logical zones only.
No reserved ARGB zone usage.
LED indexes within usable ranges.
Supported effect types only.
Valid color values.
Valid durations.
Valid timeline structure.
Safe bounded values.

Required CLI behavior

The command should provide clear output:

Success message when the pack is valid.
Clear errors when the pack is invalid.
Path of the validated pack.
Optional summary of zones/effects found in the pack.

Out of scope

Running animations.
Modifying packs automatically.
GUI validation.
Downloading or fetching packs.

Acceptance criteria

A validator command or script exists.
A valid animation pack passes.
Invalid JSON fails clearly.
Reserved zone usage fails clearly.
Out-of-range LED indexes fail clearly.
Unknown effect types fail clearly.
Tests cover important validator success and failure cases.

# Objective Add a command-line validator for RGB Aura JSON animation packs. The validator should allow a user or contributor to validate an animation pack before attempting to run it through the RGB Aura runtime. # Scope Create a validator script or CLI command that checks an animation pack against: - The JSON animation-pack schema. - The current-machine device profile. - RGB Aura safety rules. # Required validation behavior The validator should check: - JSON syntax. - Schema compliance. - Required metadata. - Compatible schema version. - Compatible device profile. - Known logical zones only. - No reserved ARGB zone usage. - LED indexes within usable ranges. - Supported effect types only. - Valid color values. - Valid durations. - Valid timeline structure. - Safe bounded values. # Required CLI behavior The command should provide clear output: - Success message when the pack is valid. - Clear errors when the pack is invalid. - Path of the validated pack. - Optional summary of zones/effects found in the pack. # Out of scope - Running animations. - Modifying packs automatically. - GUI validation. - Downloading or fetching packs. # Acceptance criteria - A validator command or script exists. - A valid animation pack passes. - Invalid JSON fails clearly. - Reserved zone usage fails clearly. - Out-of-range LED indexes fail clearly. - Unknown effect types fail clearly. - Tests cover important validator success and failure cases.

JackFrostbyte added reference develop

2026-05-23 00:43:43 -04:00

JackFrostbyte added this to the v1.1.0 — LLM-assisted aura creation vertical slice milestone

2026-05-23 00:43:46 -04:00

JackFrostbyte added a new dependency

2026-05-23 00:44:00 -04:00

#75 Define strict JSON animation-pack schema

JackFrostbyte added a new dependency

2026-05-23 00:44:40 -04:00

#77 Add first built-in JSON animation pack

JackFrostbyte added a new dependency

2026-05-23 00:47:02 -04:00