Elias Godot Plugin

Elias Context - Adding an Elias project to Godot

To connect an Elias Project with your Godot project, you first need an Elias Context:

• Create a new resource in the root of your Godot Project by right-clicking and selecting New Resource
• Locate the EliasAssetContext resource and click “create”. Either scroll through the list of resources and locate it, or filter on “elias” in the search bar at the top to see it right away.
• Preferably, name the resource elias_context.tres.
• Double-click on the Elias context resource asset to access the settings in the inspector.
• Click the three dots to locate your Elias project. We suggest that you add an “elias” folder to the root folder of your Godot project and add your Elias Project there.
• There is now a connection to the Elias project, and all Elias assets can now be accessed from the different nodes.

Elias Nodes

The Elias nodes can be accessed and used when the plugin has been installed, and an Elias Context with a selected Elias Project needs to be in place to access patches, parameters, etc. from the Elias nodes. The Elias Nodes are added to the scene, and if you filter for Elias, you can easily find the different nodes.

Elias Session

• The session node initiates the Elias project. Select it to set the playback quality, sample rate, buffer size, channel count, and instance limit.
• An Elias session needs to be added for sound instance, listeners, and zones to communicate with the Elias project, and specifically for the currently running session that initiated the Elias project.
• You don’t need to manually select a session in the other Elias nodes; instead, they will look for a running session and work towards it. In the case where more than one Elias Session is running, you can select it specifically on the nodes.

Elias Sound Instance

• All settings are found in the inspector when a sound instance in the scene is selected.
• Sound model - Select the patch to load to the sound instance.
• Keep in mind that the spatialization settings are set in the Elias studio by either using the default setting or overriding it with a spatial asset. Spatial assets are modified with the Spatial Editor Tool found in the Elias Studio.

Elias Listener

• The most common thing is to add the listener to the camera.
• There are no specific settings for this node.

Elias Zones

• Coming soon…

Elias Parameters

Elias Parameters can be set and triggered from a gd script. For example:

• Create a variable called sound_instance that is of the class EliasSoundInstance, like this: 
  • var sound_instance = EliasSoundInstance
• Use the variable sound instance to set the different types of parameters. For example, start to type “sound_instance.” and then scroll through the suggestions to find the type of parameter you want to use. For example, run a pulse that you have named “jump” like this:
  • sound_instance.send_pulse("jump")
• Here are a couple of other examples to set different types of parameters:
  • Send a pulse: sound_instance.send_pulse("jump")
  • Set a boolean parameter called “swimming” to the state true: sound_instance.set_boolean_parameter_value("swimming", true)
  • Set an integer parameter called “Health” to 50: sound_instance.set_int_parameter_value("health", 50)
  • Set an enumeration parameter called material to the enum list item “wood”: sound_instance.set_enum_parameter_value("Material", “wood”)