Installing the Unity package

Requirements

  • Unity 2021.3 LTS or newer (the package uses ObjectChangeEvents, GlobalObjectId and UI Toolkit editor APIs).
  • Windows, macOS or Linux editor.
  • Outbound HTTPS and WebSocket (WSS) on port 443 to your Skein server — see Networking.
  • Scenes serialized as text (default). Needed for snapshots.

Install

Unity Asset Store (when available): Window → Package Manager → My Assets → Skein → Download → Import.

Git URL: Window → Package Manager → + → Add package from git URL…

https://github.com/skeinlabs/skein.git?path=/unity/Packages/com.skeinlabs.collab

Local folder: Window → Package Manager → + → Add package from disk… → select unity/Packages/com.skeinlabs.collab/package.json, or in Packages/manifest.json:

{ "dependencies": { "com.skeinlabs.collab": "file:../../path/to/com.skeinlabs.collab" } }

What gets installed

  • Two editor-only assemblies: SkeinLabs.Collab.Core (no UnityEngine dependency) and SkeinLabs.Collab.Editor.
  • No runtime code: nothing is included in player builds. No components are added to your scenes. No third-party DLLs.
  • Credentials are stored in your user profile (%LOCALAPPDATA%/SkeinLabs/Collab or ~/.local/share/SkeinLabs/Collab), never in the project.
  • Per-session identity caches go to Library/SkeinLabs/ (already ignored by Unity's standard .gitignore).

Which server it connects to

Normally nothing to do: the package connects to the server it was built for. To change it, open Skein window → Server, enter your site (e.g. app.yourstudio.com), then Use for me or Save for whole team (writes ProjectSettings/SkeinSettings.json — commit it). Local development: http://localhost:3100/api.

Uninstall

Remove the package in Package Manager. Optionally delete the credentials folder above.