Download and Install sample

1: Download the Elias Unity Plugin:

• Make sure to have Elias Studio installed. How to Install Elias
• You can find the plugin via the Open extras folder in Elias Studio. 
• Open Elias Studio and navigate to File > Open extras folder.
• Open Integrations > Unity Plugin and you will find the location of the plugin package. 

2: Import the Plugin:

• The plugin is a Unity UPM package, specifically a .tgz file (tarball) named audio.elias.unity-plugin.tgz.
• Open Unity and import Elias plugin into your Unity project via Package Manager 
• Package manager can be found here: Window > Package Management > Package Manager
• Install Elias Unity Plugin via the + icon in the Unity Package Manager 
• Select Install package from tarball…and locate the path found in step 1. 

3: Connect Unity project to an Elias project

• ASSET: Elias Asset Context
• The first thing to do is to create an Elias Asset Context. 
• Asset contexts are used to connect to an Elias project (and for grouping addressable assets into bundles).
• Create the Asset Context in Asset root folder. Right-click: Create > Elias > Asset context
• In the inspector. Click “browse” to link Elias Asset Context to your Elias Project (created in Elias studio)
• After you have created an Elias Asset Context, it's possible to add different Elias Components
   
• Component: Session
• Session is the main component used to organize other Elias components.
• It's a container for Elias Listener and Elias Sound Instances.
• Select an object (for example the player) to add the session, and in the inspector, click “Add Component”
• Filter on “Elias” to find the session component.
   
• Component: Listener
• In each Session you need a Listener.
• Select an object located under a session (for example the player camera), and in the inspector, click “Add Component”
• Filter on “Elias” to find the Listener component.
   
• Component: Sound Instance
• A sound instance is associated with a Patch (or patch config) created in Elias Studio.
• A patch is used to play sound effects or to control music playback, and events is controlled via parameters.
• Select an object located under a session (for example the player body), and in the inspector, click “Add Component”
• Filter on “Elias” to find the Sound Instance component, and connect to a patch asset created in Elias.
• You can open the patch in Elias Studio, and change data in real time to hear the difference while the game is running.
   
• Component: Zon Instance
• This is used for spatialization within a volume in your scene.
• A zone instance is associated with a zone asset in the Elias project.
• Select an object where you want the zone to be added, and in the inspector, click “Add Component”
• Filter on “Elias” to find the Zon Instance component, and connect it to a zone asset created in Elias.

4: Elias Demo: Install samples (Optional)

• Once the plugin is installed, you can also install plugin samples too see a simple Elias Demo and how Elias is set up.
• Open Package Manager, and select Elias Unity Plugin. 
• Then go to the Samples tab in the right panel of the plug in.
• Import an Elias demo sample to see how things are setup.
• Once imported, you should be able to run the scene without any additional setup.
• NB: If you are using Unity above 6.0, you might have to update Player settings for it to work:
  • Go to Edit > Project Settings > Player > Other settings > Configuration > Active Input Handling* 
  • Set Active Input Handdling* to : Both (make sure the scene is not running) 

5: Elias Demo: Build with DLC support (Optional)

• To Build Elias footstep demo, you must first run a script that sets up addressables, since this is included in the demo. 
• Addressables are used for DLC, which will allow you to add additional content after a release, including content related to Elias.
• If you are not familiar with how to set up addressables, this can be done automatically for the demo sample, via a script.
• In Unity Main menu, there should be a new Menu item called Tools that is used to set up addressables.
• Click on Tools > Elias footstep Demo > Set up addressables for DLC
  • Then goto Samples > Elias Unity plugin > 4.X.0 > Elias footstep Demo > DLC > AddressableAssetGroups > FSD DLC
  • In the inspector set Content Packing & Loading > Build & Load Paths to Local
  • Select the EliasFootstepDemo scene and build
• The EliasFootstepDemo now includes a DLC feature, that can be turned on and off, via “i” on the keyboard when running the scene. 

6: Version Compatibility:

• Ensure that your organization is using a single version of Elias for your project. 
• The version of Elias Studio and the Unity Plugin should come from the same installation on your local machine, and everyone in the team should use the same installer file to avoid version mismatch issues.  

7: Platform Compatibility:

• Windows (x64 only)
• macOS (arm64 and x64)
• iOS (arm64 with simulator support for both arm64 and x64)
• Android (arm64, armv7, and x64)

Live Editing:

• While working in the Unity Editor, you can connect to the Elias project using Elias Studio. 
• Open the Elias Studio application, select the remote session from the start screen, and you can live edit your audio project.
• Changes will take effect immediately in the playback if you are in play mode in Unity.