DOCSEARCHbyAlgolia
Submit Docs

AYON Documentation

website·Indexed 32 days ago

https://docs.ayon.dev/

Technical documentation for AYON, featuring the AYON Workflow system for managing task nodes, event triggers, and publishing representations, as well as the AYON Deadline integration for Unreal Engine 5, including RPC services, job submission, and Movie Pipeline Deadline processing.

Tokens
2.3M
Snippets
12.3K
Records
15.5K
Agent score
64%

What's inside AYON

  1. Overview of AYON Usd Resolver

    The AYON Usd Resolver is a tool that enables the resolution of Ayon URIs and the pinning of files using Pixar's Open USD. It provides two primary capabilities:

    1. URI Resolution: Ensures USD scenes are highly portable by allowing the server to track file storage locations, enabling scenes to be opened with absolute resolved paths regardless of the user's location.
    2. Pinning Support: Optimizes USD performance at render farm scale by using pinned files as a cache for the resolver. This removes the requirement for constant communication with the Ayon Server, preventing the bottlenecks typically associated with URI-based resolvers in large-scale environments.

  2. Overview of AYON Core Addon functionality

    AYON Core serves as the foundational layer for all AYON addons and integrations. It is responsible for the discovery and initialization of other addons and provides the following core capabilities:

    • Acts as the main command line handler for the ayon-launcher application.
    • Provides publishing plugins and base classes for new pipeline integrations.
    • Defines the pipeline API used by other integrations.
    • Provides global hooks, universally available loaders, and launcher actions.
    • Supplies graphical tools for artists and defines AYON QT styling.

  3. Overview of OCIO helper functions for OpenRV

    The ocio API provides utilities to apply OCIO colorspace settings to groups, mimicking the behavior of the ocio_source_setup python file in the OpenColorIO Basic Color Management package. For these functions to work, the OpenColorIO Basic Color Management package must be installed and loaded in RV.

  5. Overview of the AYON React Component Library

    The AYON Component Library is a collection of React components designed for the AYON project. It is primarily used in the ayon-frontend (the React frontend for the Ayon server) and is intended for developers to create consistent and accessible AYON addons.

  7. Overview of AYON Mocha Pro Addon capabilities

    The Mocha Pro Addon integrates BorisFx Mocha Pro with AYON. It provides developers and artists with features to manage Mocha Pro workfiles, load clips, and publish tracking and shape data into the AYON pipeline.

  9. Overview of the AYON DJV Addon

    The AYON DJV Addon provides action plugins to other AYON addons to enable launching DJV. Note that this addon does not include the DJV executables themselves; users must configure the paths to the DJV executables within the addon settings.

  10. Overview of the ayon_resolve pipeline module

    The pipeline module provides basic Avalon integration within ayon_resolve. It is primarily implemented via the ResolveHost class, which inherits from HostBase, IWorkfileHost, ILoadHost, and IPublishHost. This module handles functionality such as installing resolve modules, managing containers, and integrating with Pyblish.

  11. Overview of AYON Timers Manager Addon API

    The AYON Timers Manager Addon provides a unified API for timer management. It is designed to allow developers to easily start and stop timers across multiple different addons within the AYON ecosystem.