@warpgogol/forge 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +4 -3
- package/README.md +58 -5
- package/dist/bin/cli.js +0 -0
- package/dist/os/core/core.module.d.ts.map +1 -1
- package/dist/os/core/core.module.js +10 -0
- package/dist/os/core/core.module.js.map +1 -1
- package/dist/os/rfc/handlers/shared.d.ts.map +1 -1
- package/dist/os/rfc/handlers/shared.js +12 -6
- package/dist/os/rfc/handlers/shared.js.map +1 -1
- package/dist/os/rfc/index.d.ts +1 -1
- package/dist/os/rfc/index.d.ts.map +1 -1
- package/dist/os/rfc/index.js +1 -1
- package/dist/os/rfc/index.js.map +1 -1
- package/dist/os/rfc/types.d.ts +2 -1
- package/dist/os/rfc/types.d.ts.map +1 -1
- package/dist/os/rfc/types.js +2 -1
- package/dist/os/rfc/types.js.map +1 -1
- package/dist/os/spec/spec-materialize.d.ts.map +1 -1
- package/dist/os/spec/spec-materialize.js +4 -10
- package/dist/os/spec/spec-materialize.js.map +1 -1
- package/dist/src/onboarding/create.d.ts.map +1 -1
- package/dist/src/onboarding/create.js +5 -2
- package/dist/src/onboarding/create.js.map +1 -1
- package/dist/src/onboarding/doctor.d.ts.map +1 -1
- package/dist/src/onboarding/doctor.js +38 -0
- package/dist/src/onboarding/doctor.js.map +1 -1
- package/dist/src/onboarding/invariant-engine.d.ts.map +1 -1
- package/dist/src/onboarding/invariant-engine.js +52 -1
- package/dist/src/onboarding/invariant-engine.js.map +1 -1
- package/dist/src/onboarding/scaffold-project.d.ts.map +1 -1
- package/dist/src/onboarding/scaffold-project.js +25 -5
- package/dist/src/onboarding/scaffold-project.js.map +1 -1
- package/dist/src/profiles/profile-schema.d.ts +77 -1
- package/dist/src/profiles/profile-schema.d.ts.map +1 -1
- package/dist/src/profiles/profile-schema.js +39 -2
- package/dist/src/profiles/profile-schema.js.map +1 -1
- package/dist/src/profiles/stack-profile.d.ts +27 -0
- package/dist/src/profiles/stack-profile.d.ts.map +1 -1
- package/dist/src/profiles/stack-profile.js +4 -0
- package/dist/src/profiles/stack-profile.js.map +1 -1
- package/package.json +162 -60
- package/profiles/editframe-templates/composition-agents.md +70 -0
- package/profiles/editframe-templates/composition.tsx +33 -0
- package/profiles/editframe-templates/html-composition-agents.md +62 -0
- package/profiles/{editframe-html.yaml → editframe.yaml} +203 -38
- package/skills/fo/ef-brand-video-generator/SKILL.md +101 -0
- package/skills/fo/ef-composition/SKILL.md +147 -0
- package/skills/fo/ef-composition-review/SKILL.md +66 -0
- package/skills/fo/ef-dev-server/SKILL.md +107 -0
- package/skills/fo/ef-editor-gui/SKILL.md +131 -0
- package/skills/fo/ef-motion-design/SKILL.md +118 -0
- package/skills/fo/ef-onboard/SKILL.md +77 -0
- package/skills/fo/ef-render-verify/SKILL.md +56 -0
- package/skills/fo/ef-webhooks/SKILL.md +95 -0
- package/skills/fo/fo-session-retro/SKILL.md +2 -2
- package/profiles/editframe-html-templates/composition-agents.md +0 -34
- package/profiles/editframe-html-templates/composition.html +0 -32
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Composition Workspace
|
|
2
|
+
|
|
3
|
+
This workspace contains an Editframe video composition.
|
|
4
|
+
|
|
5
|
+
## Domain terminology
|
|
6
|
+
|
|
7
|
+
- **Composition** — the artifact this workspace produces (a `.tsx` file using `@editframe/react` components).
|
|
8
|
+
- **Scene** — a structural module within a composition (a `Timegroup` block).
|
|
9
|
+
- **Director** — the operator who creates and renders the composition.
|
|
10
|
+
|
|
11
|
+
## Quality invariants
|
|
12
|
+
|
|
13
|
+
| ID | Description | Severity |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| VIDEO-01 | Composition filenames must use kebab-case (lowercase letters, digits, hyphens only). | error |
|
|
16
|
+
| VIDEO-02 | Scene durations must use `contain` fit mode by default to avoid unexpected cropping. Use `cover` or `fill` only when intentionally overriding. | warning |
|
|
17
|
+
| VIDEO-03 | All speech audio elements (`Audio` with speech content) must have corresponding `Captions` components for accessibility. | error |
|
|
18
|
+
|
|
19
|
+
Additional time model invariants (VIDEO-04 through VIDEO-09) may be available. Run `forge doctor` to check the full invariant set enforced by the active profile.
|
|
20
|
+
|
|
21
|
+
## Time model concepts
|
|
22
|
+
|
|
23
|
+
Editframe compositions use a time model based on `Timegroup` components from `@editframe/react`:
|
|
24
|
+
|
|
25
|
+
- **`TimelineRoot`** — the root container for the composition.
|
|
26
|
+
- **`Timegroup`** — a container that groups scenes and controls timing. The root Timegroup defines the composition's total duration.
|
|
27
|
+
- **`mode`** — timing behavior for children: `sequence` (play one after another), `fixed` (play at absolute offset), `contain` (fit within parent duration), `fit` (scale to fit).
|
|
28
|
+
- **`duration`** — CSS time string (e.g. `5s`, `300ms`, `2.5s`) defining how long the element plays.
|
|
29
|
+
- **`offset`** — CSS time string defining when the element starts relative to its parent.
|
|
30
|
+
- **`fps`** — positive integer defining frames per second (e.g. `30`, `60`).
|
|
31
|
+
- **`loop`** — boolean, only on the root Timegroup. Nested Timegroups should not loop.
|
|
32
|
+
|
|
33
|
+
## Workflow
|
|
34
|
+
|
|
35
|
+
1. Create a `.tsx` file with `@editframe/react` components (`TimelineRoot`, `Timegroup`, `Video`, `Audio`, `Text`, `Captions`).
|
|
36
|
+
2. Run `editframe preview` to preview the composition in the browser.
|
|
37
|
+
3. Run `ef-composition-review` to review the composition for time model correctness, accessibility, and best practices.
|
|
38
|
+
4. Run `editframe check` to validate the composition structure.
|
|
39
|
+
5. Run `editframe render -o dist/<name>.mp4` to produce the final video output.
|
|
40
|
+
6. Run `ef-render-verify` to verify the render — validation, build, determinism, output inspection.
|
|
41
|
+
|
|
42
|
+
## Skills
|
|
43
|
+
|
|
44
|
+
- **ef-onboard** — onboard a new project: prerequisites, discovery, scaffold, preview. Trigger: "create a new video project".
|
|
45
|
+
- **ef-composition-review** — review a composition for time model correctness, accessibility, and best practices before rendering. Trigger: "review this composition".
|
|
46
|
+
- **ef-render-verify** — verify a render: validate, build, check determinism, inspect output. Trigger: "render and verify".
|
|
47
|
+
- **ef-composition** — guide creating a new video composition with Editframe React components. Trigger: "create a video composition".
|
|
48
|
+
- **ef-dev-server** — set up and manage the Editframe dev server for live preview. Trigger: "set up editframe dev server".
|
|
49
|
+
- **ef-editor-gui** — configure the Editframe editor GUI for visual composition editing. Trigger: "open editframe editor".
|
|
50
|
+
- **ef-webhooks** — configure Editframe webhooks for render status notifications. Trigger: "set up editframe webhooks".
|
|
51
|
+
- **ef-brand-video-generator** — generate brand video compositions from templates. Trigger: "generate a brand video".
|
|
52
|
+
- **ef-motion-design** — apply motion design patterns to compositions. Trigger: "add motion design".
|
|
53
|
+
|
|
54
|
+
## External resources
|
|
55
|
+
|
|
56
|
+
- [Editframe llms.txt](https://editframe.com/llms.txt) — machine-readable index of Editframe domain skills
|
|
57
|
+
- [Editframe composition skill](https://editframe.com/skills/composition.md) — full reference for time model, elements, and rendering
|
|
58
|
+
- [Editframe getting started](https://editframe.com/getting-started) — step-by-step guide and agent prompt
|
|
59
|
+
|
|
60
|
+
## Reference template
|
|
61
|
+
|
|
62
|
+
A sample composition template is available at `editframe-templates/composition.tsx` in the forge profiles directory. Copy it to start a new composition:
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
cp node_modules/@warpgogol/forge/profiles/editframe-templates/composition.tsx compositions/my-new-video/composition.tsx
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## File naming
|
|
69
|
+
|
|
70
|
+
Composition files use kebab-case: `my-video.tsx`, `product-demo.tsx`, `intro-clip.tsx`.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Editframe React composition template
|
|
3
|
+
Copy this file to start a new composition. @editframe/react components:
|
|
4
|
+
- TimelineRoot: root container for the composition
|
|
5
|
+
- Timegroup: groups elements into a timed sequence
|
|
6
|
+
- Video: video source with fit mode (contain, cover, fill)
|
|
7
|
+
- Audio: audio source
|
|
8
|
+
- Text: text overlay with positioning
|
|
9
|
+
- Captions: accessibility captions for speech audio
|
|
10
|
+
Run `editframe preview` to preview, `editframe render` to produce output.
|
|
11
|
+
*/
|
|
12
|
+
import { TimelineRoot, Timegroup, Video, Text, Audio, Captions } from "@editframe/react";
|
|
13
|
+
|
|
14
|
+
export default function Composition() {
|
|
15
|
+
return (
|
|
16
|
+
<TimelineRoot>
|
|
17
|
+
<Timegroup duration="10s">
|
|
18
|
+
<Video src="assets/background.mp4" fit="contain" duration="10s" />
|
|
19
|
+
<Text
|
|
20
|
+
text="Your text here"
|
|
21
|
+
x="50%"
|
|
22
|
+
y="50%"
|
|
23
|
+
fontSize="48px"
|
|
24
|
+
color="white"
|
|
25
|
+
textAlign="center"
|
|
26
|
+
duration="5s"
|
|
27
|
+
/>
|
|
28
|
+
<Audio src="assets/narration.mp3" />
|
|
29
|
+
<Captions src="assets/captions.vtt" />
|
|
30
|
+
</Timegroup>
|
|
31
|
+
</TimelineRoot>
|
|
32
|
+
);
|
|
33
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# HTML Composition Workspace
|
|
2
|
+
|
|
3
|
+
This workspace contains an Editframe video composition using HTML web components.
|
|
4
|
+
|
|
5
|
+
## Domain terminology
|
|
6
|
+
|
|
7
|
+
- **Composition** — the artifact this workspace produces (an `.html` file using Editframe web components).
|
|
8
|
+
- **Scene** — a structural module within a composition (an `ef-timegroup` block).
|
|
9
|
+
- **Director** — the operator who creates and renders the composition.
|
|
10
|
+
|
|
11
|
+
## Quality invariants
|
|
12
|
+
|
|
13
|
+
| ID | Description | Severity |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| VIDEO-01 | Composition filenames must use kebab-case (lowercase letters, digits, hyphens only). | error |
|
|
16
|
+
| VIDEO-02 | Scene durations must use `contain` fit mode by default to avoid unexpected cropping. Use `cover` or `fill` only when intentionally overriding. | warning |
|
|
17
|
+
| VIDEO-03 | All speech audio elements (`ef-audio` with speech content) must have corresponding `ef-captions` components for accessibility. | error |
|
|
18
|
+
|
|
19
|
+
Additional time model invariants (VIDEO-04 through VIDEO-09) may be available. Run `forge doctor` to check the full invariant set enforced by the active profile.
|
|
20
|
+
|
|
21
|
+
## Time model concepts
|
|
22
|
+
|
|
23
|
+
Editframe HTML compositions use a time model based on web components:
|
|
24
|
+
|
|
25
|
+
- **`ef-timeline`** — the root container for the composition.
|
|
26
|
+
- **`ef-timegroup`** — a container that groups scenes and controls timing. The root ef-timegroup defines the composition's total duration.
|
|
27
|
+
- **`mode`** — timing behavior for children: `sequence` (play one after another), `fixed` (play at absolute offset), `contain` (fit within parent duration), `fit` (scale to fit).
|
|
28
|
+
- **`duration`** — CSS time string (e.g. `5s`, `300ms`, `2.5s`) defining how long the element plays.
|
|
29
|
+
- **`offset`** — CSS time string defining when the element starts relative to its parent.
|
|
30
|
+
- **`fps`** — positive integer defining frames per second (e.g. `30`, `60`).
|
|
31
|
+
- **`loop`** — boolean, only on the root ef-timegroup. Nested ef-timegroups should not loop.
|
|
32
|
+
|
|
33
|
+
## Workflow
|
|
34
|
+
|
|
35
|
+
1. Create an `.html` file with Editframe web components (`ef-timeline`, `ef-timegroup`, `ef-video`, `ef-audio`, `ef-text`, `ef-captions`).
|
|
36
|
+
2. Run `editframe preview` to preview the composition in the browser.
|
|
37
|
+
3. Run `ef-composition-review` to review the composition for time model correctness, accessibility, and best practices.
|
|
38
|
+
4. Run `editframe check` to validate the composition structure.
|
|
39
|
+
5. Run `editframe render -o dist/<name>.mp4` to produce the final video output.
|
|
40
|
+
6. Run `ef-render-verify` to verify the render — validation, build, determinism, output inspection.
|
|
41
|
+
|
|
42
|
+
## Skills
|
|
43
|
+
|
|
44
|
+
- **ef-onboard** — onboard a new project: prerequisites, discovery, scaffold, preview. Trigger: "create a new video project".
|
|
45
|
+
- **ef-composition-review** — review a composition for time model correctness, accessibility, and best practices before rendering. Trigger: "review this composition".
|
|
46
|
+
- **ef-render-verify** — verify a render: validate, build, check determinism, inspect output. Trigger: "render and verify".
|
|
47
|
+
- **ef-composition** — guide creating a new video composition with Editframe HTML components. Trigger: "create a video composition".
|
|
48
|
+
- **ef-dev-server** — set up and manage the Editframe dev server for live preview. Trigger: "set up editframe dev server".
|
|
49
|
+
- **ef-editor-gui** — configure the Editframe editor GUI for visual composition editing. Trigger: "open editframe editor".
|
|
50
|
+
- **ef-webhooks** — configure Editframe webhooks for render status notifications. Trigger: "set up editframe webhooks".
|
|
51
|
+
- **ef-brand-video-generator** — generate brand video compositions from templates. Trigger: "generate a brand video".
|
|
52
|
+
- **ef-motion-design** — apply motion design patterns to compositions. Trigger: "add motion design".
|
|
53
|
+
|
|
54
|
+
## External resources
|
|
55
|
+
|
|
56
|
+
- [Editframe llms.txt](https://editframe.com/llms.txt) — machine-readable index of Editframe domain skills
|
|
57
|
+
- [Editframe composition skill](https://editframe.com/skills/composition.md) — full reference for time model, elements, and rendering
|
|
58
|
+
- [Editframe getting started](https://editframe.com/getting-started) — step-by-step guide and agent prompt
|
|
59
|
+
|
|
60
|
+
## File naming
|
|
61
|
+
|
|
62
|
+
Composition files use kebab-case: `my-video.html`, `product-demo.html`, `intro-clip.html`.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
schema: forge/stack-profile@1
|
|
2
|
-
id: editframe
|
|
3
|
-
displayName: Editframe
|
|
2
|
+
id: editframe
|
|
3
|
+
displayName: Editframe Video
|
|
4
4
|
detect:
|
|
5
5
|
anyOf:
|
|
6
6
|
- editframe.config.*
|
|
@@ -20,8 +20,8 @@ devServer:
|
|
|
20
20
|
artifacts:
|
|
21
21
|
- id: composition
|
|
22
22
|
extensions:
|
|
23
|
-
- .html
|
|
24
23
|
- .tsx
|
|
24
|
+
- .html
|
|
25
25
|
produce:
|
|
26
26
|
command: editframe render
|
|
27
27
|
output: dist/{composition}.mp4
|
|
@@ -30,6 +30,7 @@ artifacts:
|
|
|
30
30
|
determinism:
|
|
31
31
|
hashable: true
|
|
32
32
|
inputs:
|
|
33
|
+
- compositions/**/*.tsx
|
|
33
34
|
- compositions/**/*.html
|
|
34
35
|
- assets/**
|
|
35
36
|
assets:
|
|
@@ -48,38 +49,118 @@ release:
|
|
|
48
49
|
target: local
|
|
49
50
|
outputDir: release
|
|
50
51
|
manifestName: release-manifest.json
|
|
52
|
+
prerequisites:
|
|
53
|
+
- id: nodejs
|
|
54
|
+
name: Node.js 18+
|
|
55
|
+
check: node --version
|
|
56
|
+
installHint: "https://nodejs.org/en/download/"
|
|
57
|
+
severity: error
|
|
58
|
+
- id: ffmpeg
|
|
59
|
+
name: FFmpeg
|
|
60
|
+
check: ffmpeg -version
|
|
61
|
+
installHint: "https://ffmpeg.org/download.html"
|
|
62
|
+
severity: error
|
|
51
63
|
workspaceTypes:
|
|
52
64
|
- id: composition
|
|
65
|
+
detect:
|
|
66
|
+
glob: "*.tsx"
|
|
67
|
+
contains: TimelineRoot
|
|
68
|
+
packageJsonDep: "@editframe/react"
|
|
69
|
+
skills:
|
|
70
|
+
- ef-onboard
|
|
71
|
+
- ef-composition-review
|
|
72
|
+
- ef-render-verify
|
|
73
|
+
agentsMdTemplate: editframe-templates/composition-agents.md
|
|
74
|
+
- id: html-composition
|
|
53
75
|
detect:
|
|
54
76
|
glob: "*.html"
|
|
55
77
|
contains: ef-timegroup
|
|
56
78
|
packageJsonDep: "@editframe/cli"
|
|
57
79
|
skills:
|
|
80
|
+
- ef-onboard
|
|
58
81
|
- ef-composition-review
|
|
59
82
|
- ef-render-verify
|
|
60
|
-
agentsMdTemplate: editframe-html-
|
|
83
|
+
agentsMdTemplate: editframe-templates/html-composition-agents.md
|
|
61
84
|
invariants:
|
|
62
85
|
- id: VIDEO-01
|
|
63
86
|
rule: Composition filenames must use kebab-case (lowercase letters, digits, hyphens only)
|
|
64
87
|
severity: error
|
|
65
88
|
check:
|
|
66
89
|
kind: filename-pattern
|
|
67
|
-
glob: "compositions/**/*.{html
|
|
68
|
-
pattern: "^[a-z0-9-]+\\.(html
|
|
90
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
91
|
+
pattern: "^[a-z0-9-]+\\.(tsx|html)$"
|
|
69
92
|
- id: VIDEO-02
|
|
70
93
|
rule: Scene durations must use contain mode by default to avoid unexpected cropping
|
|
71
94
|
severity: warning
|
|
72
95
|
check:
|
|
73
96
|
kind: file-contains
|
|
74
|
-
glob: "compositions/**/*.html"
|
|
97
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
75
98
|
pattern: contain
|
|
76
99
|
- id: VIDEO-03
|
|
77
|
-
rule: All speech audio elements must have corresponding
|
|
100
|
+
rule: All speech audio elements must have corresponding Captions components for accessibility
|
|
101
|
+
severity: error
|
|
102
|
+
check:
|
|
103
|
+
kind: file-contains
|
|
104
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
105
|
+
pattern: Captions
|
|
106
|
+
- id: VIDEO-04
|
|
107
|
+
rule: Root Timegroup must declare duration or use mode="contain" or mode="fit"
|
|
78
108
|
severity: error
|
|
79
109
|
check:
|
|
80
110
|
kind: file-contains
|
|
81
|
-
glob: "compositions/**/*.html"
|
|
82
|
-
pattern: ef-
|
|
111
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
112
|
+
pattern: 'Timegroup[^>]*(duration|mode="contain"|mode="fit")[^>]*>|ef-timegroup[^>]*(duration|mode="contain"|mode="fit")[^>]*>'
|
|
113
|
+
- id: VIDEO-05
|
|
114
|
+
rule: All duration values must be valid CSS time strings (e.g. 5s, 500ms, 2.5s)
|
|
115
|
+
severity: error
|
|
116
|
+
check:
|
|
117
|
+
kind: attribute-pattern
|
|
118
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
119
|
+
elements:
|
|
120
|
+
- ef-timegroup
|
|
121
|
+
- Timegroup
|
|
122
|
+
attribute: "duration"
|
|
123
|
+
pattern: "^\\d+(\\.\\d+)?(s|ms)$"
|
|
124
|
+
- id: VIDEO-06
|
|
125
|
+
rule: "mode attribute must be one of: sequence, fixed, contain, fit"
|
|
126
|
+
severity: error
|
|
127
|
+
check:
|
|
128
|
+
kind: attribute-pattern
|
|
129
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
130
|
+
elements:
|
|
131
|
+
- ef-timegroup
|
|
132
|
+
- Timegroup
|
|
133
|
+
attribute: "mode"
|
|
134
|
+
pattern: "^(sequence|fixed|contain|fit)$"
|
|
135
|
+
- id: VIDEO-07
|
|
136
|
+
rule: fps must be a positive integer (default 30)
|
|
137
|
+
severity: warning
|
|
138
|
+
check:
|
|
139
|
+
kind: attribute-pattern
|
|
140
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
141
|
+
elements:
|
|
142
|
+
- ef-timegroup
|
|
143
|
+
- Timegroup
|
|
144
|
+
attribute: "fps"
|
|
145
|
+
pattern: "^[1-9]\\d*$"
|
|
146
|
+
- id: VIDEO-08
|
|
147
|
+
rule: loop attribute should only be used on the root Timegroup (no effect on render for nested groups)
|
|
148
|
+
severity: warning
|
|
149
|
+
check:
|
|
150
|
+
kind: file-not-contains
|
|
151
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
152
|
+
negatedPattern: "<(Timegroup|ef-timegroup)[^>]*loop[^>]*>[\\s\\S]*<(Timegroup|ef-timegroup)[^>]*loop"
|
|
153
|
+
- id: VIDEO-09
|
|
154
|
+
rule: offset values must be valid CSS time strings (e.g. 0.5s, 3s, 500ms)
|
|
155
|
+
severity: warning
|
|
156
|
+
check:
|
|
157
|
+
kind: attribute-pattern
|
|
158
|
+
glob: "compositions/**/*.{tsx,html}"
|
|
159
|
+
elements:
|
|
160
|
+
- ef-timegroup
|
|
161
|
+
- Timegroup
|
|
162
|
+
attribute: "offset"
|
|
163
|
+
pattern: "^\\d+(\\.\\d+)?(s|ms)$"
|
|
83
164
|
workspace:
|
|
84
165
|
dirs:
|
|
85
166
|
- compositions
|
|
@@ -280,34 +361,118 @@ firstWorkspace:
|
|
|
280
361
|
"check": "editframe check"
|
|
281
362
|
}
|
|
282
363
|
}
|
|
283
|
-
- path: composition.
|
|
364
|
+
- path: composition.tsx
|
|
284
365
|
content: |
|
|
285
|
-
|
|
286
|
-
Editframe
|
|
287
|
-
This file declares a video composition using
|
|
366
|
+
/*
|
|
367
|
+
Editframe React composition — my-first-video
|
|
368
|
+
This file declares a video composition using @editframe/react components.
|
|
288
369
|
Run `editframe preview` to preview, `editframe render` to produce output.
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
370
|
+
*/
|
|
371
|
+
import { TimelineRoot, Timegroup, Video, Text, Audio, Captions } from "@editframe/react";
|
|
372
|
+
|
|
373
|
+
export default function Composition() {
|
|
374
|
+
return (
|
|
375
|
+
<TimelineRoot>
|
|
376
|
+
<Timegroup duration="10s">
|
|
377
|
+
<Video src="assets/background.mp4" fit="contain" duration="10s" />
|
|
378
|
+
<Text
|
|
379
|
+
text="Hello, Editframe!"
|
|
380
|
+
x="50%"
|
|
381
|
+
y="50%"
|
|
382
|
+
fontSize="48px"
|
|
383
|
+
color="white"
|
|
384
|
+
textAlign="center"
|
|
385
|
+
duration="5s"
|
|
386
|
+
/>
|
|
387
|
+
<Audio src="assets/narration.mp3" />
|
|
388
|
+
<Captions src="assets/captions.vtt" />
|
|
389
|
+
</Timegroup>
|
|
390
|
+
</TimelineRoot>
|
|
391
|
+
);
|
|
392
|
+
}
|
|
312
393
|
install:
|
|
313
|
-
- pnpm add -D vitest
|
|
394
|
+
- pnpm add -D @editframe/react @editframe/vite-plugin react react-dom typescript @types/react @types/react-dom vite @vitejs/plugin-react tailwindcss @tailwindcss/vite vitest
|
|
395
|
+
templates:
|
|
396
|
+
- id: react
|
|
397
|
+
default: true
|
|
398
|
+
firstWorkspace:
|
|
399
|
+
path: compositions/my-first-video
|
|
400
|
+
files:
|
|
401
|
+
- path: package.json
|
|
402
|
+
content: |
|
|
403
|
+
{
|
|
404
|
+
"name": "my-first-video",
|
|
405
|
+
"version": "0.1.0",
|
|
406
|
+
"private": true,
|
|
407
|
+
"type": "module",
|
|
408
|
+
"scripts": {
|
|
409
|
+
"preview": "editframe preview",
|
|
410
|
+
"render": "editframe render -o dist/my-first-video.mp4",
|
|
411
|
+
"check": "editframe check"
|
|
412
|
+
}
|
|
413
|
+
}
|
|
414
|
+
- path: composition.tsx
|
|
415
|
+
content: |
|
|
416
|
+
/*
|
|
417
|
+
Editframe React composition — my-first-video
|
|
418
|
+
This file declares a video composition using @editframe/react components.
|
|
419
|
+
Run `editframe preview` to preview, `editframe render` to produce output.
|
|
420
|
+
*/
|
|
421
|
+
import { TimelineRoot, Timegroup, Video, Text, Audio, Captions } from "@editframe/react";
|
|
422
|
+
|
|
423
|
+
export default function Composition() {
|
|
424
|
+
return (
|
|
425
|
+
<TimelineRoot>
|
|
426
|
+
<Timegroup duration="10s">
|
|
427
|
+
<Video src="assets/background.mp4" fit="contain" duration="10s" />
|
|
428
|
+
<Text
|
|
429
|
+
text="Hello, Editframe!"
|
|
430
|
+
x="50%"
|
|
431
|
+
y="50%"
|
|
432
|
+
fontSize="48px"
|
|
433
|
+
color="white"
|
|
434
|
+
textAlign="center"
|
|
435
|
+
duration="5s"
|
|
436
|
+
/>
|
|
437
|
+
<Audio src="assets/narration.mp3" />
|
|
438
|
+
<Captions src="assets/captions.vtt" />
|
|
439
|
+
</Timegroup>
|
|
440
|
+
</TimelineRoot>
|
|
441
|
+
);
|
|
442
|
+
}
|
|
443
|
+
install:
|
|
444
|
+
- pnpm add -D @editframe/react @editframe/vite-plugin react react-dom typescript @types/react @types/react-dom vite @vitejs/plugin-react tailwindcss @tailwindcss/vite vitest
|
|
445
|
+
- id: html
|
|
446
|
+
firstWorkspace:
|
|
447
|
+
path: compositions/my-first-video
|
|
448
|
+
files:
|
|
449
|
+
- path: package.json
|
|
450
|
+
content: |
|
|
451
|
+
{
|
|
452
|
+
"name": "my-first-video",
|
|
453
|
+
"version": "0.1.0",
|
|
454
|
+
"private": true,
|
|
455
|
+
"type": "module",
|
|
456
|
+
"scripts": {
|
|
457
|
+
"preview": "editframe preview",
|
|
458
|
+
"render": "editframe render -o dist/my-first-video.mp4",
|
|
459
|
+
"check": "editframe check"
|
|
460
|
+
}
|
|
461
|
+
}
|
|
462
|
+
- path: index.html
|
|
463
|
+
content: |
|
|
464
|
+
<!--
|
|
465
|
+
Editframe HTML composition — my-first-video
|
|
466
|
+
This file declares a video composition using Editframe web components.
|
|
467
|
+
Run `editframe preview` to preview, `editframe render` to produce output.
|
|
468
|
+
-->
|
|
469
|
+
<ef-timeline duration="10s">
|
|
470
|
+
<ef-timegroup duration="10s" mode="contain">
|
|
471
|
+
<ef-video src="assets/background.mp4" fit="contain" duration="10s"></ef-video>
|
|
472
|
+
<ef-text text="Hello, Editframe!" x="50%" y="50%" font-size="48px" color="white" text-align="center" duration="5s"></ef-text>
|
|
473
|
+
<ef-audio src="assets/narration.mp3"></ef-audio>
|
|
474
|
+
<ef-captions src="assets/captions.vtt"></ef-captions>
|
|
475
|
+
</ef-timegroup>
|
|
476
|
+
</ef-timeline>
|
|
477
|
+
install:
|
|
478
|
+
- pnpm add -D vitest
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ef-brand-video-generator
|
|
3
|
+
description: "Generate brand video compositions from templates — logo animation, intro/outro, brand colors, typography. Use when the operator asks to generate a brand video."
|
|
4
|
+
invocation: user
|
|
5
|
+
category: fo
|
|
6
|
+
concerns: content-mutation
|
|
7
|
+
dependsOn: []
|
|
8
|
+
languagePolicy: ref(PREFERENCES.md)
|
|
9
|
+
triggers:
|
|
10
|
+
- "generate a brand video"
|
|
11
|
+
- "create a logo animation"
|
|
12
|
+
- "brand intro video"
|
|
13
|
+
- "brand outro video"
|
|
14
|
+
source: domain-knowledge
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
<!-- skill-lint-disable SKILL-17 -->
|
|
18
|
+
|
|
19
|
+
Before starting, read `PREFERENCES.md` at the repository root. If the file is missing or `aiLanguage` is unset, ask the operator once and create the file using the `my-preferences` skill semantics.
|
|
20
|
+
|
|
21
|
+
# Brand Video Generator
|
|
22
|
+
|
|
23
|
+
Generate brand video compositions from reusable templates. Brand videos typically include logo animations, intro/outro sequences, brand color overlays, and typography that matches brand guidelines.
|
|
24
|
+
|
|
25
|
+
## Template structure
|
|
26
|
+
|
|
27
|
+
A brand video composition uses `@editframe/react` components with brand-specific assets:
|
|
28
|
+
|
|
29
|
+
```tsx
|
|
30
|
+
import { TimelineRoot, Timegroup, Video, Image, Text } from "@editframe/react";
|
|
31
|
+
|
|
32
|
+
export default function BrandIntro() {
|
|
33
|
+
return (
|
|
34
|
+
<TimelineRoot>
|
|
35
|
+
<Timegroup duration="3s" mode="sequence">
|
|
36
|
+
<Image src="assets/logo.svg" duration="1s" fit="contain" />
|
|
37
|
+
<Text
|
|
38
|
+
text="Your Brand"
|
|
39
|
+
x="50%"
|
|
40
|
+
y="50%"
|
|
41
|
+
fontSize="64px"
|
|
42
|
+
color="#FF6B00"
|
|
43
|
+
duration="1s"
|
|
44
|
+
/>
|
|
45
|
+
<Video src="assets/brand-bg.mp4" fit="cover" duration="1s" />
|
|
46
|
+
</Timegroup>
|
|
47
|
+
</TimelineRoot>
|
|
48
|
+
);
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Brand asset checklist
|
|
53
|
+
|
|
54
|
+
- **Logo** — SVG or PNG with transparent background
|
|
55
|
+
- **Brand colors** — primary, secondary, accent as CSS color values
|
|
56
|
+
- **Typography** — brand font family, weights, sizes
|
|
57
|
+
- **Background video** — optional branded background clip
|
|
58
|
+
- **Audio** — optional brand jingle or voiceover
|
|
59
|
+
|
|
60
|
+
## Common brand video patterns
|
|
61
|
+
|
|
62
|
+
### Logo animation
|
|
63
|
+
|
|
64
|
+
Animate the logo in with a `Timegroup` using `mode="sequence"`:
|
|
65
|
+
|
|
66
|
+
```tsx
|
|
67
|
+
<Timegroup duration="2s" mode="sequence">
|
|
68
|
+
<Image src="assets/logo.svg" duration="0.5s" fit="contain" />
|
|
69
|
+
<Text text="Your Brand" fontSize="48px" color="#FF6B00" duration="1.5s" />
|
|
70
|
+
</Timegroup>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Intro/outro pair
|
|
74
|
+
|
|
75
|
+
Create separate compositions for intro and outro, then combine them in a parent `Timegroup`:
|
|
76
|
+
|
|
77
|
+
```tsx
|
|
78
|
+
<TimelineRoot>
|
|
79
|
+
<Timegroup duration="15s" mode="sequence">
|
|
80
|
+
<BrandIntro />
|
|
81
|
+
<MainContent />
|
|
82
|
+
<BrandOutro />
|
|
83
|
+
</Timegroup>
|
|
84
|
+
</TimelineRoot>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Brand color overlay
|
|
88
|
+
|
|
89
|
+
Use a semi-transparent `Image` or `Text` overlay with brand colors:
|
|
90
|
+
|
|
91
|
+
```tsx
|
|
92
|
+
<Image src="assets/brand-overlay.png" duration="10s" fit="cover" />
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Rendering
|
|
96
|
+
|
|
97
|
+
Run `ref(forge.yaml bindings.commands.build)` to render the brand video. Use `ref(forge.yaml bindings.commands.validate)` to check the composition before rendering.
|
|
98
|
+
|
|
99
|
+
## Customization
|
|
100
|
+
|
|
101
|
+
Each brand video template accepts parameters for logo, colors, text, and timing. Adjust the `duration`, `mode`, and asset paths to match the brand guidelines.
|