gaussian-splat-lite 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project follows [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-08-24
+
+### Added
+
+- Initial public release of the Three.js Gaussian Splatting renderer.
+
+[Unreleased]: https://github.com/WilliamLiu-1997/Gaussian-Splat-Lite/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/WilliamLiu-1997/Gaussian-Splat-Lite/releases/tag/v0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing
+
+Thanks for contributing to `gaussian-splat-lite`.
+
+## Development setup
+
+Building the WebAssembly module requires Node.js 20.9 or newer, a Rust
+toolchain installed through `rustup`, and the `wasm32-unknown-unknown` target.
+
+```bash
+npm ci
+npm run build:wasm
+```
+
+Start the local viewer with `npm run dev`.
+
+## Validation
+
+Run the complete release check before opening a pull request:
+
+```bash
+npm run release:check
+```
+
+This builds the WebAssembly module and example site, type-checks and lints the
+source, runs the tests, builds the package, and verifies the npm tarball.
+
+When dependency updates introduce or change install scripts, review them and
+update the pinned `allowScripts` entries with `npm approve-scripts`.
+
+## Pull requests
+
+- Keep changes focused on one problem.
+- Update the README and API docs when public behavior changes.
+- Add or update tests for behavior that can be exercised without WebGL.
+- Include a minimal reproduction and captures for rendering changes when
+  possible.
+- Add user-visible changes to the `Unreleased` section of `CHANGELOG.md`.
+- Do not commit generated `dist/`, `site-dist/`, Rust `target/`, or wasm-pack
+  `pkg/` directories.
+
+## Maintainer releases
+
+The npm package is published by `.github/workflows/publish.yml` when a matching
+`v*` tag is pushed. The workflow rejects tags that do not match the version in
+`package.json`, skips versions already present on npm, and creates the GitHub
+release from `CHANGELOG.md`.
+
+Before the first automated release, make the GitHub repository public, then
+publish the package once from a maintainer account so that its npm settings
+exist:
+
+```bash
+npm run release:check
+npm publish --access public
+```
+
+Then, using a current npm CLI, configure GitHub Actions as the trusted publisher
+for future releases:
+
+```bash
+npm trust github gaussian-splat-lite \
+  --repo WilliamLiu-1997/Gaussian-Splat-Lite \
+  --file publish.yml \
+  --allow-publish
+```
+
+The same setting is available under the package's npm **Settings → Trusted
+Publisher** page. The workflow uses short-lived OIDC credentials, so no
+`NPM_TOKEN` repository secret is required after this setup.
+
+For each release:
+
+1. Move the relevant changelog entries from `Unreleased` into a dated version
+   section.
+2. Update `package.json` and `package-lock.json` with
+   `npm version <version> --no-git-tag-version`.
+3. Run `npm run release:check`, commit the release changes, then create and push
+   `v<version>`.

package/Gaussian-Splat-Lite.svg

@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   width="645"
+   height="180"
+   viewBox="0 0 645 180"
+   version="1.1"
+   id="svg16"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <defs
+     id="defs20" />
+  <rect
+     width="645"
+     height="180"
+     fill="#10151e"
+     id="rect2" />
+  <circle
+     cx="83"
+     cy="90"
+     r="38"
+     fill="none"
+     stroke="#69717e"
+     stroke-width="3"
+     opacity=".82"
+     id="circle4" />
+  <circle
+     cx="54"
+     cy="65"
+     r="11"
+     fill="#cfff58"
+     id="circle6" />
+  <circle
+     cx="112"
+     cy="65"
+     r="11"
+     fill="#8ea9ff"
+     id="circle8" />
+  <circle
+     cx="83"
+     cy="124"
+     r="11"
+     fill="#f6f5f0"
+     id="circle10" />
+  <g
+     aria-label="Gaussian Splat Lite"
+     id="text14"
+     style="fill:#ffffff">
+    <path
+       d="m 183.3,81.05 q -1.15,-2.9 -3.25,-4.45 -2.1,-1.6 -6.55,-1.6 -2.45,0 -4.2,0.65 -1.75,0.6 -3.15,2.1 -1.4,1.5 -2.1,4.35 -0.7,2.8 -0.7,6.95 v 4.9 q 0,4.15 0.7,7 0.7,2.8 2.1,4.3 1.4,1.5 3.15,2.15 1.75,0.6 4.2,0.6 4.5,0 7.15,-1.9 2.65,-1.95 2.65,-4.15 V 93.5 h -6.15 V 92 h 7.95 v 9.45 q 0,3.35 -3.05,5.7 -3,2.35 -8.55,2.35 -6.15,0 -8.9,-3.75 -2.75,-3.8 -2.75,-11.8 v -4.9 q 0,-8 2.75,-11.75 2.75,-3.8 8.9,-3.8 4.95,0 7.4,1.85 2.45,1.8 3.8,5.15 z"
+       id="path22" />
+    <path
+       d="m 195.74999,107.5 h 16.3 l -10.25,-24.15 -10.9,25.65 h -1.6 l 12.5,-29.5 12.5,29.5 h -18.55 z"
+       id="path24" />
+    <path
+       d="m 220.59999,80 v 14.5 q 0,7.45 2.35,10.5 2.4,3 6.55,3 4.15,0 6.5,-3 2.4,-3.05 2.4,-10.5 V 80 h 1.5 v 14.5 q 0,15 -10.4,15 -10.4,0 -10.4,-15 V 80 Z"
+       id="path26" />
+    <path
+       d="m 256.15002,79.4 q 6.2,0 8.8,2.75 l -1,1.1 q -2.4,-2.35 -7.6,-2.35 -7.8,0 -7.8,6.2 0,2.4 1.9,3.85 1.9,1.4 4.6,2.15 2.75,0.75 5.45,1.6 2.75,0.8 4.65,2.65 1.9,1.8 1.9,4.75 0,3.45 -2.85,5.5 -2.85,2.05 -8.25,2.05 -2.65,0 -5.25,-0.7 -2.55,-0.7 -3.8,-2.05 l 1,-1.1 q 2.55,2.35 7.85,2.35 4.85,0 7.3,-1.8 2.5,-1.8 2.5,-4.2 0,-2.5 -1.9,-4.05 -1.9,-1.55 -4.65,-2.3 -2.7,-0.8 -5.45,-1.6 -2.7,-0.85 -4.6,-2.6 -1.9,-1.75 -1.9,-4.6 0,-3.85 2.55,-5.7 2.6,-1.9 6.55,-1.9 z"
+       id="path28" />
+    <path
+       d="m 281.60003,79.4 q 6.2,0 8.8,2.75 l -1,1.1 q -2.4,-2.35 -7.6,-2.35 -7.8,0 -7.8,6.2 0,2.4 1.9,3.85 1.9,1.4 4.6,2.15 2.75,0.75 5.45,1.6 2.75,0.8 4.65,2.65 1.9,1.8 1.9,4.75 0,3.45 -2.85,5.5 -2.85,2.05 -8.25,2.05 -2.65,0 -5.25,-0.7 -2.55,-0.7 -3.8,-2.05 l 1,-1.1 q 2.55,2.35 7.85,2.35 4.85,0 7.3,-1.8 2.5,-1.8 2.5,-4.2 0,-2.5 -1.9,-4.05 -1.9,-1.55 -4.65,-2.3 -2.7,-0.8 -5.45,-1.6 -2.7,-0.85 -4.6,-2.6 -1.9,-1.75 -1.9,-4.6 0,-3.85 2.55,-5.7 2.6,-1.9 6.55,-1.9 z"
+       id="path30" />
+    <path
+       d="m 299.40004,80 h 1.5 v 29 h -1.5 z"
+       id="path32" />
+    <path
+       d="m 312.65,107.5 h 16.3 L 318.7,83.35 307.8,109 h -1.6 l 12.5,-29.5 12.5,29.5 h -18.55 z"
+       id="path34" />
+    <path
+       d="M 336.5,109 V 80 h 1.5 l 16.3,26.25 V 80 h 1.5 v 29 h -1.5 L 338,82.7 V 109 Z"
+       id="path36" />
+    <path
+       d="m 378.40002,82.65 q 0,-4.85 2.45,-7 2.45,-2.15 7.95,-2.15 3.85,0 6.2,2 2.35,2 3.4,6.1 l -4.65,3.5 h -2.45 l 5.4,-4.05 q -1.05,-3.35 -3.05,-4.7 -1.95,-1.35 -4.85,-1.35 -2,0 -3.4,0.25 -1.35,0.25 -2.75,1 -1.35,0.7 -2.05,2.3 -0.7,1.6 -0.7,4.1 0,2.2 2,3.9 2.05,1.7 4.95,2.9 2.9,1.2 5.8,2.45 2.95,1.25 4.95,3.2 2.05,1.95 2.05,4.5 0,5 -2.5,7.45 -2.45,2.45 -8.45,2.45 -4.9,0 -7.7,-1.95 -2.8,-2 -3.85,-6.15 l 1.4,-0.6 q 1,4.05 3.4,5.65 2.45,1.55 6.75,1.55 4.8,0 7.1,-1.85 2.35,-1.85 2.35,-6.55 0,-2.2 -2.05,-3.9 -2,-1.7 -4.95,-2.9 -2.9,-1.2 -5.8,-2.45 -2.9,-1.25 -4.95,-3.2 -2,-1.95 -2,-4.5 z"
+       id="path38" />
+    <path
+       d="m 419.30005,98.2 -0.75,-1.3 2.8,-1.6 q 3.45,-1.9 3.45,-6.05 0,-7.75 -11.8,-7.75 h -4.6 V 119 h -1.5 V 80 h 6.1 q 6.6,0 9.95,2.45 3.35,2.4 3.35,6.8 0,5 -4.2,7.35 z"
+       id="path40" />
+    <path
+       d="m 449.65004,107.5 v 1.5 h -16.7 V 80 h 1.5 v 27.5 z"
+       id="path42" />
+    <path
+       d="m 457.65,107.5 h 16.3 L 463.7,83.35 452.8,109 h -1.6 l 12.5,-29.5 12.5,29.5 h -18.55 z"
+       id="path44" />
+    <path
+       d="m 500.25,80 v 1.5 h -10.5 V 109 h -1.5 V 81.5 h -10.5 V 80 Z"
+       id="path46" />
+    <path
+       d="m 541.04998,107.5 v 1.5 h -20.9 V 74 h 1.5 v 33.5 z"
+       style="fill:#cfff58"
+       id="path48" />
+    <path
+       d="m 546.14996,80 h 1.5 v 29 h -1.5 z"
+       style="fill:#cfff58"
+       id="path50" />
+    <path
+       d="m 575.49994,80 v 1.5 h -10.5 V 109 h -1.5 V 81.5 h -10.5 V 80 Z"
+       style="fill:#cfff58"
+       id="path52" />
+    <path
+       d="m 600.24995,106.05 q -2.75,3.45 -9,3.45 -6.25,0 -8.95,-3.55 -2.7,-3.55 -2.7,-11.45 0,-7.9 2.7,-11.45 2.7,-3.55 8.95,-3.55 7.25,0 9.85,4.75 l -12.25,10.25 h -2.35 l 12.65,-10.55 q -2.2,-2.95 -7.9,-2.95 -2.5,0 -4.2,0.55 -1.7,0.5 -3.15,1.95 -1.4,1.4 -2.1,4.15 -0.7,2.7 -0.7,6.85 0,4.15 0.7,6.9 0.7,2.7 2.1,4.15 1.45,1.4 3.15,1.95 1.7,0.5 4.2,0.5 5.7,0 7.9,-2.95 z"
+       style="fill:#cfff58"
+       id="path54" />
+  </g>
+</svg>

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,10 @@
+Gaussian Splat Lite
+Copyright 2026 William Liu <lyz15972107087@gmail.com>
+
+This product includes software derived from SparkJS v2.1.0,
+Copyright © 2025 WORLD LABS TECHNOLOGIES, INC., licensed under the MIT
+License. See THIRD_PARTY_LICENSES.md for the complete license notice.
+
+This product includes ruzstd v0.7.3,
+Copyright © 2019 Moritz Borcherding, licensed under the MIT License.
+See THIRD_PARTY_LICENSES.md for the complete license notice.

package/README.md

@@ -0,0 +1,272 @@
+<div align="center">
+
+# Gaussian-Splat-Lite
+
+[![npm version](https://img.shields.io/npm/v/gaussian-splat-lite)](https://www.npmjs.com/package/gaussian-splat-lite)
+[![CI](https://github.com/WilliamLiu-1997/Gaussian-Splat-Lite/actions/workflows/ci.yml/badge.svg)](https://github.com/WilliamLiu-1997/Gaussian-Splat-Lite/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+<p align="center">
+  <img src="./Gaussian-Splat-Lite.svg" alt="Gaussian Splat Lite" width="645">
+</p>
+
+</div>
+
+`Gaussian-Splat-Lite` is a lightweight 3D Gaussian Splatting renderer for Three.js. It is based on the overall architecture of [SparkJS](https://github.com/sparkjsdev/spark), simplified and adapted to retain a stable, general-purpose Gaussian Splat rendering pipeline while removing LoD, paging, dynamic shader graphs, and broad format compatibility layers. It also fixes SparkJS precision issues with large GIS/ECEF world coordinates and provides faster depth sorting and raycasting implementations.
+
+It works alongside standard Three.js scenes, cameras, meshes, and render loops, and supports unified generation, sorting, and blended rendering of multiple Splat objects.
+
+## Features
+
+- Native integration with the Three.js scene graph and rendering pipeline
+- Multiple `SplatMesh` objects rendered with correct global sorting
+- `.ply` and `.spz` file support
+- URL, in-memory byte, and standard `ReadableStream` inputs
+- Rust/WebAssembly file decoding, depth sorting, and raycasting
+- 3DGS rendering and optional 2DGS support
+- Spherical harmonics, depth of field, offscreen rendering, and environment-map rendering
+- SDF-based color and opacity editing
+- Camera-relative rendering for large GIS/ECEF world coordinates
+- TypeScript declarations, ESM, and CommonJS builds
+
+## Requirements
+
+- A modern browser with WebGL2, WebAssembly, Web Workers, and ES modules
+- Three.js `0.185.1` or newer
+- Correct CORS headers when loading Splat files from another origin
+
+## Installation
+
+```sh
+npm install gaussian-splat-lite three
+```
+
+## Quick start
+
+```js
+import * as THREE from "three";
+import { GaussianSplatRenderer, SplatMesh } from "gaussian-splat-lite";
+
+const scene = new THREE.Scene();
+const camera = new THREE.PerspectiveCamera(
+  60,
+  window.innerWidth / window.innerHeight,
+  0.1,
+  1000,
+);
+camera.position.set(0, 0, 3);
+
+const renderer = new THREE.WebGLRenderer({
+  antialias: false,
+  powerPreference: "high-performance",
+});
+renderer.setPixelRatio(window.devicePixelRatio);
+renderer.setSize(window.innerWidth, window.innerHeight);
+document.body.appendChild(renderer.domElement);
+
+// One GaussianSplatRenderer is normally enough for each Three.js renderer.
+const splatRenderer = new GaussianSplatRenderer({ renderer });
+scene.add(splatRenderer);
+
+const splat = new SplatMesh({ url: "/assets/scene.spz" });
+scene.add(splat);
+
+// Wait before reading loaded data such as the count or bounding box.
+await splat.initialized;
+console.log(`Loaded ${splat.numSplats} splats`);
+
+renderer.setAnimationLoop(() => {
+  renderer.render(scene, camera);
+});
+
+window.addEventListener("resize", () => {
+  camera.aspect = window.innerWidth / window.innerHeight;
+  camera.updateProjectionMatrix();
+  renderer.setSize(window.innerWidth, window.innerHeight);
+});
+```
+
+`GaussianSplatRenderer` is itself a Three.js scene object. It collects visible `SplatMesh` objects, generates GPU data, sorts the combined collection, and draws it. Application code continues to use the standard `renderer.render(scene, camera)` call; it does not need to issue a separate draw call for each Splat.
+
+Some PLY/SPZ data uses a `+Y`-down, `+Z`-forward convention. If a model appears upside down or faces the wrong direction, rotate the object without changing its decoded data:
+
+```js
+splat.quaternion.set(1, 0, 0, 0); // Rotate 180 degrees around X.
+```
+
+## Loading data
+
+### From a URL
+
+```js
+const splat = new SplatMesh({
+  url: "/assets/model.ply", // .spz is also supported.
+  onProgress: (event) => {
+    if (event.lengthComputable) {
+      console.log(`${Math.round((event.loaded / event.total) * 100)}%`);
+    }
+  },
+  onLoad: (mesh) => console.log(mesh.numSplats),
+});
+
+scene.add(splat);
+await splat.initialized;
+```
+
+### From a File or ReadableStream
+
+This form is suitable for file pickers, drag and drop, and large local files. The data is decoded locally by WebAssembly and is not automatically uploaded anywhere.
+
+```js
+import { SplatFileType, SplatMesh } from "gaussian-splat-lite";
+
+const file = fileInput.files[0];
+const fileType = file.name.toLowerCase().endsWith(".spz")
+  ? SplatFileType.SPZ
+  : SplatFileType.PLY;
+
+const splat = new SplatMesh({
+  fileName: file.name,
+  fileType,
+  stream: file.stream(),
+  streamLength: file.size,
+  onProgress: ({ loaded, total }) => console.log(loaded, total),
+});
+
+scene.add(splat);
+await splat.initialized;
+```
+
+Complete in-memory file data can also be supplied:
+
+```js
+const bytes = new Uint8Array(await file.arrayBuffer());
+const splat = new SplatMesh({
+  fileBytes: bytes,
+  fileType: SplatFileType.SPZ,
+});
+```
+
+When the input URL does not have a recognizable extension, specify `fileType` explicitly or provide a `.ply` / `.spz` name through `fileName`.
+
+### Creating Splats in code
+
+```js
+import * as THREE from "three";
+import { SplatMesh } from "gaussian-splat-lite";
+
+const splat = new SplatMesh({
+  maxSplats: 100,
+  constructSplats: (data) => {
+    data.pushSplat(
+      new THREE.Vector3(0, 0, 0),       // center
+      new THREE.Vector3(0.2, 0.1, 0.1), // scales
+      new THREE.Quaternion(),            // rotation
+      1,                                 // opacity
+      new THREE.Color(0x4f8cff),         // color
+    );
+  },
+});
+
+scene.add(splat);
+await splat.initialized;
+```
+
+## Core concepts and public API
+
+| API | Purpose |
+| --- | --- |
+| [`GaussianSplatRenderer`](docs/GaussianSplatRenderer.md) | Integrates with Three.js and generates, sorts, and draws every visible Splat |
+| [`SplatMesh`](docs/SplatMesh.md) | A transformable, visible, and raycastable Gaussian Splat scene object |
+| [`SplatLoader`](docs/SplatLoader.md) | A Three.js Loader-style PLY/SPZ decoder |
+| [`Splats`](docs/Splats.md) | The built-in mutable Splat source, with per-Splat read and write access |
+| [`SplatSource`](docs/SplatSource.md) | The TypeScript interface implemented by custom Splat sources |
+| [`SplatEdit`](docs/SplatEdit.md) / [`SplatEditSdf`](docs/SplatEdit.md) | SDF-region RGBA editing objects |
+| [`SplatAccumulator`](docs/SplatAccumulator.md) | A low-level generation buffer used by the renderer; normally internal |
+| [`SplatFileType`](docs/SplatFileType.md) | File type enum containing `PLY` and `SPZ` |
+
+## Large world coordinates / GIS / ECEF
+
+The renderer keeps large translations separate from float32 local coordinates. Rendering subtracts the camera origin while values are still JavaScript double-precision numbers, and sorting stores one float64 world origin per `SplatMesh` alongside its float32 local centers. This happens automatically and does not move scene objects or change the world-coordinate behavior of `SplatMesh`, Raycaster, or SDF edits.
+
+Source Splat centers should still remain local to their mesh wherever possible. Precision already lost by storing absolute ECEF coordinates in a float32 source cannot be recovered during rendering.
+
+## Manual updates and animation
+
+By default, the renderer automatically detects object-count, transform, appearance, and camera changes. Use `onFrame` for per-frame animation:
+
+```js
+const splat = new SplatMesh({
+  url: "/assets/model.spz",
+  onFrame: ({ mesh, time }) => {
+    mesh.rotation.y = time * 0.2;
+  },
+});
+```
+
+When automatic updates are disabled, call `update()` after the scene or camera changes:
+
+```js
+const splatRenderer = new GaussianSplatRenderer({
+  renderer,
+  autoUpdate: false,
+});
+
+await splatRenderer.update({ scene, camera });
+renderer.render(scene, camera);
+```
+
+## Offscreen rendering
+
+```js
+const captureRenderer = new GaussianSplatRenderer({
+  renderer,
+  target: {
+    width: 1920,
+    height: 1080,
+    superXY: 2,
+  },
+});
+scene.add(captureRenderer);
+
+await captureRenderer.update({ scene, camera });
+const rgba = await captureRenderer.renderReadTarget({ scene, camera });
+// rgba is a 1920 * 1080 * 4 Uint8Array.
+```
+
+If the same scene also contains a `GaussianSplatRenderer` used for canvas display, control the instances with `layers` or `visible` as appropriate so that both are not rendered as ordinary scene objects during the same pass.
+
+## Development
+
+Building from source requires Node.js 20.9 or newer, a Rust toolchain installed through `rustup`, and the `wasm32-unknown-unknown` target. `build:wasm` installs `wasm-pack` through Cargo when it is not already available.
+
+```sh
+npm install
+npm run build:wasm
+npm run build
+npm test
+```
+
+Start the local PLY/SPZ viewer with:
+
+```sh
+npm run dev
+```
+
+Open the local URL printed by Vite, normally `http://localhost:8080/`. Drag a `.ply` or `.spz` file onto the viewer, or use its file picker. Files are decoded locally and are not uploaded.
+
+Other useful commands:
+
+```sh
+npm run build:watch
+npm run check
+npm run lint
+npm run format
+npm run release:check
+```
+
+The package build emits ESM and CommonJS bundles in `dist/`, together with TypeScript declarations and source maps.
+
+## License
+
+Gaussian Splat Lite is licensed under the [Apache License 2.0](LICENSE). Required attribution notices are provided in [NOTICE](NOTICE), and bundled third-party licenses are listed in [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md).