🚀 Getting Started with StorySplat
Welcome to StorySplat! This guide will walk you through the first steps to load your 3D Gaussian Splat scene and begin creating your interactive story.
1. Loading Your 3D Scene
There are three primary ways to bring your Gaussian Splat data into the StorySplat editor:
-
☁️ Load from URL (Recommended for Cloud Storage):
- Go to the File Menu (📁 icon).
- In the "Load Remote Splats (URL)" section, paste the direct URL to your
.ply
,.splat
, or.spz
file. - Click Load.
- Note: The URL must be publicly accessible or have correct CORS settings. If you encounter issues, try enabling the "Use CORS Proxy" option in the Settings Menu (⚙️ icon).
-
💻 Drag and Drop (Local Files):
- Locate your
.ply
,.splat
, or.spz
file on your computer. - Simply drag the file from your file explorer and drop it anywhere onto the main StorySplat editor window.
- The editor will automatically load the file.
- Locate your
-
✨ Try an Example:
- Go to the File Menu (📁 icon).
- Expand the "Load Example Splats" section.
- Click on one of the provided example names to instantly load a pre-configured scene. This is a great way to explore features without needing your own file immediately.
File Format Tip: While StorySplat supports
.ply
,.splat
, and.spz
, using or converting to.spz
often provides the best balance of quality (preserving lighting details) and file size. Learn more in the File Format Compatibility guide. Enable "Auto-convert PLY to SPZ" in the File Menu if your PLY files contain Spherical Harmonics.
2. Basic Navigation
Once your scene is loaded, familiarize yourself with the camera controls:
- Explore Mode (Default after loading):
- W/A/S/D: Move Forward/Left/Back/Right
- Q/E: Move Up/Down
- Mouse Drag (Left Button): Look Around
- I/P: Roll Camera
- Scroll Wheel: In modes other than Explore/Walk, this typically moves you along the waypoint path (once created).
See the full Camera Controls and Navigation guide for details on all modes (Tour, Hybrid, Walk, Edit).
3. Creating Your First Waypoint (Essential!)
Waypoints define the camera's path and trigger interactions in your story. You must create at least one waypoint to save or export your project.
- Position the camera where you want your story to begin.
- Open the Waypoints Menu (📍 icon).
- Click the "Set Initial Camera Position" (or "Add Waypoint") button.
Learn more about adding interactions and customizing your path in the Waypoints Guide.
Next Steps
You've loaded your scene and created your first waypoint! Now you're ready to:
- Add more Waypoints to build your camera path.
- Create interactive Hotspots.
- Define Collision boundaries for Walk mode.
- Adjust Lighting and Skybox settings.
- Explore advanced features like SplatSwap.
- Save and Export your creation.