Welcome to the StorySplat Documentation! 📚

StorySplat empowers you to transform 3D Gaussian Splat scenes into engaging, interactive web experiences. Whether you're showcasing architectural designs, preserving cultural heritage, creating educational tours, or telling any spatial story, StorySplat provides the tools you need.

This documentation serves as your comprehensive guide to understanding and utilizing all the features of the StorySplat editor and platform.

Intro Video 🎬

Watch this short video to get a quick overview of what StorySplat can do:

---

Quick Start Guide

New to StorySplat? Get started quickly:

1. Load Your Scene: Follow the Getting Started guide to import your .ply, .splat, or .spz file.
2. Navigate: Learn the basics of moving around in the Camera Controls guide.
3. Create a Path: Add your first points using the Waypoints guide (essential for saving!).
4. Add Interactivity: Explore adding context with Hotspots.
5. Save & Share: Learn how to save your work and share it using the Sharing and Export guide.

Table of Contents

Core Concepts

• 🤔 Understanding Gaussian Splats: Learn about the technology behind StorySplat.
• 💾 File Format Compatibility & Conversion: Details on .ply, .splat, .spz and how StorySplat handles them, including orientation fixes and SH data.

Getting Started & Editor Basics

• 🚀 Getting Started: Your first steps - loading a scene and basic navigation.
• 🖥️ Editor UI Overview: (Coming Soon) A visual guide to the different panels and toolbars.
• ⚙️ Settings Menu: Customize camera behavior, rendering options, UI colors, and more.
• 📁 File Menu: Tools for format conversion, local saving/loading (.json), remote loading, and exporting.

Building Your Scene

• 📍 Waypoints: Define the camera path, set viewpoints, and trigger interactions.
• ✨ Hotspots: Add interactive points with text, images, videos, GIFs, iframes, and external links.
• 🧊 Custom 3D Models: Import and manage traditional mesh models (.glb, .gltf) within your scene.
• 🔁 SplatSwap: Dynamically switch between different splat models along the camera path.
• 🔊 Audio System: Add background music, narration, or spatial sound effects to waypoints and custom models.
• 💡 Scene Lighting: Add and configure lights (affects meshes and hotspots, not splats).
• 🌌 Skybox & Background Settings: Customize the scene's surrounding environment.
• ✨ Particle Systems: Add dynamic visual effects like smoke, rain, or sparks.
• 🧊 Collision System: Define boundaries for Walk mode and VR teleportation.

Editing & Optimization

• ✏️ Editing Splats (SuperSplat Integration): Use the integrated editor to clean up or crop your core splat data.
• ⚙️ Optimization Guide: Tips for improving performance and load times.

Sharing & Account

• 📤 Sharing and Exporting: Understand direct links, embed codes, and self-hosted HTML exports.
• ⚙️ Export Settings Deep Dive: Detailed explanation of all export options.
• 👤 Account Management & Subscription: Manage saved scenes, storage, and subscription plans (Free, Plus, Business).
• 🖼️ User Dashboard Deep Dive: Detailed explanation of dashboard actions (Save, Update, Delete, Visibility, etc.).
• 🌍 Public Profiles: Set up your public showcase page.
• 🧭 Discovery Page: Explore public splats shared by the community.
• 📈 Pricing & Upgrading: Information on different subscription tiers.
• 📊 Analytics: (Coming Soon / Pro Feature) Understand how users interact with your scenes.

Technical Info

• 📜 Scroll Post Message Functionality: How embedded scenes communicate scroll progress to parent pages.

Support

• 🛠️ Troubleshooting Guide: Solutions for common issues.
• 📖 Glossary: (Coming Soon) Definitions of key terms.

---

Let's dive in! Choose a topic from the Table of Contents to learn more.