Unreal Addon Settings

Last updated 5 days ago

Color Management (ImageIO)

Configure color settings for Unreal projects with the ability to override global color management settings. For more details, check Host-specific overrides.

Enable Color Management

Setting Location: ayon+settings://unreal/imageio/activate_host_color_management

This toggle activates AYON's global color management, serving as a master switch to enable or disable the entire section.

OCIO Config

Setting Location: ayon+settings://unreal/imageio/ocio_config

This setting should be deprecated in favor of OCIO config profiles in core addon settings.

  • ayon+settings://core/imageio/ocio_config_profiles

  • Override global OCIO config

  • Config Path

File Rules

Setting Location: ayon+settings://unreal/imageio/file_rules/rules

  • Activate Host Rules

  • Rules

    • +: Add more rules

    • Each rule consists of

      • Rule name

      • Regex pattern

      • Colorspace name

      • File extension

Prelaunch Settings

Setting Location: ayon+settings://unreal/prelaunch_settings

  • Use Offline Package Source: Install packages from a local folder or URL instead of downloading from the internet.

  • Offline Package Source Path: Path to a local folder or URL containing the required package files (e.g., .whl, .tar.gz).

  • Install Dependencies to Launcher Cache Path: Use a dedicated folder in AYON launcher cache folder AYON_LAUNCHER_LOCAL_DIR as the target install location for dependencies, and add it to Unreal’s Python path. This avoids modifying the system, engine, or user-specific Python environments.

Import Settings

Setting Location: ayon+settings://unreal/import_settings

General Settings

  • Asset Directories for Loaded Assets: Define the root path template for storing loaded assets, Find a list of available template keys here.
    Note that the product extension is always appended as a suffix to the template.

    For example, a product named modelMain published to the AYON folder path assets/characters/robot will, upon loading, reside in /All/Game/Ayon/assets/characters/robot/modelMain_v002_abc.

  • Use Nanite: Enable Nanite for importing. Disable this option when using the interchange framework.

  • Show Import Dialog: Display the import options dialog during the import process.

Load Alembic Settings

This section applies to all Alembic loaders:

  • Import Alembic Pointcache

  • Import Alembic Static Mesh

  • Import Alembic Skeletal Mesh

  • Import Alembic Animation

Alembic Conversion Setting Presets: Choose a default preset to ensure proper UV and transform conversion for loaded Alembic files.

Load Layout Settings

This section applies to all layout loaders:

  • Load Layout

  • Load Layout on Existing Scene

  • Directories for loaded layouts: Specify directories to store loaded layouts. Supports the following template keys.

  • Generate level sequences when loading layouts: Automatically create level sequences during layout loading.

  • Enable user override layout representation: Allow users to override layout products.

  • Override layout representation by: Select how users can override layout products.

  • Remove loaded assets when deleting layouts: Automatically remove assets linked to layouts when deleting them.

  • Delete assets that are not matched: When enabled, this option resets and updates the layout while deleting all unmatched assets when users select the "Load Layout on Existing Scene" operation in the loader UI.

Render Setup

Setting Location: ayon+settings://unreal/render_setup

  • Render Queue Path: Path to Render Queue UAsset for local and farm rendering.

  • Render Config Path: Path to Render Configuration UAsset for local and farm rendering.

  • Pre-roll frames: The number of frames Unreal uses to initialize the scene before the sequencer starts playing.

  • Render Format: Choose file format for rendered images from a drop-down menu.

Project Setup

Setting Locaiton: ayon+settings://unreal/project_setup

  • Allow project creation: Whether to create a new project when none is found. Disable when using external source control (Perforce).

  • Dev mode: When enabled, AYON will set the Unreal Project Type to C++ during creation.

    This requires Visual Studio and other necessary tools to be properly configured.
    Additionally, it will be enabled by default if the Engine/Binaries directory is missing in the Unreal Engine installation path.