C# SDK

Prerequisites

• Compatible system
• Visual Studio
• .NET Framework
• A valid Pixyz SDK license on your Pixyz license portal

Setup

Standard install (recommended)

1. Open a .NET project
2. Go to Tools/NuGet Package Manager/Package Manager Settings/Package Sources
3. Add a new source
4. Set source URL to: https://unity3ddist.jfrog.io/ui/repos/tree/General/pixyz-nuget-prod-local
5. Open NuGet Package Manager window and look for Pixyz NuGet packages (be sure to set Package source to All)
6. Setup your license
7. Run your first script

Local install

1. Download desired package from archive
2. Open a .NET project
3. Setup a local NuGet package for Pixyz SDK Tools/Options:
4. Install the local package: Tools/NuGet Package Manager/Manage NuGet Packages for Solutions
   • Click on Browse
   • Change package source to Local
   • Install to your C# project
5. Setup your license
6. Run your first script

.NET 8

Some .NET version discrepencies may occur. .NET 8 included a change in how platform-specific packages are loaded. To safely use .NET 8 and depending on your Pixyz release version, you might need a custom configuration to use the Windows package:

1. Open your project file (.csproj) (right click on project → Edit Project File)
2. Add the following configuration under your ItemGroup XML tag:
   <RuntimeHostConfigurationOption Include="System.Runtime.Loader.UseRidGraph" Value="true"/>

Run your first script

using UnityEngine.Pixyz.API;

// init Pixyz
PiXYZAPI api = PiXYZAPI.Initialize();

// print Pixyz version
Console.WriteLine(api.Core.GetVersion());

// if no license is found, try to configure a license server
if (!pxz.Core.CheckLicense()) {
    pxz.Core.ConfigureLicenseServer("company-server-hostname", 27000, true);
}

// add all tokens
foreach (var token in pxz.Core.ListTokens().list) {
    try {
        pxz.Core.NeedToken(token);
    }
    catch { /* catch silently*/ }
}

// use api.IO.ImportScene to import a file and enjoy :)