Skip to main content

Installation

info

Unity version supported: 2021.3.1f1

Quick install​

For the Quick Start, you can download Asylum Unity SDK example and run it in Play Mode. Example project includes all necessary plugins assets.

  1. Download Unity version 2021.3.1f1 and Unity Hub. After running Unity Hub, locate just installed Unity version 2021.3.1f1.

  2. Clone this repository with submodule

    git clone --recurse-submodules https://gitlab.com/asylum-space/asylum-unity-sdk-example

  3. Open asylum-unity-sdk-example project in Unity

  4. You can test plugin in the Play Mode

tip

If you're not planning to render 3D models delete \AsylumSDK\ScriptableObjectsInstances\GLB3DModelTag.asset and AsylumSDK\Tags\Implemented\GLB3DModelTag.cs from the SDK folder to decrease bundle size

Manual installation in existing Unity project​

  1. Create or open a Unity project (supports version 2021.3.1f1)

  2. Import Newtonsoft Json Unity Package using AssetPackagesImport. This is the dependency for Asylum Unity SDK.

  3. Import UniTask

  4. Resolve 3D models support:

    • Import GLTF plugin if you want to add and test functionality for the 3D model implementation

      info

      You need to follow these steps to use GLTFUtility in the WebGL build

      or

    • Delete \AsylumSDK\ScriptableObjectsInstances\GLB3DModelTag.asset and AsylumSDK\Tags\Implemented\GLB3DModelTag.cs from the SDK folder if you're not planning to render 3D models

  5. Put Asylum Unity SDK inside Unity Assets/Plugins folder

  6. You can test the plugin in Play Mode

Build & Run​

When you're ready to build, select one of the options: