Skip to content

[codex] rewrite package README - #99

Draft
meekmachine wants to merge 20 commits into
mainfrom
codex/rewrite-readme
Draft

[codex] rewrite package README#99
meekmachine wants to merge 20 commits into
mainfrom
codex/rewrite-readme

Conversation

@meekmachine

@meekmachine meekmachine commented Apr 9, 2026

Copy link
Copy Markdown
Owner

Summary

This PR rewrites the Loom3 package README around the current runtime surface, current CharacterLoom companion links, and the latest README strategy from issues #97/#98 plus the viseme research/issues.

The core framing is now: Loom3 is a semantic Three.js character-animation runtime and profile layer, not just a morph/bone mapping helper.

What Changed

  • Rebuilt the README against current origin/main so the PR is no longer conflicting.
  • Updated public live-app language from LoomLarge/demo prose to CharacterLoom, including current tab ids such as aus, tracking, poses, gestures, and annotations.
  • Corrected the animation architecture language after [codex] Restore baked additive safety #133: baked and generated/procedural playback share a normalized control model, but are evaluated through separated passes for safer precedence.
  • Updated viseme/lip-sync docs for the shipped profile-defined runtime from Add profile-defined viseme mapping system #131/[codex] Align live viseme runtime with bindings #135: slots, bindings, id-based APIs, provider matching helpers, weighted targets, and strongest-active jaw aggregation.
  • Added current shipped APIs to the README: runtime morph authoring, clip lifecycle events, baked clip channels, profile-first config helpers, and annotation camera-angle helpers.
  • Updated README_FINDINGS.md, README_OUTLINE.md, and README_COMPARABLES.md so the strategy separates shipped work from pending issues/PRs.

Pending Work Kept Out Of Shipped Docs

The strategy notes now explicitly keep these as pending/roadmap rather than documenting them as current behavior: lip-sync sequence compilation (#141/#143), inherited first keyframes (#136/#142), base pose API (#138), dynamic clip parameter hardening (#116/#137), semantic joint-control authoring/inference (#108), external payload rehydration (#122), and Rust/Wasm runtime-core research (#146).

Validation

  • git diff --check origin/main...HEAD
  • searched README/strategy docs for stale loomlarge.web.app, tab=action-units, Open in LoomLarge, resolveProfile(, old hard-coded jaw claims, and stale mixer-world language
  • PR branch merged current origin/main; GitHub reports PR [codex] rewrite package README #99 as mergeable
  • no package tests run; docs-only PR diff against origin/main

@meekmachine
meekmachine force-pushed the codex/rewrite-readme branch from 8ce715f to cb33866 Compare April 26, 2026 00:47
@meekmachine

Copy link
Copy Markdown
Owner Author

I reviewed this draft against the May 25 README course-correction work in #97.

This PR has useful material that should be preserved, especially the stronger animation-system framing, curve/clip/snippet definitions, and combined playback examples. It is also now stale/conflicting against current main and predates several important changes: CharacterLoom links, Emotes tab naming, profile-defined viseme bindings, the profile-first config model, runtime morph authoring, annotation camera helpers, and the post-#133 baked/generated mixer-pass architecture.

Recommended integration plan is documented here: #97 (comment)

My recommendation is to mine this PR for the good prose/research, rebuild the README PR from current origin/main, then close this draft as superseded unless preserving PR #99 itself is important enough to force-update the branch.

@meekmachine

Copy link
Copy Markdown
Owner Author

PR backlog triage — REBASE_KEEP

Still wanted on the Polymer / agencySociety / host plan.

Next step: rebase onto current main, resolve conflicts, ensure CI green, then undraft (if draft) for merge.

README rewrite — rebase; supersedes closed README issue batch.

Plan: https://github.com/meekmachine/Polymer/discussions/59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant