Skip to content
Loom Docs

Sync UI Dependencies

Loom → Sync UI Dependencies is the one Editor menu most customers run. It updates your UI app’s @loomgui/bridge and @loomgui/vite-plugin versions to match the currently installed Unity package, and runs npm install.

When to run it

  • After installing the Unity package for the first time.
  • After upgrading the Unity package to a new version.
  • If node_modules/@loomgui/* somehow gets out of sync with the bundled tarballs (rare; usually only happens after a manual rm -rf node_modules followed by npm install without re-running the sync).

You don’t need to run it on every Editor start — only after installing or upgrading Loom.

What it does

The menu installs the bundled @loomgui/bridge and @loomgui/vite-plugin tarballs into <ProjectRoot>/UI/.loom/, updates the matching entries in <ProjectRoot>/UI/package.json to point at those local files, and runs npm install.

Output streams to the Unity Console. When the install finishes, the Console reports [Loom] npm install completed. Restart Unity.

After running

Restart Unity. The new versions take effect on the next launch.

Recovery

If the menu errors out:

  • “Could not find UI~/ folder” — the Unity package is missing its bundled tarballs. This usually means the install was incomplete. Reinstall the Unity package.
  • “No /UI/ directory” — create it; see Your first screen for the scaffold.
  • npm install exits non-zero — see the [Loom npm] lines in the Console. Common causes: Node missing from PATH (run node --version in a terminal to confirm), or a corrupt node_modules/ (delete it and re-run the menu).