Skip to content

⚙️ Export Settings Deep Dive

When you export your StorySplat scene to HTML (either as a single file or a ZIP package) or when you Save/Update your project to the cloud, you have several options to configure how the final viewer application behaves and appears. These settings are accessed via the File Menu -> Export -> Viewer App... option or the Upload/Update Scene Configuration popup triggered from the User Dashboard.

Basic Configuration

  • Scene Title:
    • Purpose: Sets the title that appears in the browser tab and potentially within the viewer UI (depending on the chosen layout). Also used as the base for the downloaded filename.
    • Required: Yes. Cannot be empty.
  • Description: (Upload/Update Mode Only)
    • Purpose: A text description for your scene, primarily used for display on the StorySplat Discover page and your public profile page.
    • Optional: Yes.
  • Model URL: (Export Mode Only, if using a local model)
    • Purpose: When exporting a scene based on a locally loaded splat file (drag-and-drop or file open), you must provide a publicly accessible URL where this splat data can be fetched by the exported HTML file. The splat data itself is not embedded in the HTML export.
    • Requirement: Enter the direct URL to the .splat, .ply, or .spz file hosted online (e.g., on cloud storage like Firebase Storage, S3, or your own server with proper CORS headers).
    • Not needed if: You originally loaded the splat from a URL, or you are Saving/Updating to the StorySplat cloud (as it uses the stored cloud URL).

Layout & UI Options (uiOptions)

These settings control the visual appearance and user interface elements of the exported viewer.

  • Layouts: (Radio Buttons: Minimal, Centered, Dark)
    • Purpose: Selects the overall theme and layout for the exported viewer's controls (scroll bar, mode buttons, etc.).
      • Minimal: A very basic, centered scrollbar appears at the bottom. Few other UI elements.
      • Centered (Standard): A more prominent centered control bar at the bottom, similar to the Pro layout but often with lighter default colors.
      • Dark (Pro): A dark-themed, professional-looking layout with controls typically anchored to the bottom and potentially sidebars or top elements depending on the specific version. (Matches the editor's default Pro template).
    • Default: Standard/Centered.
  • Hide Navigator: (Checkbox)
    • Purpose: When checked, completely hides the default visual navigation controls (the scroll bar/progress indicator, percentage text, and previous/next buttons) in the exported view.
    • Use Case: Useful if you want a cleaner interface or if you intend to control scene progression primarily through external means (like custom UI buttons on the parent page reacting to Scroll Post Messages). Note: Even when hidden, users can typically still navigate the path by scrolling with their mouse wheel or trackpad in Tour and Hybrid modes, unless camera mode is set to Explore/Walk.
    • Default: Unchecked (Navigator is visible).
  • Waypoint Info Style: (Dropdown: Standard, Pop-up)
    • Purpose: Determines how text information associated with Waypoint interactions is displayed.
      • Standard: Text appears integrated within the main UI controls area (e.g., above the scrollbar).
      • Pop-up: Text appears in a separate modal pop-up window when the waypoint is triggered.
    • Default: Standard.
  • Show Start Experience Button: (Checkbox)
    • Purpose: Adds a large "Start Experience" button overlay that the user must click before the scene fully loads and any autoplaying media (audio/video) begins.
    • Use Case: Essential for ensuring audio (especially) can play automatically in browsers with strict autoplay policies, as it requires a user interaction to initiate the audio context.
    • Default: Unchecked.
  • Enable FPS Counter + Inspector: (Checkbox - Debug Mode)
    • Purpose: Includes debugging tools in the exported HTML. An FPS counter appears in the corner, and the Babylon.js Inspector can be opened (usually with Ctrl+I or Cmd+I).
    • Use Case: For performance testing and debugging the exported scene. Should typically be disabled for final public releases.
    • Default: Unchecked.
  • Disable WebGPU (Force WebGL2): (Checkbox)
    • Purpose: By default, exported scenes attempt to use WebGPU for rendering if the browser supports it (potentially offering better performance), falling back to WebGL2 if not. Checking this box forces the exported scene to use only WebGL2, skipping the WebGPU check.
    • Use Case: Useful if you encounter rendering artifacts or compatibility issues specifically with WebGPU on certain devices/browsers, or if you want to guarantee consistent rendering behavior using the more widely supported WebGL2 standard.
    • Default: Unchecked (WebGPU is attempted first).

Custom Branding (Business/Enterprise Feature)

  • Hide Watermark: (Checkbox - Requires Business/Enterprise) Removes the default "Created with StorySplat" watermark.
  • Watermark Text: (Input - Appears if Watermark not hidden) Customize the text displayed in the watermark.
  • Watermark Link: (Input - Appears if Watermark not hidden) Set the URL the watermark text links to.
  • Custom Preloader Logo: (File Upload) Replace the default StorySplat logo/animation shown during loading with your own brand logo. Upload an image file.

Default Navigation Options

Configure the initial camera behavior and allowed navigation methods for the viewer.

  • Default Navigator Mode: (Dropdown)
    • Purpose: Sets the camera control mode the scene starts in when loaded.
    • Options: Tour, Explore, Hybrid, Walk (only selectable if Walk mode is allowed and a floor collider exists).
    • Default: Tour.
  • Allowed Navigator Modes: (Checkboxes)
    • Purpose: Select which camera modes the end-user can switch between using the UI buttons in the exported viewer.
    • Options: Tour, Explore, Hybrid, Walk.
    • Requirement: At least one mode must be selected. You cannot uncheck the mode currently selected as the Default Navigator Mode.
    • Walk Mode Prerequisite: The "Walk Mode" checkbox can only be enabled if your scene contains at least one "Floor" type collision mesh. A tooltip provides guidance if it's disabled.

Experimental Options (XR & Performance)

Configure settings related to WebXR (VR/AR) and advanced rendering.

  • Include XR Support: (Checkbox)
    • Purpose: Enables WebXR features in the exported scene, adding buttons for entering VR or AR modes if the user's device supports them.
    • Default: Unchecked.
  • XR Mode: (Dropdown - Appears if Include XR is checked)
    • Purpose: Selects the primary XR experience type.
    • Options:
      • AR Mode: Optimized for Augmented Reality experiences (overlaying content on the real world).
      • VR Mode: Optimized for Virtual Reality experiences (immersive headset view).
    • Default: AR Mode.
  • AR Settings: (Expandable Section - Appears if Include XR is checked and XR Mode is AR)
    • Convert Waypoints to AR Hotspots: (Checkbox) Automatically creates simple interactive text hotspots in the AR view at the location of each defined waypoint.
    • AR Hotspot Appearance (Text Size, Text Color, Background Color): Customize the look of the automatically generated AR waypoint hotspots.
    • Always Face Camera (Billboard Mode): (Checkbox) Makes the AR waypoint hotspots always face the user.
    • (Advanced AR features like Hit Testing, Plane Detection, Anchors are configured via code within generateXRSystem.ts based on arOptions in the save file but might not have direct UI toggles in this popup).

Saving & Confirmation

  • Cancel: Discards changes and closes the popup.
  • Export / Upload / Update: Confirms the settings and initiates the selected action (downloading HTML/ZIP, saving configuration to the cloud, or updating an existing cloud save).

Previous: Audio System | Index: Table of Contents