Working with Zbrush in AYON

Last updated About 1 month ago

Integration Overview

The Zbrush AYON integration lets you:

  • Manage workfiles with in AYON pipeline.

  • Easily export your models as versioned publishes for others to load and update.

Quick Start

Launching Zbrush

Locate AYON Icon in the OS tray (if hidden dive in the tray toolbar).

If you cannot locate the AYON icon, then AYON launcher maybe not probably running so check Getting Started with AYON Pipeline.

By clicking the icon AYON Menu rolls out.

Choose AYON Menu > Launcher to open the Launcher window.

When opened you can choose the project to work in from the list.

Then choose the particular asset you want to work on then choose task and finally run zbrush by its icon in the tools.

The list of available projects, assets, tasks and tools will differ according to your Studio and need to be set in advance by supervisor/admin.

Working in Zbrush​

If Zbrush has been launched via AYON Launcher there should be AYON Menu visible in Zbrush top header after start.

The AYON Menu is moveable which allows user to drag it to the right corner.

User should use this menu exclusively for Opening/Saving when dealing with work files not standard File Tool even though user still being able perform file operations via this menu but preferably just performing quick saves during work session not saving actual workfile versions.

The AYON Menu is moveable which allows user to drag it.

Working With Scene Files​

In AYON menu first go to Work Files menu item so Work Files Window shows up.

Here you can perform Save / Load actions as you would normally do with Save As and Open in the Zbrush File Tool and navigate to different project components like assets, tasks, workfiles etc.

You first choose particular asset and assigned task and corresponding workfile you would like to open.

If not any workfile present simply hit Save As and keep Subversion empty and hit Ok.

AYON correctly names it and add version to the workfile. This basically happens whenever user trigger Save As action. Resulting into incremental version numbers like:

  • workfileName_v001

  • workfileName_v002

Basically meaning user is free of guessing what is the correct naming and other necessities to keep everything in order and managed.

Understanding Context​

As seen on our example AYON created pretty first workfile and named it il_modelCreature_head_v002.zpr meaning it sits in the Project il being it modelCreature folder path and workfile being head task and obviously v002 telling user its first existing version of this workfile.

It is good to be aware that whenever you as a user choose folder path and task you happen to be in so called context meaning that all user actions are in relation with particular folder path. This could be quickly seen in host application header and AYON Menu and its accompanying tools.

Whenever you choose different folder path and its task in Work Files window you are basically changing context to the current asset/task you have chosen.

This concludes the basics of working with workfiles in Zbrush using AYON and its tools. Following chapters will cover other aspects like creating multiple folder paths and their publishing for later usage in the production.

AYON-Managed Zbrush Workfiles

AYON identifies managed Zbrush workfiles by adding metadata to your work directory. When you launch Zbrush with AYON for the first time, it creates a .zbrushmetadata folder to store all AYON-related data.
Inside this metadata folder, you'll find several subfolders: containers, create-context, instances, and context.

  • containers: This folder holds the container data where users load meshes in Zbrush.

  • create-context: This folder stores the settings data users preset when creating instances in Zbrush.

  • instances: This folder contains the instance data for publishing instances in Zbrush.

  • context: This folder includes important project information, such as the project name, folder path, and task name.

❗❗❗ Please do not remove the .zbrushmetadata folder while working on the project. If it is removed, all AYON data will be lost.

❗❗❗ Always use the workfile tool. AYON-related data is only relevant when users open and save the .zpr file using the workfile tool in Zbrush. If users manually use the Save As and Open options from the File tool in Zbrush, the AYON data will not be saved or stored correctly in the .zbrushmetadata folder.

Before users save the workfile, the containers, create_context, instances, and context are stored as temporary data in the metadata folder. Once users save the workfile with versions, all this data is moved from .zbrushmetadata to .zbrushmetadata/{YOUR_CURRENT_WORKFILE_NAME}.

When the workfile is versioned up (e.g., automatically when publishing or by saving a new version via the workfiles tool), the metadata is copied from .zbrushmetadata/{YOUR_PREVIOUS_WORKFILE_NAME} to .zbrushmetadata/{YOUR_CURRENT_WORKFILE_NAME}.

Publishing Overview

Publishing in AYON is done via using Creator / Publisher tool.

Before proceeding further please check AYON Glossary and About AYON Pipline So you have clear idea about terminology.

Supported Product Types for Publishing

Workfile

The Workfile is a built-in, ready-to-publish product type. When enabled in the publisher, it captures the current state of your workfile and publishes it as a workfile product.

This is useful for debugging purposes or to continue your work from that exact point.

Model

Model product type can be a mesh outputted as either ABC, FBX or OBJ format, depending on what users choose as export output.

Go AYON -> Create and select Model.

Make sure to select your geometry in the subtool menu before Publish.Users can also choose subdivision level before the export.
The subdivision level is set to 0 by default, which asks Zbrush to export the mesh in the current subdivision level.

Loading Overview

Loading is done via the Loader tool, which lets you load products published from other DCCs within the AYON Pipeline.

You can access the loader tools through AYON -> Load. Then, select the product, set the version using the drop-down menu, and choose the loader action you’d like to use.

Supported Product Types for Loading

Model

You can load model products via Mesh Loader action in the loader tool.

It supports loading formats such as ABC, FBX, OBJ and MA.

AYON Zbrush Addon Settings

Stop Timer on Application Exit

Setting Location: ayon+settings://zbrush/stop_timer_on_application_exit

When enabled it stops the timer related to timers manager.

It only works if you have Timers Manager Addon installed.