Install the SDK

The SDK comes from the NodeWorld package registry, in Unity's Package Manager. You add the registry to your project once; then you install and update the SDK like Unity's own packages.

Which package#

A project can have both. Pulse (com.nodeworld.pulse), for worlds that react to their music, comes from the same registry.

Add the registry to the project#

1. Open your project in Unity 6000.6, then Edit, Project Settings, Package Manager.
2. Under Scoped Registries, click + and fill in:
   • Name: NodeWorld
   • URL: https://registry.nodeworldvr.com
   • Scope(s): com.nodeworld
3. Click Save.
4. Click + again for the second registry, then Save:
   • Name: OpenUPM
   • URL: https://package.openupm.com
   • Scope(s): com.cysharp

The SDK uses UniTask, by Cysharp, which is published on OpenUPM: the second registry is for it.

You can also write the two registries in the project's Packages/manifest.json, above "dependencies" (if the file already has "scopedRegistries", add the two entries to its list):

"scopedRegistries": [
  {
    "name": "NodeWorld",
    "url": "https://registry.nodeworldvr.com",
    "scopes": [ "com.nodeworld" ]
  },
  {
    "name": "OpenUPM",
    "url": "https://package.openupm.com",
    "scopes": [ "com.cysharp" ]
  }
],

Install the package#

1. Open Window, Package Manager.
2. In the list on the left, choose My Registries.
3. Select NodeWorld SDK Worlds (or NodeWorld SDK Avatars), then Install.

The Package Manager adds NodeWorld SDK Base and the Unity packages the SDK needs (URP, XR Interaction Toolkit, Input System, Entities…). The NodeWorld menu appears in the menu bar.

Right after, the SDK imports into the project what the Play mode player needs, when the project does not have it: the Starter Assets and Hands Interaction Demo samples of the XR Interaction Toolkit and HandVisualizer of XR Hands, in Assets/Samples, and the TextMesh Pro essential resources, in Assets/TextMesh Pro. Keep them in the project: without them, the player neither moves nor clicks.

Import the example#

Select the package in the Package Manager, open its Samples tab, then Import:

• Example World (NodeWorld SDK Worlds): a small world with a portal, a mirror, objects everyone grabs, a television and more, one FL# script each. See the example world.
• Avatar Setup (NodeWorld SDK Avatars): the game's default avatar, ready to publish, and how to make your model an avatar, step by step. See avatar setup.

Unity copies it into Assets/Samples of your project: change it as you like, it is yours.

Update#

When a new version of the SDK is out, the Package Manager shows it on the package: select NodeWorld SDK Worlds (or Avatars), then Update. NodeWorld SDK Base is updated with it. What changed is in the SDK changelog.

An example you imported stays as it was: import it again to get the new version's, in a new folder.