Skip to content

Reference

Add-on preferences

Setting Type Default Description
Default Host String 127.0.0.1 Default hostname applied to new scenes
Default Port Integer (1–65535) 3000 Default port applied to new scenes
Debug Mode Boolean Off Reveals Debug panel; enables verbose logging

Per-scene settings

Setting Type Default Description
Host String 127.0.0.1 Server hostname or IP for this scene
Port Integer (1–65535) 3000 Server port for this scene
Auto Start Boolean On Start server when scene loads
Timeout Float (0.1–30.0s) 3.0s Wait time for server start/stop

Document authorization states

State Meaning
Pending Document has arrived but no authorization decision has been made
Authorized Sync updates are applied to the scene in real time
Paused Updates are received but held; not applied until Authorized
Denied Updates are blocked; existing scene content is retained until Purged

Override icons (Materials browser)

Icon Meaning
Globe Global override is active on this material
Refresh arrows A replacement material is active
UV-project UV preview is active
UV grid UV transform or randomize settings are active
Particles Scatter is active

Known limitations

  • Windows only. macOS and Linux are not supported.
  • Blender 5.0 or later is required. Earlier versions are not supported.
  • One sync server per Blender process. Two separate Blender windows running on the same machine can each host their own server, but they must use different ports. Within a single Blender session, only one server runs at a time.
  • Capture Object (accessible via the /capture_object server route) serializes selected mesh objects to world-space geometry. It works on mesh objects only — curves, volumes, and other object types are not supported.
  • Preset files are not automatically migrated if the preset format changes between versions. Re-save presets after a major version upgrade.