diff --git a/website/docs/admin_settings_system.md b/website/docs/admin_settings_system.md index 1f7eb029ba..80154356af 100644 --- a/website/docs/admin_settings_system.md +++ b/website/docs/admin_settings_system.md @@ -96,17 +96,20 @@ Module that allows storing all logging into the database for easier retrieval an ## Applications In this section you can manage what Applications are available to your studio, locations of their -executables and their additional environments. +executables and their additional environments. In OpenPype context each application that is integrated is +also called a `Host` and these two terms might be used interchangeably in the documentation. -Each DCC is made of two levels. +Each Host is made of two levels. 1. **Application group** - This is the main name of the application and you can define extra environments -that are applicable to all version of the give application. For example any extra Maya scripts that are not +that are applicable to all versions of the given application. For example any extra Maya scripts that are not version dependant, can be added to `Maya` environment here. 2. **Application versions** - Here you can define executables (per platform) for each supported version of the DCC and any default arguments (`--nukex` for instance). You can also further extend it's environment. ![settings_applications](assets/settings/applications_01.png) +### Environments + Please keep in mind that the environments are not additive by default, so if you are extending variables like `PYTHONPATH`, or `PATH` make sure that you add themselves to the end of the list. @@ -121,8 +124,15 @@ For instance: } ``` +### Adding versions +It is possible to add new version for any supported application. There are two ways of doing it. +1. **Add new executable** to an existing application version. This is a good way if you have multiple fully compatible versions of your DCC across the studio. Nuke is a typical example where multiple artists might have different `v#` releases of the same minor Nuke release. For example `12.2v3` and `12.3v6`. When you add both to `12.2` Nuke executables they will be treated the same in OpenPype and the system will automatically pick the first that it finds on an artist machine when launching. Their order is also the order of their priority when choosing which version to run if multiple are present. +![settings_applications](assets/settings/settings_addapplication.gif) + +2. **Add version** in case you want this version to be selectable individually. This is usually used for bigger releases that might not be fully compatible with previous versions. Keep in mind that if you add the latest version of an Application that is not yet part of the official OpenPype release, you might run into problems with integration. We test all the new software versions for compatibility and most often, smaller or bigger updates to OpenPype code are necessary to keep everything running. +![settings_applications](assets/settings/settings_addappversion.gif) ## Tools diff --git a/website/docs/assets/settings/applications_01.png b/website/docs/assets/settings/applications_01.png index 52c31f6649..c82a9e0d0f 100644 Binary files a/website/docs/assets/settings/applications_01.png and b/website/docs/assets/settings/applications_01.png differ diff --git a/website/docs/assets/settings/settings_addapplication.gif b/website/docs/assets/settings/settings_addapplication.gif new file mode 100644 index 0000000000..fa617c7c27 Binary files /dev/null and b/website/docs/assets/settings/settings_addapplication.gif differ diff --git a/website/docs/assets/settings/settings_addappversion.gif b/website/docs/assets/settings/settings_addappversion.gif new file mode 100644 index 0000000000..573dd407b3 Binary files /dev/null and b/website/docs/assets/settings/settings_addappversion.gif differ