diff --git a/website/docs/project_settings/assets/nuke_workfile_builder_create_first_workfile.png b/website/docs/project_settings/assets/nuke_workfile_builder_create_first_workfile.png new file mode 100644 index 0000000000..f138709a7f Binary files /dev/null and b/website/docs/project_settings/assets/nuke_workfile_builder_create_first_workfile.png differ diff --git a/website/docs/project_settings/assets/nuke_workfile_builder_location.png b/website/docs/project_settings/assets/nuke_workfile_builder_location.png new file mode 100644 index 0000000000..916b79755d Binary files /dev/null and b/website/docs/project_settings/assets/nuke_workfile_builder_location.png differ diff --git a/website/docs/project_settings/assets/nuke_workfile_builder_profiles.png b/website/docs/project_settings/assets/nuke_workfile_builder_profiles.png new file mode 100644 index 0000000000..e4105767ef Binary files /dev/null and b/website/docs/project_settings/assets/nuke_workfile_builder_profiles.png differ diff --git a/website/docs/project_settings/assets/nuke_workfile_builder_template_anatomy.png b/website/docs/project_settings/assets/nuke_workfile_builder_template_anatomy.png new file mode 100644 index 0000000000..195e884bfb Binary files /dev/null and b/website/docs/project_settings/assets/nuke_workfile_builder_template_anatomy.png differ diff --git a/website/docs/project_settings/assets/nuke_workfile_builder_template_task_type.png b/website/docs/project_settings/assets/nuke_workfile_builder_template_task_type.png new file mode 100644 index 0000000000..4c84f37c0e Binary files /dev/null and b/website/docs/project_settings/assets/nuke_workfile_builder_template_task_type.png differ diff --git a/website/docs/project_settings/assets/nuke_workfile_options_builder_profiles.png b/website/docs/project_settings/assets/nuke_workfile_options_builder_profiles.png deleted file mode 100644 index 3813554b6e..0000000000 Binary files a/website/docs/project_settings/assets/nuke_workfile_options_builder_profiles.png and /dev/null differ diff --git a/website/docs/project_settings/assets/nuke_workfile_options_create_first_version.png b/website/docs/project_settings/assets/nuke_workfile_options_create_first_version.png deleted file mode 100644 index 024352d00b..0000000000 Binary files a/website/docs/project_settings/assets/nuke_workfile_options_create_first_version.png and /dev/null differ diff --git a/website/docs/project_settings/assets/nuke_workfile_options_location.png b/website/docs/project_settings/assets/nuke_workfile_options_location.png deleted file mode 100644 index 9c7c9b644c..0000000000 Binary files a/website/docs/project_settings/assets/nuke_workfile_options_location.png and /dev/null differ diff --git a/website/docs/project_settings/settings_project_nuke.md b/website/docs/project_settings/settings_project_nuke.md index ffdeb1e265..561311317f 100644 --- a/website/docs/project_settings/settings_project_nuke.md +++ b/website/docs/project_settings/settings_project_nuke.md @@ -13,36 +13,45 @@ Project settings can have project specific values. Each new project is using stu Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orage colour). Any changes in default project may affect all existing projects. ::: -## Workfile Options +## Workfile Builder -All workfile related settings can be found here. This is a list of available features: -- Create First Version -- Add Custom Template Path -- Use Builder Profiles At Start +All Workfile Builder related settings can be found here. This is a list of available features: +- Create first workfile +- Custom Template path (task type filtered) +- Run Builder profiles at first run - Define Builder Profiles With Filters -![nuke_workfile_options_location](assets/nuke_workfile_options_location.png) +![nuke_workfile_options_location](assets/nuke_workfile_builder_location.png) :::important Auto Load Last Version In case you want to set the auto load of the latest available version of workfiles, you can do it from [here](settings_project_global#open-last-workfile-at-launch). ::: -### Create First Version +### Create first workfile -By switchintg this featore on, OpenPype will generate first version. Following attributes are possible to configure: +By switchintg this feature on, OpenPype will generate initial workfile version. Following attributes are possible to configure: -![nuke_workfile_options_create_first_version](assets/nuke_workfile_options_create_first_version.png) +![nuke_workfile_options_create_first_version](assets/nuke_workfile_builder_create_first_workfile.png) -#### Use buildin template (if available) -Not applycable in Nuke and can be ignored +#### Custom templates +Custom templates are added into nuke's node graph as nodes. List of task types can be defined for templates filtering. -#### Custom template path -Any path to nukescript. Nodes inside the script will be added into node graph at build time. +- Task types are sourced from project related Anatomy/Task Types -#### Use Builder profiles at start -Enabling this feature will look into available Builder Prorfiles (look bellow for more informations about this feature) and load available versions into node graph. +![nuke_workfile_builder_template_task_type](assets/nuke_workfile_builder_template_task_type.png) -### Builder Profiles + - multi platform path can be used in a variety of ways. Along the absolut path to a template file also an python formating could be used. At the moment these keys are supported (image example bellow): + - `root[key]`: definitions from anatomy roots + - `project[name, code]`: project in context + - `asset`: name of asset/shot in context + - `task[type, name, short_name]`: as they are defined on asset/shot and in **Anatomy/Task Type** on project context + +![nuke_workfile_builder_template_anatomy](assets/nuke_workfile_builder_template_anatomy.png) + +#### Run Builder profiles on first launch +Enabling this feature will look into available Builder's Prorfiles (look bellow for more informations about this feature) and load available versions into node graph. + +### Profiles (Builder) Builder profiles are set of rules allowing artist Load any available versions for the context of the asset, which it is run from. Preset is having following attributes: - **Filter**: Each profile could be defined with task filter. In case no filter is defined, a profile will be working for all. @@ -51,4 +60,4 @@ Builder profiles are set of rules allowing artist Load any available versions fo - **Linked Assets/Shots**: filters for asset builds to be added -![nuke_workfile_options_builder_profiles](assets/nuke_workfile_options_builder_profiles.png) +![nuke_workfile_builder_profiles](assets/nuke_workfile_builder_profiles.png)