Overview

The following tutorial will guide you through the initial steps of getting your audio from CRIWARE ADX2 to work with CRYENGINE, using the Audio Controls Editor (ACE) and Audio System Controls.

Initial Steps with ADX2 in CRYENGINE

Setting up ADX2 in CRYENGINE

Enable the ADX2 middleware in CRYENGINE's Console by setting the s_ImplName CVar to CryAudioImplAdx2. Alternatively, you may add the following line to your system.cfg or user.cfg file (located in your CRYENGINE project's root folder):

s_ImplName = CryAudioImplAdx2

ADX2 Project and Soundbank Locations

ADX2 specific data is located in the following locations of your CRYENGINE project by default:

• Soundbanks
  <ProjectFolder>\assets\audio\adx2\assets
• ADX2 Project
  <ProjectFolder>\assets\audio\adx2_project

CRYENGINE checks the above folders to locate all ADX2 Controls and CueSheet Binaries, that it then displays in the ACE.

To set a different path for your ADX2 project, select the Edit → Preferences option in the Audio Controls Editor's menu to open the Audio System Preferences dialog. Set the desired path by typing it in the Project Path field, or by using the button.

Audio System Preferences

ADX2 Project and CueSheet Binaries

CueSheet Binaries are the ADX2 equivalent of Soundbanks that are used by other audio middleware. When shipping your game, make sure to include only the CueSheet Binaries in the game's folder as they contain all the data from your ADX2 project.

Verifying the Supported ADX2 Version

CRYENGINE is always updated to support the latest version of ADX2.

To make sure that you're using the correct version of ADX2 with CRYENGINE, open the Audio Controls Editor. The ADX2 version supported by your Engine build is indicated in the header of the ACE window, as shown below.

ACE Editor Header

Creating an Audio Setup for CRYENGINE in ADX2

Creating a Sound Cue in CRI Atom Craft

In Atom Craft (ADX2's Authoring Tool), you can import an audio file into a Cue by dragging and dropping it onto a CueSheet. You could also drag and drop the file into the folder called MaterialRootFolder in the Materials Tree, before dragging and dropping it onto a CueSheet to create a Cue.

The FX/AISAC Window in Atom Craft allows you to adjust various settings for each Cue; this window is found below the Timeline window.

FX/AISAC window

Building CueSheets in Atom Craft

You have to build a CueSheet to integrate a new Cue into your game.

The Cue Sheet Binary which gets created during this build process can be loaded by CRYENGINE. To build a CueSheet:

1. Select the Build → Build Atom CueSheet Binary... option from Atom Craft's main menu. Alternatively, you can use the Ctrl + B shortcut.
2. In the Build Atom CueSheet Binary window that opens, set the target platform under the Targets panel on the left.
3. Select the CueSheets you'd like to build from under the CueSheets panel on the right, and click Build at the bottom-right of the window.

Build Atom CueSheet Binary

Streaming Assets

If you intend to use streaming, select the audio asset you want to stream from the Materials Tree in AtomCraft, and then set Streaming Type to Stream in the Inspector window.

Streaming Type

The ACE should now be able to recognize ADX2 controls and Cue Sheet Binaries. Now that the Atom Craft setup is complete, open the ACE in CRYENGINE by going to Tools → Audio Controls Editor.

Connecting ADX2 Controls to Audio System Controls

ACE

The ACE lists all ADX2 controls contained in your CRI Atom Craft Project, as well as all generated CueSheet Binaries. These Controls and CueSheet Binaries need to be connected to CRYENGINE's Audio System before they can be integrated into your level.

To do so:

1. Create a new Library in the Audio System Controls panel of the ACE;
2. Drag and drop the ADX2 controls into the newly created Library. CRYENGINE will automatically create the corresponding Audio System Controls, naming them after their ADX2 counterparts.

The two kinds of Audio System Controls that can be created are Triggers and Preloads; a Trigger is used to call an ADX2 Cue, while a Preload is used to load ADX2 CueSheet Binaries (that contain all data related to a Cue) to memory.

Placing an Audio Trigger in the Game

In order to hear a created audio Trigger in-game it needs to be connected to an audio Entity placed within your level, such that the Entity executes the audio Trigger during gameplay.

For each level, it is recommended that you create a dedicated layer in the Level Explorer for all your audio data.

1. Open the Level Explorer using the Tools → Level Editor → Level Explorer option from the Editor's Main Menu.
2. Select the File → New Layer option from the Level Explorer's menu to create a new layer. Double-click the layer to set it as the active.

When a layer is set as the active layer (highlighted in blue), all Entities that you place within your level will automatically be included under this layer.

Active layer

Next, open the Create Object tool (Tools → Level Editor → Create Object) and select the Audio → Audio Trigger Spot Entity. Place this Entity in your level.

Audio Trigger Spot

Once the Audio Trigger Spot Entity has been placed, navigate to the Play Trigger Name field in the Editor's Properties panel. Click the button next to this field and select your created Trigger from the Select Audio System Control window that opens; your created Trigger should now play as soon as the Audio Trigger Spot Entity is enabled.

Placed Audio Trigger Spot