sporel/sporel-lib-core.puppet
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(puppet): README sync to v0.4.4 (set_play_speed API)

Browse Source
This commit is contained in:
Axel Meyer
2026-05-19 00:29:48 +02:00
parent df84287e65
commit b20a1b0443
1 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -7,7 +7,7 @@ playback (multi-channel: rot/pos/scl), multi-target look-at constraints
and a per-channel conflict guard that allows animation and procedural and a per-channel conflict guard that allows animation and procedural
layers to coexist on the same bones. layers to coexist on the same bones.
**Version:** 0.4.3 **Version:** 0.4.4
**Lib-ID:** lib-core.puppet **Lib-ID:** lib-core.puppet
**Requires:** (none — pure Lua + engine.render.* + engine.asset.*) **Requires:** (none — pure Lua + engine.render.* + engine.asset.*)
**Tags:** animation, skeleton, puppet, character **Tags:** animation, skeleton, puppet, character
@@ -75,11 +75,14 @@ callback. Per-channel conflict guard: raises if the written channel is also
written by a keyframe in any active animation on that bone's track. Allows written by a keyframe in any active animation on that bone's track. Allows
procedural to write `rot` while an animation writes `scl` on the same bone. procedural to write `rot` while an animation writes `scl` on the same bone.
### `puppet.play(handle, anim_id, {loop?, speed?})`, `puppet.stop(handle, anim_id)`, `puppet.stop_all(handle)`, `puppet.is_playing(handle, anim_id)` ### `puppet.play(handle, anim_id, {loop?, speed?})`, `puppet.stop(handle, anim_id)`, `puppet.stop_all(handle)`, `puppet.is_playing(handle, anim_id)`, `puppet.set_play_speed(handle, anim_id, speed)` (v0.4.4)
Keyframe-layer controls. Animation must be registered via Keyframe-layer controls. Animation must be registered via
`puppet.register_animation(handle, anim)` first. `speed` defaults to 1.0; `puppet.register_animation(handle, anim)` first. `speed` defaults to 1.0;
pass a value like `0.45` for a slower cadence. pass a value like `0.45` for a slower cadence. `set_play_speed` mutates the
speed of a currently-playing anim **without resetting its cycle position**
— useful for mid-anim speed changes (e.g., sprint toggle). Silent no-op
if the anim is not currently playing.
### `puppet.register_animation(handle, anim)` ### `puppet.register_animation(handle, anim)`
@@ -148,6 +151,13 @@ Not for production use.
## CHANGELOG ## CHANGELOG
### v0.4.4
- `puppet.set_play_speed(handle, anim_id, speed)`: mutates the play-speed
of a currently-running animation WITHOUT resetting its cycle position.
Silent no-op if anim is not playing. Use case: sprint-toggle mid-walk
doubles cadence smoothly (`puppet.play` with new speed would reset
`t = 0` and visibly restart the cycle).
### v0.4.3 ### v0.4.3
- `inherit_scale: false` bone flag: when false, `world.scl = local.scl` - `inherit_scale: false` bone flag: when false, `world.scl = local.scl`
(parent.world.scl not multiplied). Position cascade still uses parent.scl. (parent.world.scl not multiplied). Position cascade still uses parent.scl.
@@ -206,8 +216,8 @@ Not for production use.
## References ## References
- `architecture/puppet.md` (Reference — updated to v0.4.3) - `architecture/puppet.md` (Reference — updated to v0.4.4)
- `superpowers/specs/2026-05-18-puppet-subterrain-model-design.md` (Baseline Spec v0.4.3) - `superpowers/specs/2026-05-18-puppet-subterrain-model-design.md` (Baseline Spec v0.4.3+)
- `docs/adrs/0040-puppet-subterrain-model-pivot.md` (Pivot rationale) - `docs/adrs/0040-puppet-subterrain-model-pivot.md` (Pivot rationale)
- ADR-0037 (Tests-as-Libs) - ADR-0037 (Tests-as-Libs)
- ADR-0038 (API-Doc-Convention) - ADR-0038 (API-Doc-Convention)