Elias Unity Plugin - Installation
Learn how to integrate the Elias Plugin into your Unity project to add interactive adaptive music and sound design for a more immersive gaming experience.
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 delivered as a Unity UPM package, specifically a .tgz file named audio.elias.unity-plugin.tgz.
- Open Unity and import Elias plugin into your Unity project by clicking on the + icon in the Unity Package Manager
- Select Install package from tarball…
- Select the path found in step 1.
3: Install Plugin Samples (Optional)
- Once the plugin is installed, you can also install plugin samples too see 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 > Player > Other settings > Configuration > Active Input Handling*
- Set Active Input Handdling* to : Both (make sure the scene is not running)
4: Build Plugin Samples 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.
- Go to Tools > Elias footstep Demo > Set up addressables for DLC
- Then got Samples > Elias Unity plugin > 4.5.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.
5: 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.
6: 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.