diff options
Diffstat (limited to 'tools/timeline_editor/README.md')
| -rw-r--r-- | tools/timeline_editor/README.md | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/tools/timeline_editor/README.md b/tools/timeline_editor/README.md index aed140e..1c73c53 100644 --- a/tools/timeline_editor/README.md +++ b/tools/timeline_editor/README.md @@ -50,22 +50,39 @@ Interactive web-based editor for `demo.seq` timeline files. ## File Format +⚠️ **For complete format specification, see:** `doc/SEQUENCE.md` + The editor parses and generates `.seq` files with this format: ``` -SEQUENCE <start_time> <priority> - EFFECT <ClassName> <start_time> <end_time> <priority> [args...] - EFFECT <ClassName> <start_time> <end_time> <priority> [args...] +# BPM 120 +SEQUENCE <start_time> <priority> ["optional_name"] [optional_end] + EFFECT <+|=|-> <ClassName> <start_time> <end_time> [args...] + EFFECT <+|=|-> <ClassName> <start_time> <end_time> [args...] ``` +**Priority Modifiers:** +- `+` = Increment priority (normal effects) +- `=` = Keep same priority as previous +- `-` = Decrement priority (background layers) + +**Time Notation:** +- `0b`, `4b`, `64b` = Beats (converted using BPM) +- `0.0`, `2.0`, `32.0` = Seconds +- Integer without 'b': treated as beats +- Decimal point: treated as seconds + Example: ``` -SEQUENCE 0.0 0 - EFFECT FlashEffect 0.0 1.0 0 - EFFECT FadeEffect 0.5 2.0 1 +# BPM 120 +SEQUENCE 0b 0 "Opening Scene" + EFFECT - FlashCubeEffect .2 3 # Background (priority -1) + EFFECT + FlashEffect 0.0 1.0 # Foreground (priority 0) + EFFECT + FadeEffect 0.5 2.0 # Overlay (priority 1) -SEQUENCE 3.0 1 - EFFECT HeptagonEffect 0.0 0.5 0 +SEQUENCE 4b 1 "Beat Drop" + EFFECT + HeptagonEffect 0.0 0.5 # Priority 0 + EFFECT = ParticlesEffect 0.0 2.0 # Priority 0 (same layer) ``` ## Color Coding |