Add runtime loader for validated JSON animation packs #78

New issue

Open

opened 2026-05-23 00:45:42 -04:00 by JackFrostbyte · 0 comments

JackFrostbyte commented

2026-05-23 00:45:42 -04:00

Owner

Objective

Add runtime support for loading and executing validated JSON animation packs.

RGB Aura should remain the execution engine. The animation pack should only describe data. The runtime interprets the validated data using safe internal logic.

Scope

Implement the first runtime loader for JSON animation packs.

The loader should:

Accept a path to a JSON animation pack.
Validate or require validation before execution.
Map pack logical zones to the current device mapping.
Convert supported effects into existing RGB Aura runtime operations.
Preserve existing safety behavior.

Required runtime behavior

The loader must preserve:

Existing runtime guardrails.
Reserved ARGB zone protection.
Dark-blue restore behavior.
Safe shutdown behavior.
Logging behavior.
Dry-run behavior where applicable.
Existing OpenRGB connection safety.

Required CLI behavior

Add a way to run a JSON animation pack from the command line.

The exact option name can be chosen during implementation, but it should be clear and documented.

Possible example:

--animation-pack path/to/pack.json

Out of scope

Executing arbitrary Python from packs.
Downloading animation packs.
GUI pack selection.
Full pack marketplace support.
Advanced unsupported effects.

Acceptance criteria

RGB Aura can load the first built-in JSON animation pack.
The runtime refuses invalid packs.
The runtime refuses packs that use the reserved ARGB zone.
The runtime refuses out-of-range LED indexes.
Existing safety features remain intact.
Tests cover loader behavior.
Documentation explains how to run a JSON animation pack.

# Objective Add runtime support for loading and executing validated JSON animation packs. RGB Aura should remain the execution engine. The animation pack should only describe data. The runtime interprets the validated data using safe internal logic. # Scope Implement the first runtime loader for JSON animation packs. The loader should: - Accept a path to a JSON animation pack. - Validate or require validation before execution. - Map pack logical zones to the current device mapping. - Convert supported effects into existing RGB Aura runtime operations. - Preserve existing safety behavior. # Required runtime behavior The loader must preserve: - Existing runtime guardrails. - Reserved ARGB zone protection. - Dark-blue restore behavior. - Safe shutdown behavior. - Logging behavior. - Dry-run behavior where applicable. - Existing OpenRGB connection safety. # Required CLI behavior Add a way to run a JSON animation pack from the command line. The exact option name can be chosen during implementation, but it should be clear and documented. Possible example: - --animation-pack path/to/pack.json # Out of scope - Executing arbitrary Python from packs. - Downloading animation packs. - GUI pack selection. - Full pack marketplace support. - Advanced unsupported effects. # Acceptance criteria - RGB Aura can load the first built-in JSON animation pack. - The runtime refuses invalid packs. - The runtime refuses packs that use the reserved ARGB zone. - The runtime refuses out-of-range LED indexes. - Existing safety features remain intact. - Tests cover loader behavior. - Documentation explains how to run a JSON animation pack.

JackFrostbyte added reference develop

2026-05-23 00:45:45 -04:00

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

2026-05-23 00:45:48 -04:00

JackFrostbyte added a new dependency

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

#75 Define strict JSON animation-pack schema

JackFrostbyte added a new dependency

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

#76 Add animation-pack validator CLI

JackFrostbyte added a new dependency

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