An advanced 3D Gaussian Splatting renderer for THREE.js
npm install @sparkjsdev/spark
- Integrates with THREE.js rendering pipeline to fuse splat and mesh-based objects
- Portable: Works across almost all devices, targeting 98%+ WebGL2 support
- Renders fast even on low-powered mobile devices
- Render multiple splat objects together with correct sorting
- Most major splat file formats supported including: .PLY (also compressed), .SPZ, .SPLAT, .KSPLAT, .SOG
- Render multiple viewpoints simultaneously
- Fully dynamic: each splat can be transformed and edited for animation
- Real-time splat color editing, displacement, and skeletal animation
- Shader graph system to dynamically create/edit splats on the GPU
Check out all the examples
Copy the following code into an index.html file.
``html`
Remix the glitch starter template
`html`
`shell`
npm install @sparkjsdev/spark
Install Rust if it's not already installed in your machine.
Next, build Spark by running:
`
npm install
npm run build
This will first build the Rust Wasm component (can be invoked via ), then Spark itself (npm run build).
The examples fetch assets from a remote URL. This step is optional, but offline development and faster loading times are possible if you download and cache the assets files locally with the following command:
`
npm run assets:download
Once you've built Spark and optionally downloaded the assets, you can now run the examples:
`
npm start
This will run a dev server by default at http://localhost:8080/. Check the console log output to see if yours is served on a different port.
First try cleaning all the build files and re-building everything:
`
npm run clean
npm install
npm run build
There's no versioning system for assets. If you need to re-download a specific file you can delete that asset file individually or download all assets from scratch:
`
npm run assets:clean
npm run assets:download
To ignore the dist directory and prevent accidental commits and merge conflicts
`
git update-index --assume-unchanged dist/*
To revert and be able to commit into to the dist directory again:
`
git update-index --no-assume-unchanged dist/*
To list ignored files in case of need to troubleshoot
`
git ls-files -v | grep '^[a-z]' | cut -c3-
Install Mkdocs Material
`
pip install mkdocs-material
If you hit an externally managed environment error on macOS and if you installed python via brew try:
`
brew install mkdocs-material
Edit markdown in /docs directory
`
npm run docs
Build the static site and docs in a site directory.
`
npm run site:build
You can run any static server in the site directory but for convenience you can run
`
npm run site:serve
The following command will generate a static site from the docs directory and push it to the repo that hosts the site via gh-pages
`
npm run site:deploy
To compress a splat to spz run
npm run assets:compress