Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ jobs:
- uses: actions/setup-node@v4
with: { node-version: "20" }
- name: Python syntax
run: python -m py_compile kit/*.py
run: python -m py_compile kit/*.py reference/src/*.py
- name: JavaScript syntax
run: |
node --check kit/render.js
# scene files are ES modules; parse them as .mjs so --check does not
# treat `import` as a CommonJS syntax error
for f in $(ls kit/lib/*.js films/*/scene.js templates/scene.js 2>/dev/null); do
for f in $(ls kit/lib/*.js films/*/scene.js templates/scene.js reference/src/scene.js 2>/dev/null); do
cp "$f" /tmp/check.mjs
node --check /tmp/check.mjs
echo "ok $f"
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ __pycache__/
*.pyc
.DS_Store
.cache/
frames/
voice/
reference/frames/
reference/voice/
reference/audio/
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,25 @@ integrated loudness -14.2 LUFS · true peak -1.6 dBTP

`make test` builds a three-line film end to end in about two minutes and asserts fourteen things about the result. See [`docs/qa.md`](docs/qa.md).

## Two worked examples

| Folder | Engine | Timing source | Film |
|---|---|---|---|
| `films/everest` | three.js | Piper line alignments | The Mountain Nobody Saw, 36.6 s |
| `films/kuch-bhi-kaise-bechein` | three.js | Piper line alignments | the Hindi shop explainer, 85 s |
| `reference/` | Babylon.js | edge-tts word boundaries | Slow as Molasses, 56.6 s |

`reference/` sits outside `kit/` on purpose. It is the same script-to-frames contract
with a second renderer and a second timing source — word-level rather than line-level —
and it has its own build steps in [`reference/README.md`](reference/README.md).

## Layout

```
kit/ voice, music, mix, render, encode, qa, doctor, build, make
kit/lib/ three.js, loaders, scene-kit, OutlineEffect, Devanagari font, rigged avatar
films/ one directory per film: film.json and scene.js (built on scene-kit)
reference/ a second worked example: Babylon.js, word-level timing
templates/ starter film.json, scene.js and index.html
docs/ format reference, scene-kit, styles, safe areas, speed, portability, qa
assets/ logo and banner
Expand Down
Loading