A Unity package for generating and rendering 3D Gaussian Splatting scenes using the WorldLabs API.

This package combines:

• WorldLabs API Client — Generate 3D scenes from text prompts using WorldLabs' AI
• Gaussian Splatting Renderer — Real-time rendering of 3D Gaussian Splat assets
• Runtime Browser UI — In-game VR/screen-space world browser and creator
• Editor Importer — Unity Editor window for browsing and importing worlds as project assets

The Gaussian Splatting implementation is based on UnityGaussianSplatting, extended with runtime loading, splat layer support, and WorldLabs API integration.

• Unity Version: 6000.2.10f1 (Recommended/Tested)
• Render Pipeline: Universal Render Pipeline (URP) is required
• Dependencies: Burst 1.8.8+, Collections 2.1.4+, Mathematics 1.2.6+ (installed automatically)

1. Open Unity and go to Window > Package Manager
2. Click the + button and select Add package from git URL…
3. Enter:

   https://github.com/nigelhartm/worldlabs_unity.git
   

4. Click Add

1. Obtain an API key from WorldLabs
2. Create a .env file in the project root (next to the Assets/ folder):

   WORLDLABS_API_KEY=your_worldlabs_key
   

   The key is read at runtime from StreamingAssets/.env (copied by the build process) and in the Editor from the project root.

Troubleshooting: If the key does not load, open Window > WorldLabs > WorldLabsUnityIntegration > Settings and click Reload API Key.

D3D11 is NOT supported. Go to Project Settings > Player > Other Settings > Graphics APIs and use:

• Windows: D3D12 or Vulkan
• Mac: Metal
• Linux / Android (Meta Quest, Pico): Vulkan

Meta Quest Warning: Adding a Camera Rig from "Meta Building Blocks" may automatically force the project to D3D11. Switch it back to Vulkan manually and ignore the Meta Quest Project Setup Tool warning about this change.

1. Locate your active URP Renderer Data asset (usually in Assets/Settings/)
2. Click Add Renderer Feature and select GaussianSplatURPFeature
3. Recommended mobile/XR settings:
   • Depth Texture: On
   • HDR: On
   • MSAA: Off (Disabled)

1. Go to Project Settings > Graphics
2. Enable the checkbox: Compatibility Mode (Render Graph disabled)

If building for VR:

1. Go to Project Settings > XR Plugin Management > OpenXR
2. Change Render Mode from Single Pass Instanced to Multi-pass

These two components provide a fully in-game, API-connected world browser and loader — useful for VR builds or any runtime scene.

1. In the Package Manager select WorldLabs Gaussian Splatting → Samples → Sensai Sample → Import
2. The import adds:
   • sensai.asset — a pre-processed Gaussian Splat you can use as a default placeholder
   • Prefabs/WorldLabs_GUI.prefab — a ready-wired prefab with both components
3. Drag WorldLabs_GUI.prefab into your scene
4. Select the prefab instance, and assign sensai.asset to World Manager → Default Asset
5. Enter Play Mode — the browser canvas appears and connects to your WorldLabs account

Add both components to the same GameObject:

WorldBrowserController requires WorldLabsWorldManager on the same GameObject (enforced by [RequireComponent]).

[Screenshot — WorldLabsWorldManager Inspector]

Shaders and compute shaders are auto-assigned from the package path on reset and at runtime — no manual drag-and-drop needed.

[Screenshot — WorldBrowserController Inspector]

The full UI hierarchy (Canvas, scroll view, buttons, create panel) is auto-built at Awake when not pre-wired. Use the sample prefab and adjust there for a custom layout.

UI Features:

• Paginated grid of your WorldLabs worlds with panorama thumbnails
• Tap a card to load the world; tap again to unload it
• ➕ Create button opens a text-prompt panel to generate new worlds inline
• Progress bar and status text during download and generation

WorldLabsWorldManager and WorldBrowserController are runtime-only components that stream worlds on demand from the API. They do not create project assets.

For importing worlds into your project as Unity assets, use the Editor window:

Window → WorldLabs → WorldLabsUnityIntegration

This opens WorldLabsEditorWindow, which lets you:

• Browse and filter your WorldLabs worlds
• Generate worlds from text, image URL, image file, or video URL
• Import worlds as GaussianSplatAsset files with resolution and compression quality options
• Load imported assets directly into the active scene

You can drive WorldLabsWorldManager entirely from code without WorldBrowserController.

using System.Collections.Generic;
using UnityEngine;
using WorldLabs.API;
using WorldLabs.Runtime;

public class MyWorldLoader : MonoBehaviour
{
    WorldLabsWorldManager _manager;

    async void Start()
    {
        _manager = GetComponent<WorldLabsWorldManager>();

        // Subscribe to events
        _manager.OnWorldLoaded       += (id, r)    => Debug.Log($"Loaded: {id}");
        _manager.OnWorldLoadFailed   += (id, err)  => Debug.LogError($"Failed: {err}");
        _manager.OnWorldLoadProgress += (id, prog) => Debug.Log($"{id}: {prog:P0}");

        // Fetch first page of your worlds
        List<World> worlds = await _manager.ListWorldsAsync(pageSize: 10);

        if (worlds.Count > 0)
            await _manager.LoadWorldAsync(worlds[0]);
    }

    void Unload(string worldId)     => _manager.UnloadWorld(worldId);
    void RestoreDefault()           => _manager.RestoreDefaultWorld();
}

// List worlds (paginated)
List<World> worlds = await manager.ListWorldsAsync(
    pageToken: null,              // pass manager.LastNextPageToken for next page
    pageSize:  20,
    status:    WorldStatus.SUCCEEDED,
    isPublic:  null);

// Load a world (download → GPU processing → spawn renderer)
GaussianSplatRenderer r = await manager.LoadWorldAsync(world);

// Unload one world
manager.UnloadWorld(worldId);

// Unload everything and restore the default asset placeholder
manager.RestoreDefaultWorld();

// Unload everything
manager.UnloadAllWorlds();

// Query state
bool loaded  = manager.IsWorldLoaded(worldId);
bool loading = manager.IsWorldLoading(worldId);
IReadOnlyList<World> cached = manager.CachedWorlds;
string nextPage = manager.LastNextPageToken;  // null = no more pages

// C# events
manager.OnWorldsListed      += (List<World> list)          => { };
manager.OnWorldLoadStarted  += (string id)                 => { };
manager.OnWorldLoadProgress += (string id, float progress) => { };
manager.OnWorldLoaded       += (string id, GaussianSplatRenderer r) => { };
manager.OnWorldLoadFailed   += (string id, string error)   => { };
manager.OnWorldUnloaded     += (string id)                 => { };

Import Sensai Sample via Package Manager to get:

1. Open Window > WorldLabs > WorldLabsUnityIntegration
2. Go to Create World, enter a text prompt (or provide an image/video URL)
3. Click Generate — the operation tracks in the My Worlds list
4. Once complete, click Import on the world card and choose a resolution
5. Add a GaussianSplatRenderer component to a GameObject and assign the imported asset

• Lighting: Gaussian Splat scenes are pre-lit — removing Unity directional lights avoids double-lighting
• Mobile/XR: Keep models at 500k points / Medium Quality for smooth framerates on standalone headsets

Created as part of the SensAI Hack — Worlds in Action, powered by SensAI Hackademy.

MIT — see LICENSE.md