A project template for building interactive applications for TellUs. It provides a Three.js framework with example scenes and a globe preview for testing locally. Neutralino.js packages the project as a Windows app.
Install Git and Node.js 24 LTS, then run:
git clone https://github.com/c-toolbox/TellUs-ThreeJS.git
cd TellUs-ThreeJS
npm install
npm start # Run in a browser (http://localhost:5173)
npm dev # Run in a native windowUse the top-left menu to switch between view modes.
| View | Purpose |
|---|---|
| Globe preview | Simulates the physical spherical display. Click or drag on the globe to simulate touch input. Use a touch-screen for multi-touch events. Drag the background to rotate the view around it. Scroll to zoom. |
| Projector output | The azimuthal image required by the projector inside the sphere. Use this view on the TellUs computer so the image maps correctly onto the display. |
| 3D scene | Explore the Three.js scene with an orbit camera. Useful for inspecting objects and their placement. |
npm run dev defaults to globe preview. npm run build defaults to projector output.
Use the top-left menu to switch between scenes.
- PlanetScene: includes a few example planet images and videos, and touch buttons.
- BlenderScene: includes a Blender scene exported as a GLB file, animated objects and simple touch interactions.
- InteractionScene: includes interactive UI elements and tests, images, text, and animations.
SocketUI is an optional separate application for controlling your scenes from a browser, either on your computer or on another device on the same local network.
- Download the latest Windows executable from the SocketUI release page.
- Run
SocketUI.exeon the same computer as your TellUs app and leave it running in the background (in the system tray). - With your TellUs app running, visit http://localhost:7000 in a browser to open the control panel and communicate with your scenes.
Each scene's socketUiConfig describes which UI elements to display. Interactions in SocketUI are sent back to listeners in registerSocketUiListeners(), specifying which element was updated.
See the SocketUI frontend documentation for all available UI elements and their configuration.
Before deploying, update your application's meta data:
- Set application title/team/description in app.config.json
- Set application icon in src/public
npm run buildThis creates a Windows executable in dist/win/<package-name>.
The build also generates a complete Inno Setup script at dist/installer.iss. To create an installer locally, open that generated script in Inno Setup and compile it after building. The installer is intended for the TellUs computer.
Keep your project in a GitHub repository and enable GitHub Actions. The included release workflow builds the app and compiles the generated Inno Setup script on pushes to main, then publishes a ZIP containing the app and installer under Releases.


