ENGAGE SDK project folders

The ENGAGE SDK project includes folders where you add your assets, folders that include example assets, and folders that include resources that you must not modify.

Add your assets to the folders described in the following table:

Folder pathPurpose

/Assets/--IFX-Bundles-Desktop_And_Android

Add your IFX prefabs in subfolders in this folder. If you want to create additional subfolders, use the same naming convention. E.g., ifx-groupname-2.

The ifx-groupname-1 folder contains five dummy IFX. These are empty game objects that you can overwrite to test your IFX.

/Assets/--Scenes-Bundles-Desktop_And_Android

Add your locations in this folder. Each location is a Unity scene. The groupname-scene-temp-1 folder contains an example scene. You can use this scene as the starting point for your locations. Create a new folder for each scene. Use your group name as the prefix for each folder.

Assets/Dependencies_IFX/Dependency_Folders

Add any assets that your IFX are dependent upon in this folder. For example, materials, meshes, and images.

Assets/Dependencies_Scenes/Dependency_Folders

Add any assets that your locations are dependent upon in this folder. For example, materials, meshes, and images.

The folders described in the following table include assets that you can use. However, other than scripts, don't use any of these assets directly. Duplicate an asset before you use it, and then move the duplicate to the appropriate dependency folder.

Don't modify any scripts. The scripts that are included in the ENGAGE SDK are solely for the purpose of setting parameters and mapping events to methods. Any local changes that you make to scripts will not appear in the ENGAGE app.

Folder pathPurpose

/Assets/ENGAGE_CreatorSDK/ExampleSceneAssets

Assets that are included in the example scene. If you accidentally delete an asset from the example scene, you can re-add it from this folder.

/Assets/ENGAGE_CreatorSDK/IFX_OPTIONS

Multiple subfolders of scripts that you can use to add functionality to your IFX.

/Assets/ENGAGE_CreatorSDK/Prefabs/Tools

A collection of commonly used objects and interactive elements that you can add to a location. Important: If you want to use a prefab, create a duplicate, and then add it to the appropriate dependency folder.

/Assets/ENGAGE_CreatorSDK/Scenes

A copy of the example scene that is included in your /Assets/--Scenes-Bundles-Desktop_And_Android folder. Important: We recommend that you don't modify this scene. After you open the scene, immediately save the scene with a different name in your scene bundles folder.

/Assets/ENGAGE_CreatorSDK/Scripts

Multiple subfolders of scripts that you can use to add advanced functionality to IFX and locations.

Don't use or modify the assets in any folders other than those described in the previous tables.

Last updated