Skip to main content

Setup

Set up VRseBuilder SDK in a clean Unity 6 project. This guide follows the recommended package-based installation path: create a fresh URP project, add the VRseBuilder scoped registry, install the Access package, sign in, and let the SDK install the Core package for you.

info

Target Unity version: 6000.3.19f1
Project template: Universal Render Pipeline (URP)

warning

Unity package installation changes your project. Keep the project under version control and let Unity finish each package import, script compilation, domain reload, and restart before continuing.

Before You Begin

Prepare the following before starting the SDK installation:

  • Unity Hub with Unity Editor 6000.3.19f1 installed
  • A VRseBuilder account with access to SDK packages
  • A stable internet connection for package downloads
  • A new or disposable Unity project for first-time setup validation

1. Create a Fresh Unity 6 URP Project

Start from a clean URP project so package setup is predictable.

  1. Open Unity Hub.
  2. Install or select Unity Editor 6000.3.19f1.
  3. Select New project.
  4. Choose Universal 3D (URP/SRP).
  5. Set the project name and location.
  6. Select Create project.
  7. Wait for Unity to open the project and finish the first import.

Unity Hub new project screen with the Universal 3D template selected

Use the Universal 3D template so the project starts with URP configuration already in place.

2. Add the VRseBuilder Scoped Registry

Unity Package Manager needs the VRseBuilder package registry before it can discover SDK packages.

  1. In Unity, open Edit > Project Settings.
  2. Select Package Manager.
  3. Under Scoped Registries, select +.
  4. Add this registry entry:
FieldValue
NameVRseBuilder
URLhttps://npm.autovrse.app
Scopescom.autovrse.vrsebuilder
  1. Select Save or apply the Project Settings changes.

Unity Package Manager scoped registry settings for VRseBuilder

Add only the VRseBuilder scope at this stage. The SDK setup tools add any additional required scopes later after login.

tip

Keep the scope limited to com.autovrse.vrsebuilder. Additional scopes, such as media.lightside, are added automatically by the SDK setup flow when they are needed.

3. Install VRseBuilder Access

The Access package adds the login flow and installer entry points that bootstrap the rest of the SDK.

  1. Open Window > Package Management > Package Manager.
  2. Set the package source dropdown to My Registries or Packages: My Registries.
  3. Select VRseBuilder Access.
  4. Confirm the package ID is com.autovrse.vrsebuilder.access.
  5. Select Install.

Unity Package Manager showing the VRseBuilder Access package

Install VRseBuilder Access first. It unlocks the login window and starts the guided SDK installation flow.

info

If Unity shows a Signature missing message for the Access package, you can continue with installation.

4. Sign In To VRseBuilder

After Access installs, Unity should open the VRseBuilder Login window automatically.

If the login window does not open, use VRseBuilder > Auth > Login from the Unity menu bar.

  1. Optional: expand Advanced only if your team uses a custom API base URL.

  2. Keep the default API base URL unless you were given a different environment:

    https://api-pulse.autovrse.app/api
  3. Enter your Username and Password.

  4. Select Sign In.

VRseBuilder Login window in Unity

Use your VRseBuilder credentials to authenticate the package installer.

After a successful login, VRseBuilder starts installing VRseBuilder SDK (Core) automatically. The Core package ID is com.autovrse.vrsebuilder.core.

This download can take a few minutes depending on your connection speed. Do not close Unity while the package is downloading, importing, or compiling.

5. Restart Unity And Confirm Core

Unity may ask for an Editor restart after the Core package is added.

  1. In the Editor Restart Required dialog, select Restart Now.
  2. Wait for Unity to reopen the project.
  3. Open Package Manager and confirm VRseBuilder Core is installed.

Unity dialog indicating that an Editor restart is required

Restart when prompted so Unity can reload assemblies and complete SDK initialization cleanly.

6. Install the Photon SDK Bundle

Install Photon after Core is ready. This gives VRseBuilder the networking packages it expects for multiplayer and voice-enabled experiences.

  1. In Unity, open VRseBuilder > Projects Hub.
  2. Open Settings.
  3. Open Packages.
  4. Find Photon SDK Bundle.
  5. Select Install.

The bundle installs the required Photon packages for VRseBuilder, including Fusion, Voice, and Fusion Physics.

7. Install the Sample Project

Install the Sample Project as the final setup step. It gives you a complete reference project you can open and study so you can see how a finished VRseBuilder training module is structured.

  1. Open VRseBuilder > Projects Hub > Settings > Packages.
  2. Find Sample Project.
  3. Select Install.
  4. Open the sample after installation and use it as a reference before building your first production module.

VRseBuilder Packages

After the SDK is installed, use VRseBuilder > Projects Hub > Settings > Packages to install and manage tools around the core SDK.

VRseBuilder Packages tab showing available tools

Required SDK Packages

PackageWhat it provides
VRseBuilder AccessLogin, authentication, and installer entry points. Install or update this package before Core so you can authenticate with VRseBuilder.
VRseBuilder CoreThe main VRseBuilder SDK package. It adds the editor tools, runtime systems, story tooling, object setup workflows, and project/module authoring features used by VRseBuilder experiences.

Optional Tools And Add-ons

PackageWhat it provides
VRse MCPConnects Claude Code / Cursor for AI-assisted authoring.
UniTextUnicode text rendering with RTL, emoji, and shaping support.
PulseAnalytics and compliance layer for VR training. This package is marked Coming Soon in the Packages tab.
Photon SDK BundleInstalls Fusion, Voice, and Fusion Physics in the required versions.
Sample ProjectReference VRseBuilder project with a complete training module.

Update VRseBuilder

Use Unity Package Manager when updating an existing project. Unity's Manual resolve action forces Package Manager to resolve the project's packages again; if needed, Unity reinstalls altered or missing packages and removes packages that should no longer be present.

  1. Open Window > Package Management > Package Manager.
  2. Select My Registries > VRseBuilder.
  3. Open the Package Manager Advanced menu, shown as the settings/three-dots menu depending on your Unity version.
  4. Select Manual resolve and wait for Unity to finish resolving packages.
  5. Select VRseBuilder Access and update it first.
  6. Sign in again with your VRseBuilder credentials if Unity prompts you, or open VRseBuilder > Auth > Login manually.
  7. After Access is updated and you are signed in, select VRseBuilder Core and update it.
  8. Let Unity finish downloading, importing, compiling, and restarting if prompted.
warning

Update VRseBuilder Access before VRseBuilder Core. Core updates rely on the current Access package and an authenticated VRseBuilder session.

If Package Manager Cannot Find The Registry

In some projects, Unity Package Manager can fail to find the VRseBuilder registry after package configuration issues. This is more likely while VRseBuilder packages are still unsigned.

If Manual resolve and reopening Unity do not restore the registry, reset the user Package Manager config:

  1. Close Unity.
  2. Go to your Windows user folder, for example C:\Users\<your-user>.
  3. Delete .upmconfig.toml if it exists. Unity stores this user Package Manager config at %USERPROFILE%\.upmconfig.toml.
  4. Reopen Unity, add the VRseBuilder scoped registry again if needed, then run Manual resolve from Package Manager.

Next Steps