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….

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 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 .html file and a separate .compressed.ply containing the splat. 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))
Start PositionThe starting position to use for the viewer's camera:
• Default: The viewer does its best to pick a suitable start point
• Current Viewport: Use the current camera position as set in the SuperSplat Editor's viewport
• 1st Camera Frame: Use the first camera's position as defined by the first frame of the Timeline
AnimationThe animation to apply to the viewer's camera:
• None: No animation
• Track: Animate the camera using keyframes set on the SuperSplat Editor's Timeline
BackgroundThe background color of the viewer
Field of ViewThe vertical field of view of the viewer's camera in degrees
SH BandsThe number of spherical harmonics bands to be written out to the published compressed PLY file

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 (and the .compressed.ply file if you exported the viewer as a ZIP package).

  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​