Skip to content

Commit

Permalink
Merge pull request #290 from ynput/add_info_for_template_format_for_s…
Browse files Browse the repository at this point in the history
…etting_asset_directories_in_unreal_docs

add template format info for asset directories setting in unreal docs
  • Loading branch information
moonyuet authored Oct 21, 2024
2 parents 9b78eb4 + f23c8d5 commit 753fc3c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions website/docs/addon_unreal_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,21 @@ The AYON menu will be the main tool to interact with AYON in Unreal. It will all
The structure of the project data is handled by AYON. The first time you create an instance or load an asset, AYON will create a folder called `AYON` in the Content Browser. This folder will contain all the data handled by AYON, and it is organised as follows:
- `/Content/AYON/` is the default AYON root directory.
- `/Content/AYON/{your_folder_path}/{your_product_name}` is the default directory which contains all the single assets that are loaded from AYON. Users can customize their asset directories through `ayon+settings://unreal/loaded_asset_dir`
By default, the asset directories for all loaded assets are `{folder[path]}/{product[name]}_{version[version]}`

![Unreal AYON Asset Directories Setting](assets/unreal_ayon_asset_directory_setting.png)

::: note
There are several formats we can use as the template for the asset directories.
For example:
{folder[name]}: folder name
{folder[path]}: folder path
{product[name]}: product name
{product{productType}}: product type
{version[version]}: version number
{representation[name]}: name of the representation type
:::

- `/Content/AYON/Assets` contains all the single assets that are loaded from AYON.
- `/Content/AYON/PublishInstances` contains all the instances that are created in Unreal.
- The rest of the directories contain all shot data of your AYON project, keeping same structure as the AYON project. In particular, they contain the levels and level sequences that are generated when you load Layout and Camera assets via **Load** tool.
Expand Down
Binary file modified website/docs/assets/unreal_ayon_asset_directory_setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 753fc3c

Please sign in to comment.