cozyclay 1.3.0 → 1.6.0

package/LICENSING.md

@@ -0,0 +1,32 @@
+# CozyClay licensing
+
+CozyClay is distributed as a combined work under the GNU Affero General
+Public License, version 3 or later (`AGPL-3.0-or-later`). The complete license
+text is in [`LICENSE`](LICENSE).
+
+If you modify CozyClay and let users interact with that modified version over
+a network, section 13 of the AGPL requires you to offer those users the
+Corresponding Source of the version you run, at no charge. CozyClay keeps that
+offer visible in the Studio footer as **Source code (AGPL)**.
+
+The official build points that link at this repository. Operators deploying a
+modified version must set `VITE_SOURCE_CODE_URL` at build time to a public URL
+containing the complete Corresponding Source for the version they run.
+
+## Earlier contributions
+
+Before 2026-08-21, CozyClay was published under `GPL-3.0-or-later`. Copyright
+in those contributions remains with its respective holders and those portions
+remain available under that license; its text is preserved at
+[`LICENSES/GPL-3.0-or-later.txt`](LICENSES/GPL-3.0-or-later.txt). Section 13 of
+AGPLv3 expressly permits GPLv3 and AGPLv3 code to be combined, with the AGPL
+network-source requirement applying to the combined program.
+
+Contributions submitted on or after 2026-08-21 are accepted under
+`AGPL-3.0-or-later` unless a file clearly says otherwise.
+
+## Third-party material
+
+The AGPL does not replace the licenses of dependencies, fonts, models, model
+weights, or other third-party material. See
+[`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md) for their separate terms.

package/README.md

@@ -7,10 +7,14 @@
 </p>
 
 <p align="center">
-  <a href="LICENSE"><img alt="License: GPL-3.0" src="https://img.shields.io/badge/license-GPL--3.0-blue"></a>
+  Created and maintained by <a href="https://github.com/HaD0Yun">Doyun</a> at <a href="https://github.com/NomaDamas">NomaDamas</a>.
+</p>
+
+<p align="center">
+  <a href="LICENSE"><img alt="License: AGPL-3.0" src="https://img.shields.io/badge/license-AGPL--3.0-blue"></a>
   <a href="https://www.npmjs.com/package/cozyclay"><img alt="npm" src="https://img.shields.io/npm/v/cozyclay"></a>
   <img alt="Node 22+" src="https://img.shields.io/badge/node-22%2B-brightgreen">
-  <a href="https://github.com/HaD0Yun/CozyClay/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/HaD0Yun/CozyClay?style=flat"></a>
+  <a href="https://github.com/NomaDamas/CozyClay/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/NomaDamas/CozyClay?style=flat"></a>
 </p>
 
 <p align="center">
@@ -19,7 +23,7 @@
   <a href="#what-you-can-do">Features</a> ·
   <a href="#ai-control-mcp">AI control</a> ·
   <a href="#controls">Controls</a> ·
-  <a href="https://github.com/HaD0Yun/CozyClay/issues">Issues</a>
+  <a href="https://github.com/NomaDamas/CozyClay/issues">Issues</a>
 </p>
 
 ---
@@ -51,7 +55,7 @@ https://github.com/user-attachments/assets/1d0113e5-6922-443d-affc-1bdabc666247
 - Node.js 22 or newer
 - npm, or bun
 - A Chromium-based browser
-- *Optional:* an SSH-accessible NVIDIA machine running ARDY, for motion generation
+- *Optional:* an SSH-accessible NVIDIA machine running ARDY, for motion generation — first-time setup downloads a ~16.4 GB text-encoder stack onto that machine; see [`tools/ardy/README.md`](tools/ardy/README.md)
 
 ## Quick start
 
@@ -63,6 +67,8 @@ bunx cozyclay
 
 That downloads the built studio and opens it at `http://127.0.0.1:5180`. Nothing to compile, no dependency tree to install. Useful flags: `--port 5200`, `--no-open`, `--no-ardy`.
 
+A global install gives you `cclay`, the same command with less typing. Once a day the launcher checks npm for a newer release and prints a one-line notice after the studio is up; it stays quiet when you're current or offline. `cclay update` installs the latest release, and `--no-update-check` skips the check entirely.
+
 Motion generation stays off until you point it at a machine that can run it:
 
 ```bash
@@ -90,18 +96,21 @@ The studio ships an [MCP](https://modelcontextprotocol.io) server, so an AI assi
 ```
 
 Drop that into `claude_desktop_config.json` (or any MCP client config) and restart the client. The
-first run prints one `npm install` line: the MCP SDK is a 95-package tree, and opening the studio
-should never wait on it, so those dependencies are fetched only when you actually want the server.
+first run automatically installs the MCP SDK's 95-package tree; opening the studio never waits on
+it, so those dependencies are fetched only when you actually want the server.
 
 - **Editor open?** Tool calls move the visible viewport — camera, cast, set, generated motion, prompt blocks on the timeline.
-- **No editor?** The same tools run headless: block scenes, derive film vocabulary (“wide shot · right profile · knee level · 24mm”), render AI video prompts, and write `.cclayproject` files the studio opens.
+- **No editor?** Scene and project tools run headless: block scenes, derive film vocabulary
+  (“wide shot · right profile · knee level · 24mm”), render AI video prompts, and write
+  `.cclayproject` files. `capture_frame`, `set_prompt_blocks`, `generate_motion`, and
+  `apply_batch` require the live editor.
 
 Tools, transports and the live-control protocol are documented in [`mcp/README.md`](mcp/README.md).
 
 ### From a clone
 
 ```bash
-git clone https://github.com/HaD0Yun/CozyClay.git
+git clone https://github.com/NomaDamas/CozyClay.git
 cd CozyClay
 npm install
 npm run dev
@@ -152,8 +161,8 @@ See [`tools/ardy/README.md`](tools/ardy/README.md) for details. This workflow is
 | `npm run test:theme` / `test:appearance` / `test:layout` | UI theme, appearance, layout |
 | `npm run test:lifecycle` | Dev-server process lifecycle |
 | `npm run test:ardy` | ARDY conversion, playback, and IK pipeline |
-| `cd mcp && npm run verify` | MCP server over real stdio — all 420 framing combinations |
-| `cd mcp && npm run verify:live` | Live-control protocol against a fake editor |
+| `cd mcp && npm install && npm run verify` | MCP server over real stdio — all 420 framing combinations |
+| `cd mcp && npm run verify:live` | Live-control protocol against a fake editor (same `npm install` first) |
 | `npm run build` | Production build |
 
 Ad-hoc browser QA, while a dev server is available:
@@ -164,12 +173,60 @@ npm run qa:browser -- <qa-script>
 
 ## Contributing
 
-Found something broken, or want a feature? [Open an issue](https://github.com/HaD0Yun/CozyClay/issues) — bug reports with a repro are the most useful thing you can send.
+Found something broken, or want a feature? [Open an issue](https://github.com/NomaDamas/CozyClay/issues) — bug reports with a repro are the most useful thing you can send. Contributions are accepted under `AGPL-3.0-or-later`.
 
 **Repository hygiene.** Generated motion archives, QA output, build output, logs and local runtime artifacts are not source files and must not be committed. Keep `tools/ardy/out/`, `artifacts/`, `dist/`, `.gjc/` and `.npz` files local.
 
+All runtime libraries intentionally live in `devDependencies` because the published npm package ships the prebuilt `dist/`, so `npx cozyclay` must not install the studio's dependency tree.
+
+## Analytics & privacy
+
+The hosted site at [cozyclay.org](https://cozyclay.org/) collects anonymous usage analytics via [PostHog](https://posthog.com/) (US Cloud). There are no cookies and no session recording, and Do-Not-Track is respected. A random pseudonymous identifier is kept in your browser's localStorage so that returning visits and retention can be counted; it is never linked to an account or project content and is removed by clearing site data or using the opt-out toggle.
+
+Events collected:
+
+| Event | Purpose |
+| --- | --- |
+| `install:first_launch` | First run of the official npm package |
+| `app:session_started` | Start of an official npm package session |
+| `$pageview` | Funnel and drop-off analysis |
+| `scene:created` | Funnel and drop-off analysis |
+| `scene:loaded` | Funnel and drop-off analysis |
+| `craft:first_action` | Funnel and drop-off analysis |
+| `motion:job_started` | Motion reliability |
+| `motion:job_succeeded` | Motion reliability |
+| `motion:job_failed` | Motion reliability |
+| `export:blocking_frame_succeeded` | Funnel and drop-off analysis |
+| `activation:completed` | Funnel and drop-off analysis |
+
+Geo data comes from ingest-time GeoIP country lookup only — no precise location is collected. Prompt text, asset names, file names, project content, local paths, and any user-entered text are never collected.
+
+The official npm package also measures anonymous first launches, sessions, and
+the same in-app funnel on its `127.0.0.1` studio. It stores one random
+installation identifier in `~/.config/cozyclay/state.json` so returning use can
+be counted across ports and browser storage resets. Source checkouts, forks,
+development servers, CI, and tests do not send analytics. Official npm
+artifacts carry a signature checked by the launcher, so copying or repackaging
+the source does not enable telemetry.
+
+The npm package prints this disclosure once on first launch. Control it at any
+time:
+
+```bash
+cclay telemetry status
+cclay telemetry off
+cclay telemetry on
+```
+
+`COZYCLAY_TELEMETRY=0` and `DO_NOT_TRACK=1` disable collection for a launch.
+The in-app topbar toggle changes the same npm-package setting and removes its
+anonymous installation identifier. Hosted-site visitors can opt out with that
+toggle, browser Do-Not-Track, or a content blocker.
+
+PostHog's free plan retains events for 1 year.
+
 ## License & credits
 
-GNU General Public License v3.0 or later — see [`LICENSE`](LICENSE). Third-party projects retain their own licenses and copyright; see [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
+GNU Affero General Public License v3.0 or later — see [`LICENSE`](LICENSE) and the transition details in [`LICENSING.md`](LICENSING.md). Modified network services must offer their users the corresponding source. Third-party projects retain their own licenses and copyright; see [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
 
 CozyClay can connect to [NVIDIA ARDY](https://github.com/nv-tlabs/ardy) for motion generation. ARDY is a separate third-party project owned and maintained by NVIDIA; it is not included in this repository, and CozyClay is not affiliated with or endorsed by NVIDIA.

package/THIRD_PARTY_NOTICES.md

@@ -11,6 +11,16 @@ CozyClay's browser-based 3D studio uses [Three.js](https://threejs.org/) through
 - Source: https://github.com/mrdoob/three.js
 - License text: https://github.com/mrdoob/three.js/blob/dev/LICENSE
 
+## Mediabunny
+
+CozyClay uses [Mediabunny](https://mediabunny.dev/) to mux recorded WebCodecs
+video frames into MP4 files in the browser.
+
+- Copyright (c) 2024-2026 Vanilagy
+- License: MPL-2.0
+- Source: https://github.com/Vanilagy/mediabunny
+- License text: https://github.com/Vanilagy/mediabunny/blob/main/LICENSE
+
 ## NVIDIA ARDY
 
 CozyClay provides an optional bridge and data-conversion workflow for externally installed [ARDY](https://github.com/nv-tlabs/ardy), an interactive human-motion generation project from NVIDIA Research.
@@ -81,7 +91,7 @@ in `public/fonts/` next to the fonts themselves.
 The rigs in `public/models/` are Mixamo characters from Adobe. Adobe permits
 their use in projects but not the distribution of the raw character files, which
 is what shipping them in this repository, the npm package and the hosted site
-amounts to. They are also outside the scope of this repository's GPL-3.0 grant:
+amounts to. They are also outside the scope of this repository's AGPL-3.0 grant:
 nothing here relicenses them, and a fork does not acquire the right to
 redistribute them.
 
@@ -91,6 +101,14 @@ as third-party content that this licence does not cover.
 - `x-bot-tpose.fbx`, `y-bot-tpose.fbx` — Adobe Mixamo
 - Terms: https://www.adobe.com/legal/terms.html
 
+## posthog-js
+
+The hosted site at cozyclay.org uses [posthog-js](https://posthog.com/docs/libraries/js) for anonymous usage analytics.
+
+- Copyright PostHog Inc.
+- License: Apache-2.0 AND MIT
+- Source: https://github.com/PostHog/posthog-js
+
 ## CozyClay license scope
 
-The CozyClay source code in this repository is licensed under GPL-3.0-or-later. That license does not replace or relicense Three.js, ARDY, ARDY model checkpoints, the bundled fonts, the character rigs, or any other third-party component.
+The CozyClay combined work in this repository is distributed under AGPL-3.0-or-later, subject to the transition details in `LICENSING.md`. That license does not replace or relicense Three.js, ARDY, ARDY model checkpoints, the bundled fonts, the character rigs, or any other third-party component.