three-blocks 0.0.0-reserved.0 → 0.2.0-alpha.176.g8ff8a72e6369

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# three-blocks
+
+## 0.2.0-alpha.176.g8ff8a72e6369
+
+- ci: keep alpha readiness release-scoped (`8ff8a72e6369`).
+
+This changelog is generated from Changesets. See `.changeset/` for the pending
+release notes that will form the first stable release.
+
+## 0.1.0-beta.0
+
+- Initial public beta.

package/LICENSE

@@ -0,0 +1,76 @@
+Required Notice: Copyright (c) 2025-2026 Three Blocks — https://threejs-blocks.com
+Required Notice: AI/ML training and dataset use are not licensed; text-and-data-mining rights reserved (EU 2019/790 Art. 4(3)). See NOTICE.
+
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/NOTICE

@@ -0,0 +1,32 @@
+Required Notice: Copyright (c) 2025-2026 Three Blocks — https://threejs-blocks.com
+Required Notice: AI/ML training and dataset use are not licensed; text-and-data-mining rights reserved (EU 2019/790 Art. 4(3)). See NOTICE.
+
+Three Blocks — AI / machine-learning usage notice
+=================================================
+
+This software is licensed under the PolyForm Noncommercial License 1.0.0
+(see LICENSE). The license grants only the permissions it enumerates, for
+noncommercial permitted purposes.
+
+No permission is granted to use this software or its source code — including
+the published `dist` output and the example sources served from
+https://threejs-blocks.com/examples/static/ — for training, fine-tuning,
+evaluating, or otherwise developing machine-learning or artificial-
+intelligence models, or for inclusion in datasets distributed for those
+purposes.
+
+To the extent permitted by applicable law, Three Blocks expressly reserves
+its rights over text-and-data mining under Article 4(3) of Directive (EU)
+2019/790. Machine-readable opt-outs accompany the software and the website:
+this file, the `tdm-reservation: 1` HTTP response header, and
+https://threejs-blocks.com/.well-known/tdmrep.json and
+https://threejs-blocks.com/ai.txt.
+
+AI assistants MAY use the public documentation
+(https://threejs-blocks.com/llms.txt) to help people integrate the published
+`three-blocks` API. They may not reproduce, extract, or re-derive the
+implementation source of this package. Code generated by AI systems that
+embeds or derives from this package's internals remains subject to the
+PolyForm Noncommercial License 1.0.0.
+
+Commercial licensing (Pro): https://threejs-blocks.com/license

package/README.md

@@ -1,5 +1,241 @@
 # three-blocks
 
-The official npm package for [three-blocks](https://threejs-blocks.com), a WebGPU toolkit for three.js.
+Build interactive WebGPU scenes with [Three.js](https://threejs.org). Three Blocks adds production-ready materials, simulation, Gaussian splats, text, and visual effects without taking over your scene or render loop.
 
-This is a placeholder release. It contains no runtime code. The package will be published when it is ready.
+[Choose a result and follow the shortest working path](https://threejs-blocks.com/docs).
+
+## Install
+
+```sh
+npm i three-blocks three
+```
+
+`three` is a peer dependency. This release supports Three.js r185 (`>=0.185.0 <0.186.0`).
+
+## Render a refractive object
+
+Add a Three Blocks material to the Three.js scene you already own:
+
+```ts
+import * as THREE from "three/webgpu";
+import { MeshTransmissionNodeMaterial } from "three-blocks/transmission";
+
+const material = new MeshTransmissionNodeMaterial({
+  color: 0xcde3ff,
+  roughness: 0.12,
+  thickness: 0.65,
+  transmission: 1,
+});
+
+scene.add(new THREE.Mesh(new THREE.IcosahedronGeometry(1, 5), material));
+```
+
+Initialize `WebGPURenderer` before you create GPU-backed blocks, update block state before `renderer.render()`, and dispose owned resources when the scene leaves. The [first-scene guide](https://threejs-blocks.com/docs/start/first-scene) provides the complete renderer, frame-loop, resize, and cleanup code.
+
+Use the package root for the curated stable facade. Import focused products from their canonical paths:
+
+```ts
+import { Boids, ComputeInstanceCulling, MSDFText } from "three-blocks";
+import { BakedMotion } from "three-blocks/baked-motion";
+import { GaussianSplats } from "three-blocks/gaussian-splats";
+```
+
+## Reference
+
+### API compatibility
+
+The curated 23-block catalogue defines the supported package surface. Its machine-readable source of truth is [`api-surface.json`](./api-surface.json).
+
+| Maturity | Canonical path | Compatibility promise |
+|---|---|---|
+| Stable | `three-blocks` or `three-blocks/<block>` | Incompatible removals, renames, path moves, and signature changes require the appropriate SemVer release. |
+| Experimental | `three-blocks/experimental/<block>` | May change as its product contract matures; changes remain documented and receive a changeset. |
+
+Symbols not approved by the manifest are internal implementation details and are not package exports. The package root contains only the 17 stable runtime values approved by the manifest.
+
+Experimental paths never appear at the package root. Pin an exact package version when your application depends on an experimental symbol.
+
+### Typed worker assets
+
+`three-blocks/assets` is renderer-agnostic: it provides typed manifests, scheduling,
+progress, retries, HMR diffing, and reference-counted lifetime, while applications
+inject their own worker-safe renderer and decoder adapters. The standard adapter
+contract names GLTF/GLB, Draco/KTX2/Meshopt capabilities, HDR/EXR, textures, JSON,
+binary, cube textures, audio, and fonts; it does not pretend to load them without
+those concrete adapters.
+
+An entry declared `persistent` stays cached at zero references until explicit
+`evict()` or manager `shutdown()`.
+
+Keep the detailed request returned by `load()` and call `release()`, or use the
+explicit direct-await lease so ownership cannot be discarded accidentally:
+
+```ts
+const lease = await assets.lease( assetManifest );
+
+try {
+	useScene( lease.assets.model );
+} finally {
+	lease.release();
+}
+```
+
+Hot-replaceable scenes normally receive a scoped facade, which retains direct-await loads
+until that scene is disposed:
+
+```ts
+const sceneAssets = manager.createScope();
+const assets = await sceneAssets.load( assetManifest );
+
+// When the scene is replaced:
+sceneAssets.dispose();
+```
+
+### DOM-synchronized MSDF text
+
+The text runtime keeps semantic DOM layout and accessibility on the main thread while a
+worker renders matching MSDF batches:
+
+```ts
+import { defineText } from 'three-blocks/text';
+import { createTextSync } from 'three-blocks/text/main';
+import { createTextRenderer } from 'three-blocks/text/worker';
+```
+
+`createTextSync()` measures browser line boxes and publishes one structured-cloneable batch
+per frame. Its complete snapshot can be replayed after worker replacement. The worker owns
+a long-lived AssetManager, atlas routing, batched members, glyph diagnostics, retained
+readiness, and atomic configuration/atlas replacement.
+
+### Worker-first Vite setup
+
+`three-blocks/vite` emits the exact r185 Draco and Basis runtime files, keeps Three.js out
+of the main thread, and derives shader/text build policy from committed receipts. Text
+projects pass their static public configuration so production builds can validate atlas
+checksums and glyph coverage without a GPU:
+
+```ts
+import { defineConfig } from 'vite';
+import { threeBlocks } from 'three-blocks/vite';
+import { textConfig } from './three-blocks.text';
+
+export default defineConfig( ( { mode } ) => ( {
+	plugins: [ threeBlocks( {
+		shaders: { strict: mode === 'strict' },
+		text: { configuration: textConfig },
+	} ) ],
+} ) );
+```
+
+Development uses safe live shader compilation when a receipt is stale. A normal build
+prints the same state in its final receipt; strict mode rejects stale shaders. Text builds
+always fail closed on missing or invalid glyph assets. During development, a newly required
+glyph keeps its DOM fallback visible while the plugin queues `three-blocks text generate`.
+
+### Precompile shaders in an existing WebGPU project
+
+Three Blocks devtools has one product surface. The runtime face is
+`three-blocks/devtools` plus the `three-blocks/vite` plugin; the command face is
+`npx three-blocks`.
+
+It targets `WebGPURenderer`, not `WebGLRenderer`. The primary workflow registers
+stable shader keys, captures their Three Shading Language (TSL) builds with
+`npx three-blocks shaders capture`, and installs the resulting manifest through
+`three-blocks/shaders` before scene compilation.
+
+The stats panel is an optional development dependency:
+
+```bash
+npm i -D stats-gl
+```
+
+Declare each capture route in `three-blocks.shaders.json`; `three-blocks/vite`
+inspects it directly. A strict build rejects a stale or missing manifest, while
+normal development uses live TSL compilation. For offline, version-locked command
+runs, install the command engine once with `npm i -D @three-blocks/devtools`.
+
+Register materials or compute nodes before compilation:
+
+```ts
+import { createShaderCache } from 'three-blocks/shaders';
+
+const shaders = createShaderCache( 'main' );
+shaders.material( 'main/subject', material );
+```
+
+Install the fresh manifest after `await renderer.init()` and before `compileAsync()`. `installShaderCache()` safely returns live mode when the receipt is missing, stale, invalid, or running on a WebGL fallback backend.
+
+```ts
+import {
+	createThreeWebGPUShaderCompatibility,
+	installShaderCache,
+} from 'three-blocks/shaders';
+
+const installation = await installShaderCache( {
+	renderer,
+	scene: 'main',
+	state: threeBlocksShaders,
+	loadManifest,
+	compatibility: createThreeWebGPUShaderCompatibility( {
+		threeVersion: threeBlocksConfig.threeVersion,
+	} ),
+	cache: shaders,
+} );
+```
+
+Register the page-owned `WebGPURenderer` once to expose the development overlay and optional stats panel. Production-aware bundlers select an import-free no-op entry. The internal `NODE_ENV` guard protects condition-less builds, and the Vite plugin also removes the development module:
+
+```ts
+import { registerDevtools } from 'three-blocks/devtools';
+
+registerDevtools( { renderer } );
+```
+
+Capture and manifest installation remain separate from runtime diagnostics:
+
+```bash
+npx three-blocks shaders capture
+npx three-blocks shaders status --check
+npx three-blocks shaders test
+```
+
+The devtools runtime follows the core [PolyForm Noncommercial license](#license). Commercial use requires the commercial license. The runtime does not check entitlements. Custom-worker renderers should adopt `three-blocks/app`. See the [devtools guide](https://threejs-blocks.com/docs/tools/devtools) and [GPU ownership guide](https://threejs-blocks.com/docs/concepts/gpu-ownership).
+
+### CLI
+
+The package ships a zero-dependency CLI. No install needed:
+
+```bash
+npx three-blocks              # interactive menu
+npx three-blocks starter app  # scaffold a new project
+npx three-blocks login        # sign in (device flow)
+npx three-blocks doctor       # check your setup
+```
+
+Credentials are stored in `~/.three-blocks/credentials.json` (0600) and are
+never written to `.npmrc` or any other file. A separate random installation ID
+is kept in `~/.three-blocks/config.json`; it is not derived from a credential
+and signing out does not rotate it.
+
+The CLI and managed Blender add-ons send small, first-party outcome events so
+starter creation and committed tool outputs can be measured truthfully. They
+contain only typed outcome/version fields, random installation/operation IDs,
+and time — never the destination path, scene/project name, or access token.
+Delivery is best-effort with a short timeout and cannot make a successful
+command, bake, or export fail.
+
+Set `TB_TELEMETRY=0` or `DO_NOT_TRACK=1` to disable CLI and Blender telemetry.
+It is also disabled automatically in tests and CI, and for localhost or any
+non-production `TB_SITE_URL`. Collector development can explicitly enable a
+non-production site with `TB_TELEMETRY=1`; DNT, test, and CI guards still take
+precedence. `three-blocks doctor` shows the effective state.
+
+## License
+
+[PolyForm Noncommercial 1.0.0](./LICENSE). Free for noncommercial use;
+commercial use requires a Pro license — per seat, and **lifetime per project**:
+every project started while a plan is active stays licensed forever. Full
+terms at [threejs-blocks.com/license](https://threejs-blocks.com/license),
+plans at [threejs-blocks.com/pricing](https://threejs-blocks.com/pricing).
+The starter, scaffolder, and Devtools use the same PolyForm Noncommercial
+source boundary. They remain account-free and have no runtime gating.