Skip to main content

Bootstrap Wizard

A Unity Editor tool that simplifies the setup and configuration of the Genies Avatar SDK by automating prerequisite checks and fixes.

Bootstrap Wizard

How to Use

Follow the Getting Started tutorial to learn how to use the bootstrap wizard.

Configurations

Prerequisites

The wizard checks and can automatically fix the following prerequisites:

1. Newtonsoft.Json Package

  • Required: Yes (all other checks depend on this)
  • Purpose: Enables JSON serialization for manifest configuration
  • Fix: Installs Unity's official com.unity.nuget.newtonsoft-json package

2. IL2CPP Scripting Backend

  • Required: Yes
  • Purpose: The Genies SDK requires IL2CPP compilation
  • Fix Options:
    • Fix Active: Configures IL2CPP for the currently selected build target only
    • Fix All: Configures IL2CPP for all supported build targets

3. .NET Framework API Compatibility

  • Required: Yes
  • Purpose: Ensures proper API compatibility level (.NET Framework 4.8 or .NET Standard 2.0)
  • Fix Options:
    • Fix Active: Configures the API level for the currently selected build target only
    • Fix All: Configures the API level for all supported build targets

4. Vulkan Graphics API

  • Required: Yes (Windows only)
  • Purpose: Configures Windows Graphics API to Vulkan
  • Fix: Configures Windows Graphics API to Vulkan

5. Genies Scoped Registry

  • Required: Yes
  • Purpose: Adds the Genies package registry to enable package downloads
  • Fix: Automatically adds the registry configuration to your project's manifest.json

Configuration Files

The wizard uses the following configuration files:

  • Editor/Config/scopes.json: Defines the npm scopes for the Genies package registry
  • Project manifest.json: Unity's package manifest (automatically modified by the wizard)

Technical Details

Requirements

  • Unity 2022.3 or later (recommended)
  • URP 3D Project ("Universal 3D Template")
  • Internet connection for package downloads
  • Write access to project Packages/manifest.json

Modified Settings

The wizard may modify the following Unity project settings:

  • Player Settings → Scripting Backend: Set to IL2CPP
  • Player Settings → API Compatibility Level: Set to .NET Framework 4.8
  • Package Manifest: Adds Genies scoped registry and package dependencies

Package Registry

The wizard configures access to the Genies package registry at:

  • URL: https://npm.genies.com/
  • Scopes: Defined in Editor/Config/scopes.json