Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

40 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MultiSet SDK for Unity

The MultiSet SDK provides powerful localization, navigation, and AR tracking capabilities for Unity applications. This package enables developers to integrate advanced spatial computing features with minimal setup.

πŸ“‹ Prerequisites

Before getting started, ensure you have:

  • Unity 6000.3.11f1 or later
  • Valid MultiSet credentials (Client ID and Client Secret)
  • Map/MapSet/ModelSet codes from your MultiSet dashboard
  • iOS/Android development tools for mobile deployment
  • Basic Unity development experience

πŸš€ Installation

Git URL (Recommended)

  1. Open Unity and create a new 3D project or open your existing project
  2. Navigate to Window β†’ Package Manager
  3. Click the "+" button in the top-left corner
  4. Select "Add package from git URL"
  5. Enter the following URL and click Add:
https://github.com/MultiSet-AI/multiset-unity-sdk.git

Verify Installation

After installation, you should see "MultiSet-SDK" listed in the Package Manager under "In Project".

πŸ“¦ Dependencies

The SDK automatically installs these required packages:

  • Unity Cloud - Draco (5.4.2)
  • Unity Cloud - glTFast (6.15.1)
  • AR Foundation (6.3.3)
  • AI Navigation (2.0.11)

🎯 Sample Scenes

The SDK includes comprehensive sample scenes to demonstrate key features.

Import Sample Scenes

  1. Open Window β†’ Package Manager
  2. Find "MultiSet-SDK" in the package list
  3. Click on the package to view details
  4. Navigate to the "Samples" tab
  5. Click "Import" next to "Sample Scenes"

The samples will be imported to:

Assets/Samples/MultiSet-SDK/[version]/Sample Scenes/

Available Sample Scenes

Scene Purpose Location
Mapping.unity Basic mapping functionality Mapping/
Localization.unity Basic localization functionality Localization/
Single Frame Localization.unity Single-shot localization Localization/
ModelSetTracking.unity 3D model tracking ModelSetTracking/
Navigation.unity AR navigation features Navigation/
Training.unity Training mode capabilities Training/
OnDeviceLocalization.unity OnDevice Localization capabilities OnDeviceLocalization/
MapSetAlignment.unity Align Mapsets within Unity Editor AlignMapSet/
SimulationDataCapture.unity Simulation Data Capture SimulationData/
GlobalToLocal.unity Coordinates from global to local GlobalToLocal/

βš™οΈ Configuration

Step 1: Configure API Credentials

  1. Navigate to the configuration file:

    Assets/Samples/MultiSet-SDK/[version]/Sample Scenes/Resources/MultiSetConfig.asset
    
  2. Open the ScriptableObject file in the Inspector

  3. Replace the placeholder values with your actual credentials:

    Client Id = "YOUR_CLIENT_ID_HERE"
    Client Secret = "YOUR_CLIENT_SECRET_HERE"

Step 2: Configure Map Settings

  1. Open your desired sample scene (e.g., Localization.unity)

  2. Select the MultisetSdkManager GameObject in the Hierarchy

  3. In the Inspector, locate the MapLocalizationManager component

  4. Configure your localization method:

    • Map: For single, specific locations
    • MapSet: For multiple related locations or larger coverage areas
    • ModelSet: For 3D model tracking scenarios in ModelTrackingManager
  5. Enter your corresponding code:

    • Map Code: For individual location mapping
    • MapSet Code: For grouped location sets
    • ModelSet Code: For 3D model tracking

πŸ’‘ Tip: You can obtain these codes from your MultiSet dashboard after creating maps.

Step 3: Platform-Specific Setup

For iOS:

  • Ensure iOS Build Support is installed
  • Set Target SDK to iOS 12.0 or later
  • Enable Camera Usage Description in Player Settings
  • ARKit XR-Plugin Provider must be enabled.

For Android:

  • Ensure Android Build Support is installed
  • Set Minimum API Level to 26 or higher
  • ARCore XR-Plugin Provider must be enabled

πŸ—οΈ Build and Deploy

Build Settings

  1. Navigate to File β†’ Build Settings
  2. Select your target platform (iOS or Android)
  3. Click "Add Open Scenes" to include your scene
  4. Configure platform-specific settings:

iOS Settings:

  • Target Device: iPhone & iPad
  • Target SDK: Device SDK
  • Scripting Backend: IL2CPP

Android Settings:

  • Scripting Backend: IL2CPP
  • Target Architectures: ARM64

Testing

  1. Click "Build and Run" to deploy to your device
  2. Grant camera permissions when prompted
  3. Test localization functionality in your target environment
  4. Verify AR features work as expected

πŸ› οΈ API Reference

Core Classes

  • MultiSetSdkManager: Main SDK manager and entry point
  • MappingManager: Scan area and create map
  • MapLocalizationManager: Handles localization operations
  • NavigationController: Manages AR navigation features
  • ModelSetTrackingManager: Controls 3D model tracking

πŸ“± Platform Requirements

iOS

  • iOS 13.0+
  • ARKit compatible device (iPhone 10x or newer)
  • Camera access permission

Android

  • Android API level 26 or higher
  • ARCore supported device
  • Camera access permission

πŸ” Troubleshooting

Common Issues

Package Installation Issues

  • Error: "Package not found"
  • Solution: Ensure Unity version is 6000.3.11f1 or later, verify Git URL is correct

Credential Errors

  • Error: "Authentication failed"
  • Solution: Verify Client ID and Secret in MultiSetConfig.asset

AR Foundation Issues

  • Error: "AR Foundation not initialized"
  • Solution: Ensure AR Foundation packages are properly installed and updated

Build Errors

  • Error: Platform-specific compilation errors
  • Solution: Check platform requirements, update XR settings

πŸ“ž Support

For technical support and questions:

πŸ“„ License

This package is proprietary software. See the LICENSE file for detailed terms and conditions.

πŸ”„ Updates

To update the SDK:

  1. Open Package Manager
  2. Find MultiSet-SDK
  3. Click "Update" if available
  4. Or remove and re-add with latest Git URL

For manual updates, use:

https://github.com/MultiSet-AI/multiset-unity-sdk.git#latest

Version: 1.15.2 Unity Compatibility: 6000.3.11f1+
Last Updated: May 2026

About

No description, website, or topics provided.

Resources

Stars

16 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages