Install
Loom ships as a single Unity package tarball with the two npm packages
bundled inside. There’s no public npm registry hop and no separate native
binary download — everything you need is in the .tgz you drop into
Packages/.
Prerequisites
- Unity 6 (
6000.x). Earlier versions are not tested. - Node 20+ on the host that runs the Editor. Required for the
Loom → Sync UI Dependenciesmenu, which runsnpm installfor your UI app. - A UI app folder at
<ProjectRoot>/UI/with apackage.json. If you don’t have one yet, see Your first screen.
Steps
-
Drop the tarball. Copy
com.loomgui-X.Y.Z.tgzinto your project’sPackages/directory. -
Reference it. Add the package to
Packages/manifest.json:{"dependencies": {"com.loomgui": "file:com.loomgui-X.Y.Z.tgz"// ... your other dependencies}} -
Sync the UI npm packages. In the Editor, run
Loom → Sync UI Dependencies. The menu installs the bundled npm packages into your UI app and runsnpm install. Output streams to the Unity Console. -
Restart Unity.
That’s it. Hit Play — your UI loads automatically. Subsequent plays work the same.
Verifying the install
Open Window → General → Loom Doctor. The doctor reports:
- Native plugin loaded
- ABI version match
- WS port bound
- UI dir present
- npm dependencies installed
If any of these report red, see Doctor reference.
Upgrading
When a newer com.loomgui-X.Y+1.Z.tgz lands, replace the tarball in
Packages/, re-run Loom → Sync UI Dependencies, and restart Unity. Same
one button, every upgrade.