Summary
Document the unified animation playback model in the README.
The current README lists transition APIs, baked animation playback, snippet/curve playback, and clip helpers, but it does not explain how those pieces fit together or why the system is valuable.
Problem
One of Loom3's strongest features is that baked animations and prescribed/generated animations now live in the same playback world and can be remixed in realtime.
The README does not explain that clearly.
In particular, it does not explain:
- how transition playback differs from mixer-backed clip playback
- that loaded baked clips and generated/snippet clips share the same mixer-backed controller surface
- why those animation sources can be layered and remixed together
- how AU / viseme / direct runtime control coexists with clip playback
- what makes the system efficient enough for realtime use
- what makes combined playback reliable and predictable instead of fighting itself
That missing explanation makes the library look like a bag of features instead of a coherent animation system.
Scope
- Add a dedicated README section for the animation architecture
- Explain, at a high level, the roles of:
- transition playback
- baked clip playback
- snippet / curve-to-clip playback
- shared playback handles and state APIs
- crossfading / weight / playback rate / loop behavior
- Explain that baked animations and generated/snippet clips are remixable because they use the same mixer-backed playback model
- Explain how direct control APIs fit alongside mixer-backed playback
- Explain the efficiency story in concrete terms, not marketing language
- Explain the reliability story in concrete terms, not marketing language
- Include at least one example that intentionally combines:
- a baked clip
- a generated/snippet clip or clip helper
- live AU or viseme control
Acceptance Criteria
Related
Summary
Document the unified animation playback model in the README.
The current README lists transition APIs, baked animation playback, snippet/curve playback, and clip helpers, but it does not explain how those pieces fit together or why the system is valuable.
Problem
One of Loom3's strongest features is that baked animations and prescribed/generated animations now live in the same playback world and can be remixed in realtime.
The README does not explain that clearly.
In particular, it does not explain:
That missing explanation makes the library look like a bag of features instead of a coherent animation system.
Scope
Acceptance Criteria
Related
#31