🧰
Developer
  • ENGAGE SDK overview
  • Setting up the ENGAGE SDK
    • Registering as an ENGAGE developer
    • Setting up your local git repository
    • Installing the Unity Editor
    • Opening the ENGAGE SDK Unity project
    • Checking for SDK updates
    • Installing a platform build module
  • ENGAGE SDK project folders
  • General guidelines for 3D models
    • Optimizing 3D models
  • Locations
    • Guidelines for locations
    • Creating a new location
    • Building a location bundle
    • Testing a location locally on Windows
    • Configuring an object as a teleport target
    • Configuring the start position
    • Seats
      • Creating a seat
      • Using the summon to seat system
    • Network states
      • Network State Manager
      • Location Network States
      • Example network state configurations
        • Network state toggle object
        • Network state animation start/stop
        • Network state change animation
          • Creating an animation in Unity
          • Using Animator.Play(string)
          • Defining Animator transitions
          • Using Animator.SetTrigger(string)
        • Network state sync animation
        • Network state position toggle
        • Network state automatic door
        • Network state toggle skybox
        • Network state change materials
    • Adding grabable objects to a location
      • Resetting network objects with a button
      • Resetting network objects when out of bounds
    • Locations reference information
      • Basic requirements for a location
  • Immersive Effects (IFX)
    • Guidelines for IFX
    • Creating an IFX
    • Building an IFX bundle
    • Testing IFX locally on Windows
    • Specialized IFX
      • Animated IFX
        • Animation overrides
          • Legacy animations
          • Animator animations
          • Configuring additional Effect Life Run Control properties
      • Audio IFX
      • Interactive IFX
  • List of available prefabs
  • Available scripts
    • External Video Player
  • Profiling
  • Publishing to ENGAGE
    • Publishing checklists
    • Pushing files to your GitHub repository
  • AFX
    • Getting started
      • Changelog
    • AFX Graphs
      • Creating an AFX graph
      • Editing an AFX graph
      • Navigation and keyboard shortcuts
      • Adding an AFX graph to a game object
      • Nodes
      • Ports
      • Connections
      • Flows
        • Starting a flow
        • Using multiple flows
        • Chaining flows
        • Controlling flows
      • References
      • Using AFX Events
    • Networking AFX
      • Network State Modules
      • Ownership of networked objects
    • Animation curves
    • Node dictionary
      • ENGAGE
        • AFX Companion
          • Constant Collision
          • Grab Object
          • PathData
        • Networking
          • Network State Modules
        • Physics
        • Player
        • Seat
      • Events
        • Collision
        • Unity
        • AFX Events
      • Flow
      • Reference
      • Unity
        • Component
          • Animation
            • Set Parameters
          • Audio
            • Audio Reverb Zone
            • Audio Source
          • Collider
          • FX
          • Rendering
            • Camera
            • Light
            • Material
          • UI
        • Constraint
        • GameObject
        • Input
        • Physics
          • Raycast
            • Layer Mask
          • RigidBody
            • Joint
              • Hinge
              • Spring
          • Wheel Collider
        • Time
        • Transform
          • Get
          • Set
          • Space Switching
      • Variable
        • Bool
        • Comparison
        • Float
        • Int
        • List
        • Math
          • MathF
        • String
        • Unity Component
        • Vector
          • Quaternion
          • Vector2
          • Vector 3
            • Vector3 Math
    • Sample graphs
Powered by GitBook
On this page
  • 1. Select your IFX folder
  • 2. Run the bundle tool
  • Troubleshooting
  1. Immersive Effects (IFX)

Building an IFX bundle

PreviousCreating an IFXNextTesting IFX locally on Windows

Last updated 1 year ago

1. Select your IFX folder

You must first select the folder that contains the IFX that you want to include in the bundle. How you select the IFX folder depends on whether your Project window is set to a one column or two column layout.

  • If your Project window is set to a one column layout, select your IFX folder.

  • If your Project window is set to a two column layout, select the /Assets/--IFX-Bundles-Desktop_And_Android/ folder in the left column, and your IFX folder in the right column.

2. Run the bundle tool

  1. From the Creator SDK menu, select Asset Tools > Bundle Builder.

  2. In the Engage Bundle Builder window, expand the Building for section, and then select the check box for each platform that you want to build the IFX bundle for.

  3. Choose one of the following options:

    • Select the Batch Build Mode checkbox to allow you to continue to work on the project in Unity, but at the expense of additional disk space.

    • Clear the Batch Build Mode checkbox to use less disk space, but you will not be able to work on the project until after the build process completes.

  4. Select Build Bundles.

The bundles are built and saved to the AssetBundles subfolder of your local SDK repository folder.

The time required to build a collection of IFX reduces significantly after the first build.

Troubleshooting

If, when you run the bundle tool, the warning shown below appears, you have not selected the IFX folder. If your Project windows is set to a two column layout, select the /Assets/--IFX-Bundles-Desktop_And_Android/ folder in the left column, and your IFX folder in the right column. If your Project windows is set to a one column layout, select your IFX folder.

If, when you run the bundle tool, a warning similar to that shown below appears, you need to install the appropriate platform build module. For more information, see Installing a platform build module.

Selecting the IFX folder in a one column layout
Selecting the IFX folder in a two column layout
Warning when you have not correctly selected the IFX folder
Warning when you don't have the required build support module installed