diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6871fd7..db30607 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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" diff --git a/.gitignore b/.gitignore index fedcd20..acea6e0 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,8 @@ __pycache__/ *.pyc .DS_Store .cache/ +frames/ +voice/ +reference/frames/ +reference/voice/ +reference/audio/ diff --git a/README.md b/README.md index bc5582a..b51069c 100644 --- a/README.md +++ b/README.md @@ -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