Skip to content

chore: bump @playcanvas/splat-transform to 3.10.3, playcanvas to 2.24.0 (+ 4 new flags wired) - #150

Open
CodeByKeegan wants to merge 4 commits into
devfrom
chore/bump-splat-transform-3.10.3
Open

CodeByKeegan wants to merge 4 commits into
devfrom
chore/bump-splat-transform-3.10.3

Conversation

@CodeByKeegan

@CodeByKeegan CodeByKeegan commented Nov 5, 2026 •

Copy link
Copy Markdown
Owner

Bumps @playcanvas/splat-transform 3.2.0 → 3.10.3 and playcanvas 2.21.4 → 2.24.0.

⚠️ dev is broken today on a fresh install. package.json pins ^3.2.0, so npm install resolves 3.10.3. Against that version, dev's decimate flags and the --viewer-settings path fail. Dependabot #142 is red for this reason, and #138 is red on the viewer.ts typecheck.

This PR covers everything in #98 (the 3.3.x decimate-flag rewire, kept as its own commit) and #92's LOD --filter-nan fix (cherry-picked). It supersedes #142, #138, #98, #97, #92, #91, #90, #89, #83, #82 and #81.

Fixes

  • --viewer-settings is now validated upstream (3.5.0, #318). The e2e fixture is fixed. A server preflight now returns a 400 for a missing camera or background object, a version other than absent or 2, a BOM, or invalid JSON.
  • --scratch-dir no longer has a default (3.6.0, #324). Without one, deep decimations now fail. Splat Studio now defaults a blank value to the project folder, which matches 3.3.3's behaviour. This covers convert decimate and the LOD pre-commands. Leftover .decimate-gen* spill files are hidden from the Files panel.
  • --shutter is pinned to 1. Upstream changed its default to 0.5 (3.5.0), and pinning keeps existing motion-blur renders unchanged.
  • viewer.ts: MeshInstance#mesh is now nullable and is handled. The splat budget is pinned to GSPLAT_BUDGET_LIMIT / 0, so LOD distance bands still decide what renders. The 2.23 default is a 1M-splat target budget.
  • ASCII PLY: clearer trim error text. 3.9.0 rejects ASCII PLY.

New flags wired

CLI flag UI API MCP
--webp-effort "Maximum compression (slower)" in Export (SOG/HTML) and LOD webpEffort convert / build_lod.webpEffort
--lod-chunk-min LOD "Min split (K splats)", paired with File size lodChunkMin (default 8) build_lod.lodChunkMin
--lod-file-count LOD "File size (K splats)" lodFileCount build_lod.lodFileCount
--dof-samples Render "Blur quality" (Draft 8 / Standard 32 / High 128) image.dofSamples render_image.image.dofSamples

Each has a title= tooltip naming the flag, form-state persistence, tests/e2e.mjs checks and MCP schema fields. --gpu-backend and --camera-track/--frames are deferred to issues (below).

Release-notes review

splat-transform 3.3.3 → 3.10.3

  • 3.4.0: --lod-chunk-min (default 8) means far fewer leaves for sparse, wide regions, so LOD output differs from 3.3.3 by design.
  • 3.5.0:
    • viewer-settings validation (#318).
    • --webp-effort.
    • --shutter default 0.5. We pin 1.
    • Motion blur is now accumulated in linear light on the GPU, so blurred renders look different.
  • 3.5.1: DoF is now aperture-sampled, with --dof-samples (default 32). Each sample is a full render, and the count multiplies with motion samples.
  • 3.6.0:
    • --scratch-dir has no implicit default (#324). Handled above.
    • Per-frame up vectors for camera tracks.
    • SOG encode speed restored.
  • 3.7.0: --gpu-backend (#334). Deferred to Surface --gpu-backend (vulkan/d3d12) with backend-matched device lists #144.
  • 3.8.0: --lod-errors and the LOD error metadata were removed (#339), so Surface per-leaf LOD approximation error (splat-transform 3.3.0) #80 is obsolete. The .splat writer now normalizes rotations; we don't write .splat.
  • 3.9.0:
    • --lod-file-count (#340). LOD writing is faster but uses more peak memory.
    • The PLY reader now reads big-endian and rejects ASCII (#341).
  • 3.10.x:
    • Dawn 0.6.2. GPU enumeration was checked and is unchanged on an RTX 4090.
    • zip64 .sog above 4 GiB (#352). Viewer guard in Guard zip64 .sog bundles (> 4 GiB) in the viewer #149.
    • --stats mean and stdDev are now in display space. Our parser doesn't use them.
    • Worker-pool fix.
  • Kept workarounds:
    • -N on the LOD path: the writer still aborts on non-finite input.
    • Rounding of --lod-chunk-extent.
    • The decimate pre-commands: decimate must still be the final action and write .ply.

PlayCanvas 2.21.4 → 2.23.3

  • 2.22.x: error-driven LOD was added, then made non-default. Per-splat detail falloff added. Streaming now loads splats nearest the camera first.
  • 2.23.0: error LOD removed. The default splat budget became a 1M target (pinned here). MeshInstance#mesh is typed nullable.
  • 2.23.2–2.23.3: coarsest-first streaming, plus fixes for asset swaps, destroying splat entities, GPU-sort flicker, and NVIDIA depth-pick hangs.

PlayCanvas 2.23.3 → 2.24.0 (added 2026-11-10; released 2026-11-09)

  • Gaussian splatting: streamed LOD now picks levels by walking a node hierarchy, coarsest first. Splats fall back to CPU sorting when they exceed GPU storage limits, and sort keys are spaced by log distance. Anti-aliasing is now applied per splat, detected from the file (GSplatParams#antiAliasFilterSize, default 0.1, 3DGS 0.3 px² low-pass). The default minContribution drops from 3 to 2. New loaders: SOG v3, SPZ v3 / LCC2, and SH band 4 for PLY. These are all engine defaults; the viewer pins only the splat budget mode, so it picks them up with no code change.
  • API renames (#9937): the old names keep working as deprecated aliases. None of them are used here (castShadow, unpause, powerOfTwo, PIXELFORMAT_111110F, findAnimationLayer, enableShape, BoundingBox#intersects).
  • Gizmos: picking, drag, and snapping fixes, plus new gizmo types. TranslateGizmo, RotateGizmo, and Gizmo.createLayer keep their signatures.
  • Engine internals: I checked every engine-internal: site against the 2.24.0 build. _flyController and _mode (camera-controls), gsplat _centers, gizmo _hoverAxis, and AppBase.drawLine all still exist.
  • Not adopted: CameraFrame effects, SMAA, and the dynamic sky are opt-in features with no current call site. Nothing in this release removes the need for a local workaround.

Follow-up issues: #144 (--gpu-backend), #145 (camera-track sequences), #146 (viewer-settings picker and job errors), #147 (LOD preview budget controls), #148 (engine-internals canary), #149 (zip64 SOG guard).

Verification

  • npm run typecheck: clean.
  • npm test: 78 passed, 0 failed with the GPU, and 72/72 with SKIP_GPU=1 (CI-equivalent). Six new checks.
  • npm run test:mcp: 26 passed, 0 failed, with two new checks.
  • Docs refreshed:
    • README versions line.
    • docs/USER_GUIDE.md and docs/MCP_WORKFLOWS.md.
    • The skills, with .agents/ re-synced.
    • All screenshots, re-captured with npm run docs:capture.
  • Visual check: in lod-decimate.png the new Min split / File size row is a native .field-row pair under Chunk size / Chunk extent, and the Maximum compression checkbox sits under the encoder row. render-tab.png shows Blur quality under the DoF pair.
  • 2.24.0 pass (commit 08ea27d): typecheck clean. npm test 78/78 with the GPU. npm run test:mcp 26/26. npm run docs:capture re-captured all 24 screenshots.
  • Capture-harness fix: the harness's "load demo splat" step clicked a button labelled "view", which no longer exists, so every canonical screenshot showed "Nothing loaded yet" and the viewer was never exercised. It now clicks .file-eye. The re-captured shots show the demo splat rendering on 2.24.0, with the translate gizmo drawing correctly (viewport-toolbar.png, camera-view.png). This is why every screenshot changed in this commit.
  • An independent review pass found no correctness bugs. It tightened two scratch-dir assertions to check the exact project path.

Authored autonomously by the weekly dependency-update routine.

🤖 Generated with Claude Code

CodeByKeegan and others added 3 commits August 25, 2026 13:36
Upstream 3.3.0 flipped the default decimation algorithm: plain
--decimate is uniform/flat-rate again, and the adaptive (local-error)
path moved to the new --decimate-adaptive flag; the old
--decimate-uniform flag no longer exists. Rewires decimateFlag() in
server/commands.mjs to match (adaptive -> --decimate-adaptive, uniform
-> --decimate), keeping app UX/behavior unchanged since we already
pass an explicit flag for the user's chosen algorithm either way.

Updates every place that named the old flag: UI tooltips, the MCP
tool descriptions, the e2e/mcp-e2e assertions, and the user guide.
Also fixes a pre-existing typo in the MCP decimate description
(wrong short flag) and refreshes the README version line (PlayCanvas
was already at 2.21.4 in package.json but the README hadn't caught
up) and the annotated UI screenshots.

No other CLI surface changes between 3.2.0 and 3.3.3.
…ussians)

splat-transform 3.3.0 makes the LOD writer refuse any source containing a
non-finite gaussian ("LOD 0 gaussian N has a non-finite position; run
--filter-nan to drop invalid gaussians before writing LODs"), where 3.2.0
wrote the bundle. server/commands.mjs already emits -N after each input in
both LOD builders, but nothing could set it: filterNaN was exposed only on
the convert panel and the convert MCP tool, so a LOD bake had no in-flow
remedy for the error it was told to fix.

Add the Filter NaN checkbox to the LOD panel, send it from lod-panel.ts, and
declare filterNaN on the build_lod MCP schema. -N is an ordered action, so it
must follow its input — the e2e check asserts that placement alongside the
fail-then-succeed pair.
- fix --viewer-settings fixture + server preflight (3.5.0 validates settings)
- default blank --scratch-dir to the project folder (3.6.0 dropped the implicit default)
- wire --webp-effort, --lod-chunk-min, --lod-file-count, --dof-samples (UI, API, MCP, e2e)
- pin --shutter to 1 so existing renders keep their blur (3.5.0 default is 0.5)
- viewer: nullable MeshInstance#mesh; pin splat budget to LOD distances (2.23 default budget)
- hide .decimate-gen spill files; ASCII PLY error text
- README versions, USER_GUIDE/MCP docs, skills, screenshots refreshed

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread server/commands.mjs
const isObj = (v) => v != null && typeof v === 'object' && !Array.isArray(v);
const checkViewerSettings = (abs, rel) => {
let text;
try { text = readFileSync(abs, 'utf8'); }
The docs capture harness looked for a "view" text button that no longer
exists, so canonical screenshots never loaded the demo splat. Click
the .file-eye button instead and re-capture.

Co-Authored-By: Claude <noreply@anthropic.com>
@CodeByKeegan CodeByKeegan changed the title chore: bump @playcanvas/splat-transform to 3.10.3, playcanvas to 2.23.3 (+ 4 new flags wired) chore: bump @playcanvas/splat-transform to 3.10.3, playcanvas to 2.24.0 (+ 4 new flags wired) Nov 10, 2026

This branch has not been deployed

No deployments
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.

2 participants