playcanvas/supersplat

SuperSplat Editor

| SuperSplat Editor | User Guide | Blog | Forum |

The SuperSplat Editor is a free and open source tool for inspecting, editing, optimizing and publishing 3D Gaussian Splats. It is built on web technologies and runs in the browser, so there's nothing to download or install.

A live version of this tool is available at: https://superspl.at/editor

To learn more about using SuperSplat, please refer to the User Guide.

Local Development

To initialize a local development environment for SuperSplat, ensure you have Node.js 18 or later installed. Follow these steps:

1. Clone the repository:

   git clone https://github.com/playcanvas/supersplat.git
   cd supersplat
   

2. Install dependencies:

   npm install
   

3. Build SuperSplat and start a local web server:

   npm run develop
   

4. Open a web browser tab and make sure network caching is disabled on the network tab and the other application caches are clear:

   • On Safari you can use Cmd+Option+e or Develop->Empty Caches.
   • On Chrome ensure the options "Update on reload" and "Bypass for network" are enabled in the Application->Service workers tab:
   

5. Navigate to http://localhost:3000

When changes to the source are detected, SuperSplat is rebuilt automatically. Simply refresh your browser to see your changes.

Localizing the SuperSplat Editor

The currently supported languages are available here:

https://github.com/playcanvas/supersplat/tree/main/static/locales

Adding a New Language

1. Add a new <locale>.json file in the static/locales directory.

2. Add the locale to the list here:

   https://github.com/playcanvas/supersplat/blob/main/src/ui/localization.ts

Testing Translations

To test your translations:

1. Run the development server:

   npm run develop
   

2. Open your browser and navigate to:

   http://localhost:3000/?lng=<locale>
   

   Replace <locale> with your language code (e.g., fr, de, es).

Contributors

SuperSplat is made possible by our amazing open source community: