Untitled

📰Getting Started | ⭐**Updates |** 📝 Guides | 🔢 API | ❓FAQ

Web Editor Basics
HoloLens
Mobile
Meta Quest
Chapter Series Documentation
Assets
Scripting
Enklu Embedded

Installing Enklu Embedded

Embedding an Experience in Your Unity Scene
API Reference

Scripting Overview
Release Notes

Release Notes
FAQ

FAQ

Privacy Policy
Contact

Enklu Embedded enables Unity Developers to embed Enklu Cloud content within Unity scenes and sync 3D Assets to Enklu Cloud directly from Unity. With Enklu Embedded, Unity Developers enjoy the freedom of Unity and the rapid iteration and real-time synchronization of Enklu Cloud. Enklu Embedded works for all Unity projects, but is specifically optimized to improve workflows for immersive augmented reality developers.

Enklu Embedded is distributed as a Unity Package and can be added to your Unity project with our installer or with Unity's Package Manager.

If your project uses the Unity package available on our guide Exporting Unity Prefabs, remove it before installing the Enklu Embedded packages.

Download the Enklu Package

Import the Package

To make getting started as seamless as possible, we have created an installer that automatically imports the Enklu Embedded package and all its dependencies:

EnkluEmbeddedInstaller.unitypackage

To run the installer, simply drag it into your Unity project or import it from the Asset > Import Package > Custom Package... menu and confirm the two files to import.

Untitled

Simply click Import to continue.

Using the Installer

Once the files have been added to the project, the installer will import the Enklu Embedded package. Please note that the process can take several minutes. It is also possible to run the Enklu > Install Enklu Embedded... menu command.

Untitled

After installation, it is safe to remove the installer. The files are located in the Assets/Enklu/Editor directory. If you keep the installer in your project, it will ensure Enklu Embedded has been imported every time you launch Unity.

In later versions of Unity, it will mention adding a new scoped registry, simply close this window.

Untitled

And you can close out of the Package Manager. You will not need to make any changes to these after import.

Untitled

Now learn how to embed an experience to use Enklu in your project.

Embedding an Experience in Your Unity Scene

Using the Package Manager

[Note: We strongly recommend using the installer instead of the manual setup outlined in this section.]

The Enklu Embedded package can be downloaded from Enklu's package repository using Unity's Package Manager. But first, it's necessary to add an entry to the scopedRegistries section of the package manifest in your project. This makes it possible for the Package Manager to find third-party packages like Enklu Embedded.

{
  "scopedRegistries": [
    {
      "name": "Enklu",
      "url": "<http://nexus.enklu.com/repository/upm/>",
      "scopes": [
        "com.enklu"
      ]
    }
  ]
}
Copy

If your project does not have a package manifest, create one at Packages/manifest.json with the above contents. For more information about scoped registries, see Unity's documentation.

For Unity version 2018.1 and later, the Package Manager is included with the Editor and is accessible via the Window > Package Manager menu command. After editing the package manifest in the previous step, Enklu packages should be available for installation. Find the Enklu Embedded package and click Install.

The package "Enklu Core" will also be available. Enklu Embedded includes it as a dependency, so there is no need to install it manually.

Next: Embedding an Experience in Your Unity Scene

Sidebar Table of Contents

Untitled