Skip to main content

Self-Hosting the Viewer

The SuperSplat Viewer is open source and can be directly exported by the SuperSplat Editor should you wish to self-host your splat content instead of (or in addition to) publishing to superspl.at. The exported viewer runs in any modern web browser with easy-to-use camera controls and supports AR and VR visualization on devices that support WebXR.

Exporting the HTML Viewer​

To export your splat as an HTML viewer:

  1. Open the File > Export submenu in the SuperSplat Editor.
  2. Select Viewer App….
note

Viewer export requires a browser with WebGPU support, as the embedded splat data is compressed to SOG on the GPU. In a browser without WebGPU, the export fails with the error: "This export requires WebGPU, which is not available in this browser. Please try a recent version of Chrome, Edge or Safari."

Export Options​

The viewer export can be configured via several options:

Viewer Export

OptionDescription
Export TypeControls the format of the exported viewer:
• HTML: A single-page .html file where the splat is compressed to SOG, Base64 encoded and embedded directly into the file. Very convenient since everything is packed into a single file that can be double-clicked to run in your browser using the file:// protocol. However, the base64 encoding means it will be roughly 30% larger than the ZIP Package format, and browsers impose different limits on the maximum size (below 32MB should load everywhere, but above this you could encounter problems)
• ZIP Package: A zip file containing the viewer app (index.html, index.js, index.css and settings.json) plus the splat data as a bundled SOG file (index.sog). Smaller, loads faster and guaranteed to load everywhere. However, it will only load over http://, so you will need to run a local web server (e.g. Node's serve or Python's http.server (python -m http.server))
AnimationIf enabled, the camera animation authored on the Timeline is included and plays when the viewer loads. Only available when the Timeline has keyframes (and enabled by default in that case)
Loop ModeHow an included camera animation plays back:
• None: Play once and stop
• Repeat (default): Loop continuously
• Ping Pong: Play forwards, then backwards, repeatedly
BackgroundThe background color of the viewer. Defaults to the Editor's current background color
Field of ViewThe vertical field of view of the viewer's camera in degrees. Defaults to the Editor camera's current setting
SH BandsThe number of spherical harmonics bands to include in the exported splat data

The exported viewer's camera starts at the pose your viewport camera has at the moment you export, so frame your favorite view before exporting.

Web Hosting for the HTML Viewer​

Once exported, you can host the HTML Viewer file somewhere to make it accessible. One easy option is to use GitHub Pages:

  1. Create a new repository on GitHub.

  2. Add the exported HTML file (or, for a ZIP package, the extracted contents of the zip: index.html, index.sog, index.js, index.css and settings.json).

  3. Visit your repository's Settings page. Select Pages on the left. Ensure Source is set to Deploy from a branch and set Branch to main and hit Save.

  4. It will take a few moments for your viewer to be published. The URL will be in the form:

    https://<github-username>.github.io/<repository-name>/<html-filename>

See also​