beckhoff-xts-viewer-3d 5.3.0 → 6.0.1

package/README.md

@@ -116,8 +116,10 @@ procedurally built indoor environment, anisotropic filtering and optional
 PCF-soft shadows, all switchable through `display.*`. SSAO and bloom are
 available when the optional post-processing peers are installed.
 
-**Interaction and status.** Click selection for modules and movers, tinting the
-GLB itself rather than overlaying wireframes; drive-status blink plus
+**Interaction and status.** Click selection for modules, movers, whole tracks
+and static custom assets, tinting the GLB itself rather than overlaying
+wireframes; draggable translate / rotate / scale handles on a selected track
+or custom asset, in the same palette as the orientation gizmo; drive-status blink plus
 camera-facing warning and error icons; feed-segment (Einspeisestrang) tinting
 that wraps the seam of a closed loop; stations, areas, dimensions and info bars;
 stop-position ghost movers; and a stator heatmap driven by
@@ -227,88 +229,12 @@ afterwards.
 - [Performance](docs/PERFORMANCE.md) — the asset compression pipeline and the
   runtime budget.
 - [Releasing](docs/RELEASING.md) — the automated publish flow.
+- [Migrating to v6](MIGRATION.md) — what changed and what to do about it.
 
-## Development
+## Contributing
 
-The repo is a pnpm workspace; `pnpm-lock.yaml` is the source of truth, so
-`npm install` will not work. Install pnpm 10, then:
-
-```bash
-pnpm install
-pnpm lint
-pnpm typecheck
-pnpm test
-pnpm run test:coverage
-pnpm build
-```
-
-`pnpm dev` starts the playground at `http://127.0.0.1:5173`. It exercises every
-feature and lets you switch demos, drive movers, toggle lighting and shadows,
-compose multi-track layouts and live-edit calibration overrides.
-
-`pnpm docs:capture-screenshots` re-shoots the whole image strip on this page
-from that playground, unattended — see
-[docs/screenshots](docs/screenshots/README.md).
-
-### Asset pipeline
-
-CAD sources in `stepfiles/*.stp` are converted to runtime GLBs plus per-asset
-JSON sidecars:
-
-```bash
-pnpm assets:convert                 # STP → GLB
-pnpm assets:optimize                # meshopt compression
-pnpm assets:apply-materials         # CAD placeholder colours → real PBR materials
-pnpm assets:verify-colors           # no authored STEP colour got lost
-pnpm assets:inspect                 # refresh docs/data/glb-inspection.json
-pnpm assets:generate-sidecars       # module .meta.json origin corrections
-pnpm assets:generate-mover-sidecars
-```
-
-The CAD sources carry Autodesk Inventor placeholder colours, not product
-colours — an AT2 motor module's whole solid is styled #696969 — so
-`assets:apply-materials` maps them onto the named PBR library in
-`scripts/materialLibrary.mjs` (anodised aluminium, stainless steel, hardened
-rail steel, plastics, printed labels, LEDs). It rewrites only the GLB's JSON
-chunk, leaving geometry and the compressed binary chunk byte-identical, and is
-idempotent. See [docs/ADDING-A-MODULE.md](docs/ADDING-A-MODULE.md).
-
-The generators skip existing files so hand-tuned calibration is never
-overwritten; pass `--force` to regenerate. The release pipeline never runs them
-and reads the sidecars read-only.
-
-### Layout
-
-```text
-src/                    Library source — this is what ships
-  components/           <XtsViewer3D> and the internal scene tree
-  geometry/             Path math, ChainBuilder, normalizeXtsConfig
-  assets/               AssetManifest, AssetLoader, SidecarLoader
-  interaction/          SelectionManager
-packages/assets/        Sibling npm package: GLB-only mirror
-playground/             Vite app exercising every feature
-public/models/          GLBs and .meta.json calibration sidecars
-stepfiles/              Source CAD files (not published)
-scripts/                Asset pipeline and version-sync utilities
-docs/                   VitePress site and guides
-```
-
-### Releasing
-
-Every push to `main` runs [semantic-release](https://semantic-release.gitbook.io/),
-which derives the version from Conventional Commit messages, writes
-`CHANGELOG.md` and publishes both packages. Never run `npm version`, edit the
-changelog or publish by hand.
-
-| Prefix                                             | Bump  |
-| -------------------------------------------------- | ----- |
-| `fix:` / `perf:`                                   | patch |
-| `feat:`                                            | minor |
-| `feat!:` / `fix!:` / `BREAKING CHANGE:` footer     | major |
-| `chore:` / `docs:` / `ci:` / `refactor:` / `test:` | none  |
-
-Preview with `pnpm release:dry-run`. [Releasing](docs/RELEASING.md) covers the
-plugin chain, the calibration-safety guard and the manual fallback.
+Setup, the asset pipeline, the repository layout and the release flow are in
+[CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License