StorySplat Documentation

Introduction to StorySplat

StorySplat is a powerful platform for creating and sharing interactive 3D stories using Gaussian Splat technology. This documentation will guide you through every aspect of creating, customizing, and sharing your 3D stories.

Understanding Gaussian Splats

Before diving into creation, it's helpful to understand what Gaussian Splats are and how they work:

• What are Gaussian Splats? They're a type of 3D point cloud where each point has properties like position, size, orientation, and color that blend together to create smooth, high-quality 3D scenes.
• Advantages: Smaller file sizes, faster loading times, and better visual quality compared to traditional 3D formats.
• Use Cases: Perfect for photogrammetry, 3D scans, architectural visualization, and interactive storytelling.

Getting Started

File Formats and Conversion

StorySplat supports two main file formats:

• .ply files: Standard 3D point cloud format, commonly exported from 3D scanning software
• .splat files: Optimized format specifically for gaussian splatting

Loading Your First Scene

There are multiple ways to get your 3D content into StorySplat:

• Drag and Drop: Simply drag your .ply or .splat file into the editor
• File Menu: Use the File → Open option to select your file
• URL Import: Load scenes directly from a URL (must be CORS-enabled)

Creating Interactive Stories

Working with Waypoints

Waypoints are the building blocks of your story's journey:

• Creating Waypoints: Position your camera and click the "+" button in the Waypoints panel
• Editing Waypoints: Adjust camera position, timing, and transitions
• Adding Content: Each waypoint can include:
  • Text descriptions
  • Spatial Audio

Interactive Elements

Make your stories more engaging with interactive features:

• Hotspots: Create clickable points of interest
  • Add text/image popups
  • Link to external content
  • Trigger custom actions
• Collision Areas: Define boundaries and restricted areas

Camera Controls and Navigation

Navigation Modes

• Tour Mode: Automated camera movement following waypoints
  • Perfect for guided experiences
  • Customizable transition timing
  • Optional auto-play feature
• Explore Mode: Free camera movement
  • WASD+QE keys for movement
  • Mouse for looking around
• Hybrid Mode: Combines guided tour with free exploration

Scene Customization

Visual Settings

• Background: Customize the scene background color or gradient
• Lighting: Adjust scene lighting and shadows, this only works for meshes, not splats (Working on Relighting Splats)
• UI Colors: Customize interface elements to match your brand

Sharing and Export

Export Options

• HTML Export: Create standalone web pages
  • Complete with all interactions and animations
  • Embeddable in any website
  • Mobile-friendly responsive design
• Direct Link: Share via StorySplat platform
  • Cloud Saves
  • Analytics tracking

Best Practices

• Optimize Your Scenes:
  • Convert to .splat format for better performance
  • Use appropriate quality settings for your target devices
  • Test on different devices and browsers
• Create Engaging Stories:
  • Start with an interesting opening waypoint
  • Use hotspots to highlight important details
  • Keep transitions smooth and natural
  • Add context through descriptions and audio
• Performance Tips:
  • Optimize scene size for web delivery
  • Use progressive loading for large scenes
  • Consider mobile users when setting quality levels

Troubleshooting

Common Issues

• Scene Won't Load:
  • Check file format compatibility
  • Verify file size limits
  • Ensure stable internet connection
• Performance Issues:
  • Reduce point count
  • Clear browser cache

Support Resources

• Email: help@storysplat.com
• Discord Community: Join for real-time help
• Example Gallery: Browse example stories
• Video Tutorials: Watch step-by-step guides