diff --git a/README.md b/README.md index dafb51a..40cff1c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,42 @@ # SuperSplat -SuperSplat is a free and open source tool for inspecting and editing 3D Gaussian Splats. It is built on web technologies and runs in the browser so there's nothing to download and install. +SuperSplat is a free and open source tool for inspecting and editing 3D Gaussian Splats. It is built on web technologies and runs in the browser, so there's nothing to download or install. -supersplat +A live version of this tool is available at: https://playcanvas.com/supersplat/editor -See https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/ for more information on gaussian splats. +supersplat -A live version of this tool is available at: https://playcanvas.com/supersplat/editor +See https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/ for more information on gaussian splats. ## Loading Scenes -To load a Gaussian splat PLY file, drag & drop it onto the application page. - -Alternatively, use the File menu at the top left of the screen and choose "Open". +To load a Gaussian splat PLY file, drag & drop it onto the application page. Alternatively, use the Scene menu and choose "Open". -SuperSplatFileMenu +SuperSplatFileMenu If you disable the "Load all PLY data" option before loading the file, then the PLY data not required by the editor is excluded (for example the spherical harmonic data). This can save on browser memory. ## Editing Scenes -Once a PLY file is loaded you can use the selection tools to modify splat selection and then delete splats from the scene. +Once a PLY file is loaded, you will see it appear in the SCENE MANAGER panel. Use this panel to hide splats, remove them from the scene, orientate them and select the current splat for editing. + +Screenshot 2024-08-08 at 14 07 25 + +Use the bottom toolbar to access the selection tools, tranform tools and undo/redo. + +Screenshot 2024-08-08 at 14 17 48 + +The SPLAT DATA panel plots various scene properties on a histogram display. You can select splats directly by dragging on the histogram view. Use the Shift key to add to the current selection and Ctrl key to remove from the current selection. -You can also reorient the scene using the SCENE Position/Rotation/Scale controls. +Screenshot 2024-08-08 at 14 02 08 ## Saving Results -Once you're done editing the scene, click the Export -> "Ply file" button to export the edited splat scene to the local file system. +Once you're done editing the scene, use the Scene menu to Save, Save As and Export the scene to the local file system. Only visible splats are written. ## Current Limitations -This editor is in beta and so currently has some limitations: +This editor currently has the following limitations: - Only supports Gaussian splat PLY files - Spherical harmonic data is not rotated on export