\n \n \n \n \n\nBuilt by [World Labs](https://www.worldlabs.ai).\n\n## Features\n\n- Integrates with THREE.js rendering pipeline to fuse splat and mesh-based objects\n- Portable: Works across almost all devices, targeting 98%+ WebGL2 support\n- Renders fast even on low-powered mobile devices\n- Render multiple splat objects together with correct sorting\n- Most major splat file formats supported including: [.PLY](https://github.com/graphdeco-inria/gaussian-splatting) (also [compressed](https://blog.playcanvas.com/compressing-gaussian-splats/#compressed-ply-format)), [.SPZ](https://github.com/nianticlabs/spz), [.SPLAT](https://github.com/antimatter15/splat), [.KSPLAT](https://github.com/mkkellogg/GaussianSplats3D), [.SOG](https://developer.playcanvas.com/user-manual/gaussian-splatting/formats/sog/)\n- Render multiple viewpoints simultaneously\n- Fully dynamic: each splat can be transformed and edited for animation\n- Real-time splat color editing, displacement, and skeletal animation\n- Shader graph system to dynamically create/edit splats on the GPU\n\nCheck out all the [examples](https://sparkjs.dev/examples/)\n\n## Getting Started\n\n### Copy Code\n\nCopy the following code into an `index.html` file.\n\n\n```html\n\n\n\n```\n\n### CDN\n\n```html\n\n```\n\n### NPM\n\n```shell\nnpm install @sparkjsdev/spark\n```\n\n## Run Examples locally\n\nInstall [Rust](https://www.rust-lang.org/tools/install) if it's not already installed in your machine.\n\nNext, build Spark by running:\n```\nnpm install\nnpm run build:wasm\nnpm run build\n```\nThis will first build the Rust Wasm component (`npm run build:wasm`), then Spark itself (`npm run build`).\n\nThe 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:\n```\nnpm run assets:download\n```\n\nOnce you've built Spark and optionally downloaded the assets, you can now run the examples:\n```\nnpm start\n```\nThis will run a dev server by default at [http://localhost:8080/](http://localhost:8080/). Check the console log output to see if yours is served on a different port.\n\n## Develop and contribute to the project\n\n### Build troubleshooting\n\nFirst try cleaning all the build files and re-building everything:\n```\nnpm run clean\nnpm install\nnpm run build:wasm\nnpm run build\n```\n\nThere'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:\n\n```\n npm run assets:clean\n npm run assets:download\n```\n\n### Ignore dist directory during development\n\nTo ignore the dist directory and prevent accidental commits and merge conflicts\n\n```\ngit update-index --assume-unchanged dist/*\n```\n\nTo revert and be able to commit into to the dist directory again:\n\n```\ngit update-index --no-assume-unchanged dist/*\n```\n\nTo list ignored files in case of need to troubleshoot\n\n```\ngit ls-files -v | grep '^[a-z]' | cut -c3-\n```\n\n### Build docs and site\n\nInstall [Mkdocs Material](https://squidfunk.github.io/mkdocs-material/)\n\n```\npip install mkdocs-material\n```\n\nIf you hit an `externally managed environment` error on macOS and if you installed python via `brew` try:\n\n```\nbrew install mkdocs-material\n```\n\nEdit markdown in `/docs` directory\n\n```\nnpm run docs\n```\n\n### Build Spark website\n\nBuild the static site and docs in a `site` directory.\n\n```\nnpm run site:build\n```\n\nYou can run any static server in the `site` directory but for convenience you can run\n\n```\nnpm run site:serve\n```\n\n### Deploy Spark website\n\nThe following command will generate a static site from the `docs` directory and push it to the [repo](https://github.com/sparkjsdev/sparkjsdev.github.io) that hosts the site via `gh-pages`\n\n```\nnpm run site:deploy\n```\n\n### Compress splats\n\nTo compress a splat to [spz](https://scaniverse.com/spz) run\n\n`npm run assets:compress `\n","readmeFilename":"README.md"}