diff --git a/website/docs/admin_distribute.md b/website/docs/admin_distribute.md
new file mode 100644
index 0000000000..b0ab71e2f3
--- /dev/null
+++ b/website/docs/admin_distribute.md
@@ -0,0 +1,50 @@
+---
+id: admin_distribute
+title: Distribute
+sidebar_label: Distribute
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+To let your artists to use OpenPype, you'll need to distribute the frozen executables to them.
+
+Distribution consists of two parts
+
+ ### 1. OpenPype Igniter
+
+ This is the base application that will be installed locally on each workstation.
+ It is self contained (frozen) software that also includes all of the OpenPype codebase with the version
+ from the time of the build.
+
+ Igniter package is around 500MB and preparing an updated version requires you to re-build pype. That would be
+ inconvenient for regular and quick distribution of production updates and fixes. So you can distribute those
+ independently, without requiring you artists to re-install every time.
+
+ ### 2. OpenPype Codebase
+
+When you upgrade your studio pype deployment to a new version or make any local code changes, you can distribute
+these changes to your artists, without the need of re-building OpenPype, by using `create_zip` tool provided.
+The resulting zip needs to be made available to the artists and it will override their local OpenPype install
+with the updated version.
+
+You have two ways of making this happen
+
+#### Automatic Updates
+
+Everytime and Artist launches OpenPype on their workstation, it will look to a pre-defined
+[openPype update location](#self) for any versions that are newer than the
+latest, locally installed version. If such version is found, it will be downloaded,
+automatically extracted to the correct place and launched. This will become the default
+version to run for the artist, until a higher version is detected in the update location again.
+
+#### Manual Updates
+
+If for some reason you don't want to use the automatic updates, you can distribute your
+zips manually. Your artist will then have to unpack them to the correct place on their disk.
+
+The default locations are:
+
+- Windows: `C:\Users\%USERNAME%\AppData\Local\pypeclub\openpype`
+- Linux: ` `
+- Mac: ` `
diff --git a/website/docs/admin_docsexamples.md b/website/docs/admin_docsexamples.md
index 3c4163aa0c..6b4ae101d3 100644
--- a/website/docs/admin_docsexamples.md
+++ b/website/docs/admin_docsexamples.md
@@ -4,6 +4,75 @@ title: Examples of using notes
sidebar_label: docsexamples
---
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+
+
+
+This is your mac stuff
+
+
+
+
+This is your linux stuff
+
+
+
+
+
+This is your mac stuff
+
+
+
+
+
+
+
+
+
+:::note Name of the category
+
+
+
+
+
+This is your mac stuff
+
+
+
+
+This is your linux stuff
+
+
+
+
+
+This is your mac stuff
+
+
+
+
+:::
+
+
+=========================
+
:::important
- This is my note
diff --git a/website/docs/admin_openpype_commands.md b/website/docs/admin_openpype_commands.md
new file mode 100644
index 0000000000..6e187c3c8a
--- /dev/null
+++ b/website/docs/admin_openpype_commands.md
@@ -0,0 +1,140 @@
+---
+id: admin_openpype_commands
+title: OpenPype Commands Reference
+sidebar_label: OpenPype Commands
+---
+
+
+## `tray`
+
+To launch Tray:
+```sh
+pype tray
+```
+
+### `--debug`
+
+To launch Tray with debugging information:
+```sh
+pype tray --debug
+```
+
+--------------------
+
+
+## `eventserver`
+
+This command launches ftrack event server.
+
+This should be ideally used by system service (such us systemd or upstart
+on linux and window service).
+
+You have to set either proper environment variables to provide URL and
+credentials or use option to specify them. If you use `--store_credentials`
+provided credentials will be stored for later use.
+
+To run ftrack event server:
+```sh
+pype eventserver --ftrack-url= --ftrack-user= --ftrack-api-key= --ftrack-events-path= --no-stored-credentials --store-credentials
+```
+
+
+### `--debug`
+- print debug info
+
+### `--ftrack-url`
+- URL to ftrack server
+
+### `--ftrack-user`
+- user name to log in to ftrack
+
+### `--ftrack-api-key`
+- ftrack api key
+
+### `--ftrack-events-path`
+- path to event server plugins
+
+### `--no-stored-credentials`
+- will use credential specified with options above
+
+### `--store-credentials`
+- will store credentials to file for later use
+
+--------------------
+
+## `launch`
+
+Launch application in Pype environment.
+
+### `--app`
+
+Application name - this should be the same as it's [defining toml](admin_hosts#launchers) file (without .toml)
+
+### `--project`
+Project name
+
+### `--asset`
+Asset name
+
+### `--task`
+Task name
+
+### `--tools`
+*Optional: Additional tools environment files to add*
+
+### `--user`
+*Optional: User on behalf to run*
+
+### `--ftrack-server` / `-fs`
+*Optional: Ftrack server URL*
+
+### `--ftrack-user` / `-fu`
+*Optional: Ftrack user*
+
+### `--ftrack-key` / `-fk`
+*Optional: Ftrack API key*
+
+For example to run Python interactive console in Pype context:
+```sh
+pype launch --app python --project my_project --asset my_asset --task my_task
+```
+
+--------------------
+
+
+## `publish`
+
+Pype takes JSON from provided path and use it to publish data in it.
+```sh
+pype publish
+```
+
+### `--debug`
+- print more verbose infomation
+
+--------------------
+
+## `extractenvironments`
+
+Extract environment variables for entered context to a json file.
+
+Entered output filepath will be created if does not exists.
+
+All context options must be passed otherwise only openpype's global environments will be extracted.
+
+Context options are "project", "asset", "task", "app"
+
+### `output_json_path`
+- Absolute path to the exported json file
+
+### `--project`
+- Project name
+
+### `--asset`
+- Asset name
+
+### `--task`
+- Task name
+
+### `--app`
+- Application name
\ No newline at end of file
diff --git a/website/docs/admin_settings.md b/website/docs/admin_settings.md
new file mode 100644
index 0000000000..0cd10f81dc
--- /dev/null
+++ b/website/docs/admin_settings.md
@@ -0,0 +1,86 @@
+---
+id: admin_settings
+title: Working with settings
+sidebar_label: Working with settings
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+OpenPype stores all of it's settings and configuration in the mongo database. To make the configuration as easy as possible we provide a robust GUI where you can access and change everything that is configurable
+
+**Settings** GUI can be started from the tray menu.
+
+Please keep in mind that these settings are set-up for the full studio and not per-individual. If you're looking for individual artist settings, you can head to
+[Local Settings](#local-settings) section in the artist documentation.
+
+
+## Categories
+
+We use simple colour coding to show you any changes to the settings:
+- **Grey**: [OpenPype default](#openpype-defaults)
+- **Green**: [Studio default](#openpype-defaults)
+- **Orange**: [Project Override](#project-overrides)
+- **Blue**: Changed and unsaved value
+
+You'll find that settings are split into categories:
+
+### [System](admin_settings_system)
+
+System sections contains all settings that can be configured on a studio level, but cannot
+be changed on a per-project basis. These include mostly high level options like path to
+mongo database, toggling major modules on and off and configuring studio wide application
+availability.
+
+### [Project](admin_settings_project)
+
+Project tab contains most of OpenPype settings and all of them can be configured and overriden on a per-project basis if need be. This includes most of the workflow behaviors
+like what formats to export, naming conventions, publishing validations, automatic assets loaders and a lot more.
+
+We recommend to try to keep as many configurations as possible on a studio level and only override selectively, because micromanaging all of the project settings might become cumbersome down the line. Most of the settings can be safely adjusted and locked on a project
+after the production started.
+
+## Understanding Overrides
+
+Most of the individual settings can be set and overriden on multiple levels.
+
+### OpenPype defaults
+When you first open settings all of the values and categories will be marked with a
+light **grey labels** or a **grey vertical bar** on the left edge of the expandable category.
+
+That means, the value has been left at OpenPype Default. If the default changes in future
+OpenPype versions, these values will be reflect the change after you deploy the new version.
+
+### Studio defaults
+
+Any values that you change and then press save in the bottom right corner, will be saved
+as studio defaults. This means they will stay at those values even if you update your pype.
+To make it clear which settings are set by you specifically, they are marked with a **green
+edge** and **green labels**, once set.
+
+To set studio default, just change the value in the system tab and press save. If you want
+to keep the value but add the option to your studio default to protect it from potential
+future updates, you ran `right click` and choose `add to studio default`, then press save.
+
+In the Project settings tab, you need to select the **( Default )** project on the left, to set your studio defaults for projects. The rest works the same as in the System tab.
+
+
+
+You can also reset any settings to OpenPype default by doing `right click` and `remove from studio default`
+
+
+
+### Project Overrides
+
+Many settings are usefull to be adjusted on a per-project basis. To identify project
+overrides, they are marked with **orange edge** and **orange labels** in the settings GUI.
+
+To set project overrides proceed the same way as with the Studio defaults, but first select
+a particular project you want to be configuring on the left hand side of the Project Settings tab.
+
+Here you can see all three overrides at the same time. Deadline has not studio changes at all, Maya has some studio defaults configures and Nuke also contains project specific overrides.
+
+
+Override colours work as breadcrumbs to allow quick identification of what was changed and where. As you can see on this image, Orange colour is propagated up the hierarchy even though only a single value (sync render version with workfile toggle), was changed.
+
+
diff --git a/website/docs/admin_settings_project.md b/website/docs/admin_settings_project.md
new file mode 100644
index 0000000000..a30c0f0082
--- /dev/null
+++ b/website/docs/admin_settings_project.md
@@ -0,0 +1,11 @@
+---
+id: admin_settings_project
+title: Project Settings
+sidebar_label: Project Settings
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+PROJECT Settings
\ No newline at end of file
diff --git a/website/docs/admin_settings_project_anatomy.md b/website/docs/admin_settings_project_anatomy.md
new file mode 100644
index 0000000000..54023d468f
--- /dev/null
+++ b/website/docs/admin_settings_project_anatomy.md
@@ -0,0 +1,106 @@
+---
+id: admin_settings_project_anatomy
+title: Project Anatomy
+sidebar_label: Project Anatomy
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+Project Anatomy is the most important configuration piece for each project you work on with openPype.
+
+It defines:
+- Project Root folders
+- File naming conventions
+- Folder structure templates
+- Default project attributes
+- Task Types
+- Applications and Tool versions
+- Colour Management
+- File Formats
+
+Anatomy is the only configuration that is always saved as project override. This is to make sure, that any updates to OpenPype or Studio default values, don't affect currently running productions.
+
+
+
+## Roots
+
+Roots define where files are stored with path to shared folder. It is required to set root path for each platform you are using in studio. All paths must point to same folder!
+
+
+
+It is possible to set multiple roots when necessary. That may be handy when you need to store specific type of data on another disk.
+
+
+
+Note how multiple roots are used here, to push different types of files to different shared storage.
+
+
+
+## Templates
+
+Templates define project's folder structure and filenames.
+
+We have a few required anatomy templates for OpenPype to work properly, however we keep adding more when needed.
+
+### Available template keys
+
+
+
+
+
+| Context key | Description |
+| --- | --- |
+| `root[name]` | Path to root folder |
+| `project[name]` | Project's full name |
+| `project[code]` | Project's code |
+| `hierarchy` | All hierarchical parents as subfolders |
+| `asset` | Name of asset or shot |
+| `task` | Name of task |
+| `version` | Version number |
+| `subset` | Subset name |
+| `family` | Main family name |
+| `ext` | File extention |
+| `representation` | Representation name |
+| `frame` | Frame number for sequence files. |
+| `output` | |
+| `comment` | |
+
+
+
+
+| Date-Time key | Example result | Description |
+| --- | --- | --- |
+| `d` | 1, 30 | Short day of month |
+| `dd` | 01, 30 | Day of month with 2 digits. |
+| `ddd` | Mon | Shortened week day name. |
+| `dddd` | Monday | Full week day name. |
+| `m` | 1, 12 | Short month number. |
+| `mm` | 01, 12 | Month number with 2 digits. |
+| `mmm` | Jan | Shortened month name. |
+| `mmmm` | January | Full month name. |
+| `yy` | 20 | Shortened year. |
+| `yyyy` | 2020 | Full year. |
+| `H` | 4, 17 | Shortened 24-hour number. |
+| `HH` | 04, 17 | 24-hour number with 2 digits. |
+| `h` | 5 | Shortened 12-hour number. |
+| `hh` | 05 | 12-hour number with 2 digits. |
+| `ht` | AM, PM | Midday part. |
+| `M` | 0 | Shortened minutes number. |
+| `MM` | 00 | Minutes number with 2 digits. |
+| `S` | 0 | Shortened seconds number. |
+| `SS` | 00 | Seconds number with 2 digits. |
+
+
+
+
+
+## Attributes
+
+
+
+## Task Types
+
+
+## Colour Management and Formats
\ No newline at end of file
diff --git a/website/docs/admin_settings_system.md b/website/docs/admin_settings_system.md
new file mode 100644
index 0000000000..0c4a6c863d
--- /dev/null
+++ b/website/docs/admin_settings_system.md
@@ -0,0 +1,132 @@
+---
+id: admin_settings_system
+title: System Settings
+sidebar_label: System settings
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+## Global
+
+Settings applicable to the full studio.
+
+`Studio Name`
+
+`Studio Code`
+
+`Environment`
+
+## Modules
+
+Configuration of OpenPype modules. Some can only be turned on and off, others have
+their own attributes that need to be set, before they become fully functional.
+
+### Avalon
+
+`Avalon Mongo Timeout` - You might need to change this if your mongo connection is a bit slow. Making the
+timeout longer will give Avalon better chance to connect.
+
+`Thumbnail Storage Location` - simple disk storage path, where all thumbnails will be stored.
+
+### Ftrack
+
+`Server` - URL of your ftrack server.
+
+Additional Action paths
+
+`Action paths` - Directories containing your custom ftrack actions.
+
+`Event paths` - Directories containing your custom ftrack event plugins.
+
+`Intent` - Special ftrack attribute that mark the intention of individual publishes. This setting will be reflected
+in publisher as well as ftrack custom attributes
+
+`Custom Attributes` - Write and Read permissions for all OpenPype required ftrack custom attributes. The values should be
+ftrack roles names.
+
+### Sync Server
+
+Disable/Enable OpenPype site sync feature
+
+### Standalone Publisher
+
+Disable/Enable Standalone Publisher option
+
+### Deadline
+
+`Deadline Rest URL` - URL to deadline webservice that. This URL must be reachable from every
+workstation that should be submitting render jobs to deadline via OpenPype.
+
+### Muster
+
+`Muster Rest URL` - URL to Muster webservice that. This URL must be reachable from every
+workstation that should be submitting render jobs to muster via OpenPype.
+
+`templates mapping` - you can customize Muster templates to match your existing setup here.
+
+### Clockify
+
+`Workspace Name` - name of the clockify workspace where you would like to be sending all the timelogs.
+
+### Timers Manager
+
+`Max Idle Time` - Duration (minutes) of inactivity, after which currently running timer will be stopped.
+
+`Dialog popup time` - Time in minutes, before the end of Max Idle ti, when a notification will alert
+the user that their timer is about to be stopped.
+
+### Idle Manager
+
+Service monitoring the activity, which triggers the Timers Manager timeouts.
+
+### Logging
+
+Module that allows storing all logging into the database for easier retrieval and support.
+
+## Applications
+
+In this section you can manage what Applications are available to your studio, locations of their
+executables and their additional environments.
+
+Each DCC 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
+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.
+
+
+
+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.
+
+For instance:
+
+```json
+{
+ "PYTHONPATH": [
+ "my/path/to/python/scripts",
+ "{PYTHONPATH}"
+ ]
+}
+```
+
+
+
+
+## Tools
+
+A tool in openPype is anything that needs to be selectively added to your DCC applications. Most often these are plugins, modules, extensions or similar depending on what your package happens to call it.
+
+OpenPype comes with some major CG renderers pre-configured as an example, but these and any others will need to be changed to match your particular environment.
+
+Their environment settings are split to two levels just like applications to allow more flexibility when setting them up.
+
+In the image before you can see that we set most of the environment variables in the general MTOA level, and only specify the version variable in the individual versions below. Because all environments within pype setting will resolve any cross references, this is enough to get a fully dynamic plugin loading as far as your folder structure where you store the plugins is nicely organized.
+
+
+In this example MTOA will automatically will the `MAYA_VERSION`(which is set by Maya Application environment) and `MTOA_VERSION` into the `MTOA` variable. We then use the `MTOA` to set all the other variables needed for it to function within Maya.
+
+
+All of the tools defined in here can then be assigned to projects. You can also change the tools versions on any project level all the way down to individual asset or shot overrides. So if you just need to upgrade you render plugin for a single shot, while not risking the incompatibilities on the rest of the project, it is possible.
\ No newline at end of file
diff --git a/website/docs/admin_use.md b/website/docs/admin_use.md
new file mode 100644
index 0000000000..376e9397a1
--- /dev/null
+++ b/website/docs/admin_use.md
@@ -0,0 +1,37 @@
+---
+id: admin_use
+title: Install and Run
+sidebar_label: Install & Run
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+## Install
+
+You can install OpenPype on individual workstations the same way as any other software.
+When you create you build, you will end up with an installation package for the platform
+that was used for the build.
+
+- Windows: `OpenPype-3.0.0.msi`
+- Linux: `OpenPype-3.0.0.zip`
+- Mac: `OpenPype-3.0.0.dmg`
+
+After OpenPype is installed, it will ask the user for further installation if it detects a
+newer version in the studio update location.
+
+## Run OpenPype
+
+To use OpenPype on a workstation simply run the executable that was installed.
+On the first run the user will be prompted to for OpenPype Mongo URL.
+This piece of information needs to be provided to the artist by the admin setting
+up OpenPype in the studio.
+
+Once artist enters the Mongo URL address, OpenPype will remember the connection for the
+next launch, so it is a one time process.From that moment OpenPype will do it's best to
+always keep up to date with the latest studio updates.
+
+If the launch was successfull, the artist should see a green OpenPype logo in their
+tray menu. Keep in mind that on Windows this icon might be hidden by default, in which case,
+the artist can simply drag the icon down to the tray.
\ No newline at end of file
diff --git a/website/docs/artist_concepts.md b/website/docs/artist_concepts.md
index cde1a272a1..6046ba6214 100644
--- a/website/docs/artist_concepts.md
+++ b/website/docs/artist_concepts.md
@@ -26,7 +26,7 @@ Each published variant can come out of the software in multiple representations.
### Family
-Each published [subset][3b89d8e0] can have exactly one family assigned to it. Family determines the type of data that the subset holds. Family doesn't dictate the file type, but can enforce certain technical specifications. For example Pype default configuration expects `model` family to only contain geometry without any shaders or joins when it is published.
+Each published [subset][3b89d8e0] can have exactly one family assigned to it. Family determines the type of data that the subset holds. Family doesn't dictate the file type, but can enforce certain technical specifications. For example OpenPype default configuration expects `model` family to only contain geometry without any shaders or joins when it is published.
[3b89d8e0]: #subset "subset"
@@ -35,12 +35,12 @@ Each published [subset][3b89d8e0] can have exactly one family assigned to it. Fa
### Host
-General term for Software or Application supported by Pype and Avalon. These are usually DCC applications like Maya, Houdini or Nuke, but can also be a web based service like Ftrack or Clockify.
+General term for Software or Application supported by OpenPype and Avalon. These are usually DCC applications like Maya, Houdini or Nuke, but can also be a web based service like Ftrack or Clockify.
### Tool
-Small piece of software usually dedicated to a particular purpose. Most of pype and avalon tools have GUI, but some are command line only
+Small piece of software usually dedicated to a particular purpose. Most of OpenPype and Avalon tools have GUI, but some are command line only
### Publish
@@ -49,5 +49,5 @@ Process of exporting data from your work scene to versioned, immutable file that
### Load
-Process of importing previously published subsets into your current scene, using any of the pype tools.
+Process of importing previously published subsets into your current scene, using any of the OpenPype tools.
Loading asset using proper tools will ensure that all your scene content stays version controlled and updatable at a later point
diff --git a/website/docs/artist_ftrack.md b/website/docs/artist_ftrack.md
index 80695d90c8..e42136fa89 100644
--- a/website/docs/artist_ftrack.md
+++ b/website/docs/artist_ftrack.md
@@ -4,10 +4,10 @@ title: Ftrack
sidebar_label: Artist
---
-# How to use Ftrack in Pype
+# How to use Ftrack in OpenPype
-## Login to Ftrack module in Pype tray (best case scenario)
-1. Launch Pype tray if not launched yet
+## Login to Ftrack module in OpenPype tray (best case scenario)
+1. Launch OpenPype tray if not launched yet
2. *Ftrack login* window pop up on start
- or press **login** in **Ftrack menu** to pop up *Ftrack login* window
@@ -26,7 +26,7 @@ sidebar_label: Artist
---
## Application launch (best case scenario)
-1. Make sure Pype tray is running and you passed [Login to Ftrack](#login-to-ftrack-module-in-pype-tray-best-case-scenario) guide
+1. Make sure OpenPype is running and you passed [Login to Ftrack](#login-to-ftrack-module-in-pype-tray-best-case-scenario) guide
2. Open web browser and go to your studio Ftrack web page *(e.g. https://mystudio.ftrackapp.com/)*
3. Locate the task on which you want to run the application
4. Display actions for the task
@@ -50,10 +50,10 @@ sidebar_label: Artist
## What if...
### Ftrack login window didn't pop up and Ftrack menu is not in tray
-**1. possibility - Pype tray didn't load properly**
-- try to restart tray
+**1. possibility - OpenPype tray didn't load properly**
+- try to restart OpenPype
-**2. possibility - Ftrack is not set in Pype**
+**2. possibility - Ftrack is not set in OpenPype**
- inform your administrator
@@ -65,12 +65,12 @@ sidebar_label: Artist
- Check **Ftrack URL** value in *Ftrack login* window
- Inform your administrator if URL is incorrect and launch tray again when administrator fix it
-**3. possibility - Ftrack Web app can't be reached the way Pype use it**
+**3. possibility - Ftrack Web app can't be reached the way OpenPype use it**
- Enter your **Username** and [API key](#where-to-find-api-key) in *Ftrack login* window and press **Login** button
### Ftrack action menu is empty
-**1. possibility - Pype tray is not running**
-- launch Pype tray
+**1. possibility - OpenPype is not running**
+- launch OpenPype
**2. possibility - You didn't go through Login to Ftrack guide**
- please go through [Login to Ftrack](#login-to-ftrack-module-in-pype-tray-best-case-scenario) guide
diff --git a/website/docs/artist_getting_started.md b/website/docs/artist_getting_started.md
index 575d4864d3..be1960a38c 100644
--- a/website/docs/artist_getting_started.md
+++ b/website/docs/artist_getting_started.md
@@ -1,43 +1,84 @@
---
-title: Getting started with Pype
+title: Getting started with OpenPype
sidebar_label: Getting started
---
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-## Basic use
-If you have Pype installed and deployed, you can start using it. Ideally you should
-have Pype icon on your desktop or even have your computer set up so Pype will start
-automatically.
+## Working in the studio
-Otherwise for most common stuff there are so-called *launchers* - scripts you can just run from desktop shortcut or
-whatever and you are done. There is also manual invocation of Pype command you can use
-for slightly more control.
+In studio environment you should have OpenPype already installed and deployed, so you can start using it without much setup. Your admin has probably put OpenPype icon on your desktop or even had your computer set up so OpenPype will start automatically.
-:::tip Launchers
-Launchers can be found in `pype/launchers` directory. They are basically shell scripts running Pype. You can create shortcuts on desktop for them for easy Pype launching.
-:::
+If this is not the case, please contact your administrator to consult on how to launch OpenPype in your studio
-### Starting tray manually
+## Working from home
-**Pype Tray** is most common Pype command for artists. It runs Pype GUI in system tray
-from which you can work with Pype. To use Pype, **Pype Tray** must be running.
+If you are working from home though, you'll need to install it yourself. You should, however, receive the OpenPype installer files from your studio
+admin, supervisor or production, because OpenPype versions and executables might not be compatible between studios.
-To run **Pype Tray**:
+To install OpenPype you just need to unzip it anywhere on the disk
-```sh
-pype tray
-```
+To use it, you have two options
-or run launcher `launchers/pype_tray.bat` (Windows) or `launchers/pype_tray.sh` (Linux)
+**openpype_gui.exe** is the most common for artists. It runs OpenPype GUI in system tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray.
-:::note Debugging
-To get more information on what's going on in Pype, you can run Tray with `--debug` option. This will show text console window with lots of useful information.
-```sh
-pype tray --debug
-```
-:::
+**openpype_console.exe** in usefull for debugging and error reporting. It opens console window where all the necessary information will appear during user's work.
-### Advanced use
-For more advanced use of Pype command please visit [Admin section](admin_pype_commands).
+
+
+
+
+WIP - Windows instructions once installers are finished
+
+
+
+
+WIP - Linux instructions once installers are finished
+
+
+
+
+WIP - Mac instructions once installers are finished
+
+
+
+
+
+## First Launch
+
+
+When you first start OpenPype, you will be asked to give it some basic information.
+### MongoDB
+
+In most cases that will only be your studio MongoDB Address.
+
+It is a URL that you should receive from you studio and most often will look like this `mongodb://username:passwword@mongo.mystudiodomain.com:12345` or `mongodb://192.168.100.15:27071`, it really depends on your studio setup. When OpenPype Igniter
+asks for it, just put it in the corresponding text field and press `install` button.
+
+### OpenPype Version Repository
+
+Sometimes your studio might also ask you to fill in the path to it's version
+repository. This is a location where OpenPype will be looking for when checking
+if it's up to date and where updates are installed from automatically.
+
+This pat is usually taken from the database directly, so you shouldn't need it.
+
+
+## Updates
+
+If you're connected to your studio, OpenPype will check for, and install updates automatically everytime you run it. That's why during the first start, it will go through a quick update installation process, even though you might have just installed it.
+
+
+## Advanced use
+
+For more advanced use of OpenPype commands please visit [Admin section](admin_openpype_commands).
diff --git a/website/docs/artist_hosts_aftereffects.md b/website/docs/artist_hosts_aftereffects.md
new file mode 100644
index 0000000000..879c0d4646
--- /dev/null
+++ b/website/docs/artist_hosts_aftereffects.md
@@ -0,0 +1,107 @@
+---
+id: artist_hosts_aftereffects
+title: AfterEffects
+sidebar_label: AfterEffects
+---
+
+## Available Tools
+
+- [Work Files](artist_tools.md#workfiles)
+- [Create](artist_tools.md#creator)
+- [Load](artist_tools.md#loader)
+- [Publish](artist_tools.md#publisher)
+- [Manage](artist_tools.md#inventory)
+- [Subset Manager](artist_tools.md#subset-manager)
+
+## Setup
+
+To install the extension, download, install [Anastasyi's Extention Manager](https://install.anastasiy.com/). Open Anastasyi's Extension Manager and select AfterEffects in menu. Then go to `{path to pype}/repos/avalon-core/avalon/aftereffects/extension.zxp`.
+
+Drag extension.zxp and drop it to Anastasyi's Extension Manager. The extension will install itself.
+
+## Implemented functionality
+
+AfterEffects implementation currently allows you to import and add various media to composition (image plates, renders, audio files, video files etc.)
+and send prepared composition for rendering to Deadline.
+
+## Usage
+
+When you launch AfterEffects you will be met with the Workfiles app. If don't
+have any previous workfiles, you can just close this window.
+
+Workfiles tools takes care of saving your .AEP files in the correct location and under
+a correct name. You should use it instead of standard file saving dialog.
+
+In AfterEffects you'll find the tools in the `OpenPype` extension:
+
+
+
+You can show the extension panel by going to `Window` > `Extensions` > `OpenPype`.
+
+### Create
+
+When you have created an composition you want to publish, you will need to tag existing composition. To do this open the `Creator` through the extensions `Create` button.
+
+
+
+Because of current rendering limitations, it is expected that only single composition will be marked for publishing!
+
+After Creator is successfully triggered on selected composition, it will be marked with an icon and its color
+will be changed.
+
+
+
+### Publish
+
+When you are ready to share your work, you will need to publish it. This is done by opening the `Publish` by clicking the corresponding button in the OpenPype Panel.
+
+
+
+This tool will run through checks to make sure the contents you are publishing is correct. Hit the "Play" button to start publishing.
+
+You may encounter issues with publishing which will be indicated with red squares. If these issues are within the validation section, then you can fix the issue. If there are issues outside of validation section, please let the OpenPype team know. For More details have a look at the general [Publish](artist_tools.md#publisher) documentation.
+
+### Load
+
+When you want to load existing published work, you can use the `Loader` tool. You can reach it in the extension's panel.
+
+
+
+The supported families for loading into AfterEffects are:
+
+- `image`
+- `plate`
+- `render`
+- `prerender`
+- `review`
+- `audio`
+- `background` `(set of images sorted in predefined order)`
+
+To load an item, right-click on the subset you want and choose a representation you want to load:
+
+
+
+### Manage
+
+Now that we have some content loaded, you can manage which version is loaded. This is done through the `Scene Manager`. You can reach it through the extension's `Manage` button.
+
+:::note
+Loaded images have to stay as smart layers in order to be updated. If you rasterize the layer, you can no longer update it to a different version using OpenPype tools.
+:::
+
+
+
+You can switch to a previous version of the image or update to the latest.
+
+
+
+
+### Subset Manager
+
+
+
+All created compositions will be shown in a simple list. If user decides, that this composition shouldn't be
+published after all, right click on that item in the list and select 'Remove instance'
+
+Removing composition direclty in the AE would result to worfile contain phantom metadata which could result in
+errors during publishing!
\ No newline at end of file
diff --git a/website/docs/artist_hosts_harmony.md b/website/docs/artist_hosts_harmony.md
index d5d206225f..3e945a2852 100644
--- a/website/docs/artist_hosts_harmony.md
+++ b/website/docs/artist_hosts_harmony.md
@@ -18,19 +18,19 @@ Only one tool can be open at a time. If you open a tool while another tool is op
## Usage
-The integration creates an `Avalon` menu entry where all related tools are located.
+The integration creates an `OpenPype` menu entry where all related tools are located.
:::note
Menu creation can be temperamental. Its best to start Harmony and do nothing else until the application is fully launched.
-If you dont see the `Avalon` menu, then follow this to create it:
-- Go to the Script Editor
+If you dont see the `OpenPype` menu, then follow this to create it:
+- Go to the `Script Editor`
- Find the script called `TB_sceneOpened.js` and run it.
- Choose the `start` method to run.
:::
### Workfiles
-`Avalon > Workfiles`
+`OpenPype > Workfiles`
Work files are temporarily stored locally, in `[user]/.avalon/harmony`, to reduce network bandwidth. When saving the Harmony scene, a background process ensures the network files are updated.
@@ -42,7 +42,7 @@ Because the saving to the network location happens in the background, be careful
### Create
-`Avalon > Create`
+`OpenPype > Create`
@@ -53,44 +53,44 @@ These are the families supported in Harmony:
- `Template`
- This instance is for generating a templates. This is a normal composite node, which you can connect any number of nodes to.
- Any connected nodes will be published along with their dependencies and any back drops.
-- (`Palette`)
+- `Palette`
- Palettes are indirectly supported in Harmony. This means you just have to have palettes in your scene to publish them.
When you `Use selection` on creation, the last selected node will be connected to the created node.
### Publish
-`Avalon > Publish`
+`OpenPype > Publish`
-
+
This tool will run through checks to make sure the contents you are publishing is correct. Hit the "Play" button to start publishing.
-You may encounter issues with publishing which will be indicated with red squares. If these issues are within the validation section, then you can fix the issue. If there are issues outside of validation section, please let the Pype team know.
+You may encounter issues with publishing which will be indicated with red squares. If these issues are within the validation section, then you can fix the issue. If there are issues outside of validation section, please let the OpenPype team know.
#### Repair Validation Issues
All validators will give some description about what the issue is. You can inspect this by going into the validator through the arrow:
-
+
You can expand the errors by clicking on them for more details:
-
+
Some validator have repair actions, which will fix the issue. If you can identify validators with actions by the circle icon with an "A":
-
+
To access the actions, you right click on the validator. If an action runs successfully, the actions icon will turn green. Once all issues are fixed, you can just hit the "Refresh" button and try to publish again.
-
-
+
+
### Load
-`Avalon > Load`
+`OpenPype > Load`
-
+
The supported families for Harmony are:
@@ -104,7 +104,7 @@ The supported families for Harmony are:
To load, right-click on the subset you want and choose a representation:
-
+
:::note
Loading templates or workfiles will import the contents into scene. Referencing is not supported at the moment, so you will have to load newer versions into the scene.
@@ -112,17 +112,17 @@ Loading templates or workfiles will import the contents into scene. Referencing
### Manage
-`Avalon > Manage`
+`OpenPype > Manage`
-
+
You can switch to a previous version of the image or update to the latest.
-
-
+
+
:::note
Images and image sequences will be loaded into the scene as read nodes can coloured green. On startup the pipeline checks for any outdated read nodes and colours them red.
-- **Green** = Up to date version in scene.
-- **Red** = Outdated version in scene.
+- Green = Up to date version in scene.
+- Red = Outdated version in scene.
:::
diff --git a/website/docs/artist_hosts_maya.md b/website/docs/artist_hosts_maya.md
index baab63b8cf..1ed326ebe7 100644
--- a/website/docs/artist_hosts_maya.md
+++ b/website/docs/artist_hosts_maya.md
@@ -4,7 +4,7 @@ title: Maya
sidebar_label: Maya
---
-## Pype global tools
+## OpenPype global tools
- [Set Context](artist_tools.md#set-context)
- [Work Files](artist_tools.md#workfiles)
@@ -14,11 +14,11 @@ sidebar_label: Maya
- [Publish](artist_tools.md#publisher)
- [Library Loader](artist_tools.md#library-loader)
-## Working with Pype in Maya
+## Working with OpenPype in Maya
-Pype is here to ease you the burden of working on project with lots of
+OpenPype is here to ease you the burden of working on project with lots of
collaborators, worrying about naming, setting stuff, browsing through endless
-directories, loading and exporting and so on. To achieve that, Pype is using
+directories, loading and exporting and so on. To achieve that, OpenPype is using
concept of being _"data driven"_. This means that what happens when publishing
is influenced by data in scene. This can by slightly confusing so let's get to
it with few examples.
@@ -39,8 +39,8 @@ Note that `sphere_GEO` has frozen transformations.
### Creating instance
-Now create **Model instance** from it to let Pype know what in the scene you want to
-publish. Go **Pype → Create... → Model**
+Now create **Model instance** from it to let OpenPype know what in the scene you want to
+publish. Go **OpenPype → Create... → Model**
@@ -53,7 +53,7 @@ have in the model. For example, you can name it `Proxy` to indicate that this is
low resolution stuff. See [Subset](artist_concepts#subset).
:::note LOD support
-By changing subset name you can take advantage of _LOD support_ in Pype. Your
+By changing subset name you can take advantage of _LOD support_ in OpenPype. Your
asset can contain various resolution defined by different subsets. You can then
switch between them very easy using [Inventory (Manage)](artist_tools#inventory).
There LODs are conveniently grouped so they don't clutter Inventory view.
@@ -80,7 +80,7 @@ your asset should reside. As in our case we are working on asset called
### Publishing models
-Now let's publish it. Go **Pype → Publish...**. You will be presented with following window:
+Now let's publish it. Go **OpenPype → Publish...**. You will be presented with following window:
@@ -139,12 +139,12 @@ it can take a while. You should end up with everything green and message
**Finished successfully ...** You can now close publisher window.
To check for yourself that model is published, open
-[Asset Loader](artist_tools#loader) - **Pype → Load...**.
+[Asset Loader](artist_tools#loader) - **OpenPype → Load...**.
There you should see your model, named `modelMain`.
## Look development
-Look development in Pype is easy. It helps you with versioning different
+Look development in OpenPype is easy. It helps you with versioning different
kinds of shaders and easy switching between them.
Let se how it works.
@@ -152,9 +152,9 @@ Let se how it works.
### Loading model
In this example I have already published model of Buddha. To see how to publish
-model with Pype see [Publishing Model](artist_hosts_maya#publishing-models).
+model with OpenPype see [Publishing Model](artist_hosts_maya#publishing-models).
-First of lets start with empty scene. Now go **Pype → Load...**
+First of lets start with empty scene. Now go **OpenPype → Load...**
@@ -173,13 +173,13 @@ I am quite happy with it so I want to publish it as my first look.
### Publishing look
-Select your model in outliner and ho **Pype → Create...**. From there
+Select your model in outliner and ho **OpenPype → Create...**. From there
select **Look**. Make sure `use selection` checkbox is checked.
Mine subset name is `Main`. This will create _Look instance_ with a name **lookMain**.
Close _Creator_ window.
-Now save your scene, give it some sensible name. Next, go **Pype → Publish**.
+Now save your scene, give it some sensible name. Next, go **OpenPype → Publish**.
This process is almost identical as publishing models, only different _Validators_
and other plugins will be used.
@@ -222,29 +222,29 @@ Select you asset and on the right side right click on `Main` look. Apply it.
You notice that Buddha model is now red, materials you've published are now applied
to it.
-That way you can create looks as you want and version them using Pype.
+That way you can create looks as you want and version them using OpenPype.
## Setting scene data
Maya settings concerning framerate, resolution and frame range are handled by
-Pype. If set correctly in Ftrack, Maya will validate you have correct fps on
+OpenPype. If set correctly in Ftrack, Maya will validate you have correct fps on
scene save and publishing offering way to fix it for you.
-For resolution and frame range, use **Pype → Reset Frame Range** and
-**Pype → Reset Resolution**
+For resolution and frame range, use **OpenPype → Reset Frame Range** and
+**OpenPype → Reset Resolution**
-## Creating rigs with Pype
+## Creating rigs with OpenPype
-Creating and publishing rigs with Pype follows similar workflow as with
+Creating and publishing rigs with OpenPype follows similar workflow as with
other data types. Create your rig and mark parts of your hierarchy in sets to
-help Pype validators and extractors to check it and publish it.
+help OpenPype validators and extractors to check it and publish it.
### Preparing rig for publish
When creating rigs, it is recommended (and it is in fact enforced by validators)
to separate bones or driving objects, their controllers and geometry so they are
-easily managed. Currently Pype doesn't allow to publish model at the same time as
+easily managed. Currently OpenPype doesn't allow to publish model at the same time as
its rig so for demonstration purposes, I'll first create simple model for robotic
arm, just made out of simple boxes and I'll publish it.
@@ -252,7 +252,7 @@ arm, just made out of simple boxes and I'll publish it.
For more information about publishing models, see [Publishing models](artist_hosts_maya#publishing-models).
-Now lets start with empty scene. Load your model - **Pype → Load...**, right
+Now lets start with empty scene. Load your model - **OpenPype → Load...**, right
click on it and select **Reference (abc)**.
I've created few bones and their controllers in two separate
@@ -261,8 +261,8 @@ your naming conventions.
Then I've put everything into `arm_rig` group.
-When you've prepared your hierarchy, it's time to create *Rig instance* in Pype.
-Select your whole rig hierarchy and go **Pype → Create...**. Select **Rig**.
+When you've prepared your hierarchy, it's time to create *Rig instance* in OpenPype.
+Select your whole rig hierarchy and go **OpenPype → Create...**. Select **Rig**.
Set is created in your scene to mark rig parts for export. Notice that it has
two subsets - `controls_SET` and `out_SET`. Put your controls into `controls_SET`
and geometry to `out_SET`. You should end up with something like this:
@@ -272,13 +272,13 @@ and geometry to `out_SET`. You should end up with something like this:
### Publishing rigs
Publishing rig is done in same way as publishing everything else. Save your scene
-and go **Pype → Publish**. When you run validation you'll mostly run at first into
+and go **OpenPype → Publish**. When you run validation you'll mostly run at first into
few issues. Although number of them will seem to be intimidating at first, you'll
find out they are mostly minor things easily fixed.
* **Non Duplicate Instance Members (ID)** - This will most likely fail because when
creating rigs, we usually duplicate few parts of it to reuse them. But duplication
-will duplicate also ID of original object and Pype needs every object to have
+will duplicate also ID of original object and OpenPype needs every object to have
unique ID. This is easily fixed by **Repair** action next to validator name. click
on little up arrow on right side of validator name and select **Repair** form menu.
@@ -294,17 +294,17 @@ have any missing dependencies.
### Loading rigs
-You can load rig with [Loader](artist_tools.md#loader). Go **Pype → Load...**,
+You can load rig with [Loader](artist_tools.md#loader). Go **OpenPype → Load...**,
select your rig, right click on it and **Reference** it.
## Point caches
-Pype is using Alembic format for point caches. Workflow is very similar as
+OpenPype is using Alembic format for point caches. Workflow is very similar as
other data types.
### Creating Point Caches
To create point cache just create whatever hierarchy you want and animate it.
-Select its root and Go **Pype → Create...** and select **Point Cache**.
+Select its root and Go **OpenPype → Create...** and select **Point Cache**.
After that, publishing will create corresponding **abc** files.
@@ -314,7 +314,7 @@ Example setup:
### Loading Point Caches
-Loading point cache means creating reference to **abc** file with Go **Pype → Load...**.
+Loading point cache means creating reference to **abc** file with Go **OpenPype → Load...**.
Example result:
@@ -323,40 +323,40 @@ Example result:
## Set dressing in Maya
Set dressing is term for easily populate complex scenes with individual parts.
-Pype allows to version and manage those sets.
+OpenPype allows to version and manage those sets.
### Publishing Set dress / Layout
Working with Set dresses is very easy. Just load your assets into scene with
-[Loader](artist_tools.md#loader) (**Pype → Load...**). Populate your scene as
+[Loader](artist_tools.md#loader) (**OpenPype → Load...**). Populate your scene as
you wish, translate each piece to fit your need. When ready, select all imported
-stuff and go **Pype → Create...** and select **Set Dress** or **Layout**.
+stuff and go **OpenPype → Create...** and select **Set Dress** or **Layout**.
This will create set containing your selection and marking it for publishing.
:::note set dress vs layout
Currently *set dress* and *layout* are functionally identical
:::
-Now you can publish is with **Pype → Publish**.
+Now you can publish is with **OpenPype → Publish**.
### Loading Set dress / Layout
You can load Set dress / Layout using [Loader](artist_tools.md#loader)
-(**Pype → Load...**). Select you layout or set dress, right click on it and
+(**OpenPype → Load...**). Select you layout or set dress, right click on it and
select **Reference Maya Ascii (ma)**. This will populate your scene with all those
models you've put into layout.
-## Rendering with Pype
+## Rendering with OpenPype
-Pype in Maya can be used for submitting renders to render farm and for their
-subsequent publishing. Right now Pype support [AWS Thinkbox Deadline](https://www.awsthinkbox.com/deadline)
+OpenPype in Maya can be used for submitting renders to render farm and for their
+subsequent publishing. Right now OpenPype support [AWS Thinkbox Deadline](https://www.awsthinkbox.com/deadline)
and [Virtual Vertex Muster](https://www.vvertex.com/overview/).
* For setting up Muster support see [admin section](admin_config#muster)
* For setting up Deadline support see [here](admin_config#aws-thinkbox-deadline)
:::note Muster login
-Muster is now configured so every user must log in to get authentication support. If Pype founds out this token is missing or expired, it will ask again for credentials.
+Muster is now configured so every user must log in to get authentication support. If OpenPype founds out this token is missing or expired, it will ask again for credentials.
:::
### Creating basic render setup
@@ -366,11 +366,11 @@ If you want to submit your render to farm, just follow these simple steps.
#### Preparing scene
Lets start with empty scene. First I'll pull in my favorite Buddha model.
-**Pype → Load...**, select model and right+click to pop up context menu. From
+**OpenPype → Load...**, select model and right+click to pop up context menu. From
there just click on **Reference (abc)**.
Next, I want to be sure that I have same frame range as is set on shot I am working
-on. To do this just **Pype → Reset Frame Range**. This should set Maya timeline to same
+on. To do this just **OpenPype → Reset Frame Range**. This should set Maya timeline to same
values as they are set on shot in *Ftrack* for example.
I have my time set, so lets create some animation. We'll turn Buddha model around for
@@ -390,17 +390,17 @@ tweaks on it.
#### Prepare scene for submission
-As we have working simple scene we can start preparing it for rendering. Pype is fully utilizing
-Render Setup layers for this. First of all, we need to create *Render instance* to tell Pype what
+As we have working simple scene we can start preparing it for rendering. OpenPype is fully utilizing
+Render Setup layers for this. First of all, we need to create *Render instance* to tell OpenPype what
to do with renders. You can easily render locally or on render farm without it, but *Render instance*
is here to mark render layers you want to publish.
-Lets create it. Go **Pype → Create...**. There select **Render** from list. If you keep
+Lets create it. Go **OpenPype → Create...**. There select **Render** from list. If you keep
checked **Use selection** it will use your current Render Layers (if you have them). Otherwise,
if no render layers is present in scene, it will create one for you named **Main** and under it
default collection with `*` selector.
-No matter if you use *Deadline* or *Muster*, Pype will try to connect to render farm and
+No matter if you use *Deadline* or *Muster*, OpenPype will try to connect to render farm and
fetch machine pool list.
:::note Muster login
@@ -418,7 +418,7 @@ appear here, prefixed with `LAYER_`. Those layer set are created whenever you cr
Render Setup and are deleted if you delete layer in Render Setup. However if you delete `LAYER_` set,
layer in Render Setup isn't deleted. It just means it won't be published.
-Creating *Render instance* will also set image prefix in render settings to Pype defaults based on
+Creating *Render instance* will also set image prefix in render settings to OpenPype defaults based on
renderer you use - for example if you render with Arnold, it is `maya///_`.
There are few setting on *Render instance* `renderingMain` in **Attributes Editor**:
@@ -484,7 +484,7 @@ and for vray:
maya//
```
-Doing **Pype → Reset Resolution** will set correct resolution on camera.
+Doing **OpenPype → Reset Resolution** will set correct resolution on camera.
Scene is now ready for submission and should publish without errors.
@@ -495,19 +495,19 @@ When render is finished, this other job triggers in and run publish again, but t
### Attaching render to subset
-You can create render that will be attached to another subset you are publishing, rather than being published on it's own. Let's assume, you want to render a model turnaround.
+You can create render that will be attached to another subset you are publishing, rather than being published on its own. Let's assume, you want to render a model turnaround.
In the scene from where you want to publish your model create *Render subset*. Prepare your render layer as needed and then drag
-model subset (maya set node) under corresponding `LAYER_` set under *Render instance*. During publish, it will submit this render to farm and
+model subset (Maya set node) under corresponding `LAYER_` set under *Render instance*. During publish, it will submit this render to farm and
after it is rendered, it will be attached to your model subset.
## Render Setups
### Publishing Render Setups
-Pype can publish whole **Render Settings** setup. You can then version in and load it to
+OpenPype can publish whole **Render Settings** setup. You can then version in and load it to
any Maya scene. This helps TDs to distribute per asset/shots render settings for Maya.
-To publish render settings, go **Pype → Create...** and select **Render Setup Preset**.
+To publish render settings, go **OpenPype → Create...** and select **Render Setup Preset**.
In your scene will appear set `rendersetup`. This one has no settings, only its presence
in scene will trigger publishing of render settings.
@@ -516,7 +516,7 @@ When you publish scene, current settings in **Render Settings** will be serializ
### Loading Render Setups
-In any scene, you can load published render settings with **Pype → Load...**. Select your published
+In any scene, you can load published render settings with **OpenPype → Load...**. Select your published
render setup settings, right+click on it and select **Load RenderSetup template**.
This will load and parse json file and apply all setting there to your Render Setting.
@@ -527,7 +527,7 @@ This will overwrite all setting you already have.
## Reviews
-Pype supports creating review video for almost any type of data you want to publish.
+OpenPype supports creating review video for almost any type of data you want to publish.
What we call review video is actually _playblast_ or _capture_ (depending on terminology
you are familiar with) made from pre-defined camera in scene. This is very useful
in cases where you want to add turntable preview of your model for example. But it can
@@ -539,14 +539,14 @@ Lets see how review publishing works on simple scene. We will publish model with
turntable preview video.
I'll be using Stanford University dragon model. Start with empty scene.
-Create your model, import it or load from Pype. I'll just import model as OBJ
+Create your model, import it or load from OpenPype. I'll just import model as OBJ
file.
After we have our model in, we need to set everything to be able to publish it
as model - for detail see [Publishing models](artist_hosts_maya#publishing-models).
To recap - freeze transforms, rename it to `dragon_GEO` and put it into group
-`dragon_GRP`. Then select this group and **Pype → Create...** and choose **Model**.
+`dragon_GRP`. Then select this group and **OpenPype → Create...** and choose **Model**.
Now, lets create camera we need to generate turntable video. I prefer to animate
camera itself and not model because all animation keys will be associated with camera
@@ -557,7 +557,7 @@ locator. I set my timeline to 50 frames, key `reviewRotation_LOC` Y axis on fram
1 to 0 and on frame 50 to 360. I've also set animation curve between those two keys
to linear.
-To mark camera to be used for review, select camera `reviewCamera` and go **Pype → Create...**
+To mark camera to be used for review, select camera `reviewCamera` and go **OpenPype → Create...**
and choose **Review**.
This will create set `review` including selected camera. You can set few options
@@ -579,7 +579,7 @@ model validators_
### Publishing model with review
-You can now publish your model and generate review video. Go **Pype → Publish...**,
+You can now publish your model and generate review video. Go **OpenPype → Publish...**,
validate if you will, and publish it. During publishing, Maya will create _playblast_
for whole frame range you've specified, then it will pass those frames to _ffmpeg_.
That will create video file, pass it to another extractor creating burnins in it
@@ -589,9 +589,9 @@ settings for Maya playblast - can be customized by your TDs. For more informatio
about customizing review process refer to [admin section](admin_presets_plugins).
-## Working with Yeti in Pype
+## Working with Yeti in OpenPype
-Pype can work with [Yeti](https://peregrinelabs.com/yeti/) in two data modes.
+OpenPype can work with [Yeti](https://peregrinelabs.com/yeti/) in two data modes.
It can handle Yeti caches and Yeti rigs.
### Creating and publishing Yeti caches
@@ -603,7 +603,7 @@ Open Yeti node graph **Yeti → Open Graph Editor** and create setup like this:
It doesn't matter what setting you use now, just select proper shape in first
-*Import* node. Select your Yeti node and create *Yeti Cache instance* - **Pype → Create...**
+*Import* node. Select your Yeti node and create *Yeti Cache instance* - **OpenPype → Create...**
and select **Yeti Cache**. Leave `Use selection` checked. You should end up with this setup:
@@ -625,13 +625,13 @@ This is usefull to "steady" simulation for example.
- `Fps` of cache
- `Samples` how many time samples we take during caching
-You can now publish Yeti cache as any other types. **Pype → Publish**. It will
+You can now publish Yeti cache as any other types. **OpenPype → Publish**. It will
create sequence of `.fur` files and `.fursettings` metadata file with Yeti node
setting.
### Loading Yeti caches
-You can load Yeti cache by **Pype → Load ...**. Select your cache, right+click on
+You can load Yeti cache by **OpenPype → Load ...**. Select your cache, right+click on
it and select **Load Yeti cache**. This will create Yeti node in scene and set its
cache path to point to your published cache files. Note that this Yeti node will
be named with same name as the one you've used to publish cache. Also notice that
@@ -649,7 +649,7 @@ Create select model mesh, create Yeti node - **Yeti → Create Yeti Node on Mesh
setup similar Yeti graph as in cache example above.
Then select this Yeti node (mine is called with default name `pgYetiMaya1`) and
-create *Yeti Rig instance* - **Pype → Create...** and select **Yeti Cache**.
+create *Yeti Rig instance* - **OpenPype → Create...** and select **Yeti Cache**.
Leave `Use selection` checked.
Last step is to add our model geometry to rig instance, so middle+drag its
@@ -660,7 +660,7 @@ Note that its name can differ and is based on your subset name.
Save your scene and ready for publishing our new simple Yeti Rig!
-Go to publish **Pype → Publish** and run. This will publish rig with its geometry
+Go to publish **OpenPype → Publish** and run. This will publish rig with its geometry
as `.ma` scene, save Yeti node settings and export one frame of Yeti cache from
the beginning of your timeline. It will also collect all textures used in Yeti
node, copy them to publish folder `resource` directory and set *Image search path*
@@ -676,7 +676,7 @@ then it is probably caused by scene not being saved before publishing.
### Loading Yeti Rig
-You can load published Yeti Rigs as any other thing in Pype - **Pype → Load ...**,
+You can load published Yeti Rigs as any other thing in OpenPype - **OpenPype → Load ...**,
select you Yeti rig and right+click on it. In context menu you should see
**Load Yeti Cache** and **Load Yeti Rig** items (among others). First one will
load that one frame cache. The other one will load whole rig.
diff --git a/website/docs/artist_hosts_nuke.md b/website/docs/artist_hosts_nuke.md
index 044020d77b..1e02599570 100644
--- a/website/docs/artist_hosts_nuke.md
+++ b/website/docs/artist_hosts_nuke.md
@@ -8,7 +8,11 @@ sidebar_label: Nuke
After Nuke starts it will automatically **Apply All Settings** for you. If you are sure the settings are wrong just contact your supervisor and he will set them correctly for you in project database.
:::
-## Pype global tools
+:::note
+The workflows are identical for both. We are supporting versions **`11.0`** and above.
+:::
+
+## OpenPype global tools
- [Set Context](artist_tools.md#set-context)
- [Work Files](artist_tools.md#workfiles)
@@ -35,7 +39,7 @@ Use this feature in case you are not sure the frame range is correct.
@@ -87,11 +91,12 @@ This menu item will set correct Colorspace definitions for you. All has to be co
- set Colorspace in your script settings
- set preview LUT to your viewers
+- set correct colorspace to all discovered Read nodes (following expression set in settings)
@@ -113,17 +118,23 @@ It is usually enough if you once per while use this option just to make yourself
-
+
-### Build First Work File
+### Build Workfile
-This tool will create your first version of workfile and save it to correct folder with correct file name convention. It will look into database and get all last [versions](artist_concepts.md#version) of available [subsets](artist_concepts.md#subset).
+This tool will append all available subsets into an actual node graph. It will look into database and get all last [versions](artist_concepts.md#version) of available [subsets](artist_concepts.md#subset).
+
+
+##### Result
+
+- adds all last versions of subsets (rendered image sequences) as read nodes
+- adds publishable write node as `renderMain` subset
@@ -131,31 +142,4 @@ This tool will create your first version of workfile and save it to correct fold
-
-
-
-##### Result
-
-
-
-
-- adds all last versions of subsets (rendered image sequences) as read nodes
-- adds available color transformations under Read nodes
-- adds publishable write node as `renderMain` subset
-
-
+
\ No newline at end of file
diff --git a/website/docs/artist_hosts_nukestudio.md b/website/docs/artist_hosts_nukestudio.md
index d4d6741222..23301f53bf 100644
--- a/website/docs/artist_hosts_nukestudio.md
+++ b/website/docs/artist_hosts_nukestudio.md
@@ -8,7 +8,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::note
-All the information also applies to **_Nuke Studio_**, but for simplicity we only refer to hiero. The workflows are identical for both. We are supporting versions **`11.0`** and above.
+All the information also applies to **_Nuke Studio_**, but for simplicity we only refer to Hiero. The workflows are identical for both. We are supporting versions **`11.0`** and above.
:::
@@ -21,12 +21,12 @@ All the information also applies to **_Nuke Studio_**, but for simplicity we onl
### Create Default Tags
-This tool will recreate all necessary pype tags needed for successful publishing. It is automatically ran at start of the hiero. Use this tool to manually re-create all the tags if you accidentaly delete them, or you want to reset them to default values.
+This tool will recreate all necessary OpenPype tags needed for successful publishing. It is automatically ran at start of the Hiero. Use this tool to manually re-create all the tags if you accidentaly delete them, or you want to reset them to default values.
@@ -43,9 +43,9 @@ This tool will recreate all necessary pype tags needed for successful publishing
-With Pype, you can use hiero as a starting point for creating project hierarchy in avalon and ftrack database (episodes, sequences, shots, folders etc.), publishing plates, reference quicktimes, audio and various soft effects that will be evailable later on for compositors and 3d artist to use.
+With OpenPype, you can use Hiero as a starting point for creating project hierarchy in avalon and ftrack database (episodes, sequences, shots, folders etc.), publishing plates, reference quicktimes, audio and various soft effects that will be evailable later on for compositors and 3D artist to use.
-There are two ways to `Publish` data and create shots in database from hiero. Use either context menu on right clicking selected clips or go to top `menu > Pype > Publish`.
+There are two ways to `Publish` data and create shots in database from Hiero. Use either context menu on right clicking selected clips or go to top `menu > OpenPype > Publish`.
@@ -59,11 +59,11 @@ Keep in mind that the publishing currently works on selected shots
Shot names for all the related plates that you want to publish (subsets) has to be the same to be correctly paired together (as it is shown in image).
Note the layer **review** which contains `plateMainReview`.
-This media is just h264,1920x1080 video for tha will be used as preview of the actua `plateMain` subset and will be uploaded to Ftrack. We explain how to work with review tag in [**Reviewing**](#reviewing).
+This media is just h264, 1920x1080 video for that will be used as preview of the actual `plateMain` subset and will be uploaded to Ftrack. We explain how to work with review tag in [**Reviewing**](#reviewing).
:::important
-To to successfuly publish a shot from hiero:
+To to successfuly publish a shot from Hiero:
1. At least one clip of your shot must be tagged with `Hierarchy`, `subset` and `handleStart/End`.
2. Your source media must be pre-cut to correct length (including handles)
:::
@@ -71,7 +71,7 @@ To to successfuly publish a shot from hiero:
### Tagging
-Pype's custom tags are used for defining shot parameters and to define which clips and how they are going to be published.
+OpenPype's custom tags are used for defining shot parameters and to define which clips and how they are going to be published.
If you want to add any properties to your clips you'll need to adjust values on the given tag and then drag it onto the clip.
@@ -85,7 +85,7 @@ If you want to add any properties to your clips you'll need to adjust values on
1. double click on preferable tag and drag&drop it to selected clip(s)
2. Basic set of tags on clip (usually subset: plateMain)
3. Additionally select clip and edit its parameters
-4. Edit parameters here but Do not touch `family`
+4. Edit parameters here but do not touch `family`
@@ -99,7 +99,7 @@ Only clips with `subset` will be directly processed for publishing.
#### Asset related
| Icon | Description | Editable | Options |
| ------------------- | ---------------------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------- |
-| ![Hierarchy][hi] | Define parent hierarchy of the shot. Usually combined with one of subset tags. | root, folder, sequence, episode, shot | example: {sequence} = name of hiero sequence or overwrite by any text without `-` or `_` |
+| ![Hierarchy][hi] | Define parent hierarchy of the shot. Usually combined with one of subset tags. | root, folder, sequence, episode, shot | example: {sequence} = name of Hiero sequence or overwrite by any text without `-` or `_` |
| ![Frame Start][fst] | Set start frame of the shot. Using `"source"` will keep original frame numbers. | number | int `number` or `"source"` |
@@ -154,7 +154,7 @@ Only clips with `subset` will be directly processed for publishing.
### Handles
-Pype requires handle information in shot metadata even if they are set to 0.
+OpenPype requires handle information in shot metadata even if they are set to 0.
For this you need to add handles tags to the main clip (Should be the one with Hierarchy tag).
This way we are defining a shot property. In case you wish to have different
handles on other subsets (e.g. when plateBG is longer than plateFG) you can add handle tags with different value to this longer plate.
@@ -169,7 +169,7 @@ Even if you don't need any handles you have to add `start: add 0 frames` and `en
### Retiming
-Pype is also able to publish retiming parameters into the database.
+OpenPype is also able to publish retiming parameters into the database.
Any clip with **editorial**/**retime** or **TimeWarp** soft effect has to be tagged with `Retiming` tag, if you want this information preserved during publishing.
Any animation on **TimeWarp** is also preserved and reapplied in _Nuke_.
@@ -178,7 +178,7 @@ You can only combine **retime** and with a single **Timewarp**.
### Reviewing
-There are two ways to publish reviewable h264 mov into Pype (and ftrack).
+There are two ways to publish reviewable **h264 mov** into OpenPype (and Ftrack).
-1. `- review` suffix is added to publishing item label if any reviewable file is found
+1. `-review` suffix is added to publishing item label if any reviewable file is found
2. `plateMain` clip is holding the Review tag
3. layer name is `review` as it is used as default in _Review_ Tag in _track_
4. name of clip is the same across all subsets
@@ -240,8 +240,8 @@ Example:
-It is possible to publish hiero soft effects for compositors to use later on. You can add the effect to a particular clip or to whole layer as shows on the picture. All clips
-below the `Video 6` layer (green arrow) will be published with the **lut** subset which combines all the colour corrections from he soft effects. Any clips above the `Video 6` layer will have no **lut** published with them.
+It is possible to publish Hiero soft effects for compositors to use later on. You can add the effect to a particular clip or to whole layer as shows on the picture. All clips
+below the `Video 6` layer (green arrow) will be published with the **LUT** subset which combines all the colour corrections from he soft effects. Any clips above the `Video 6` layer will have no **LUT** published with them.
@@ -276,7 +276,7 @@ You cannot currently publish soft effects on their own because at the moment we
### Basic publishing with soft effects
-
+
### Extending premade handles tags
diff --git a/website/docs/artist_hosts_photoshop.md b/website/docs/artist_hosts_photoshop.md
index 5373308c27..7e84349565 100644
--- a/website/docs/artist_hosts_photoshop.md
+++ b/website/docs/artist_hosts_photoshop.md
@@ -14,21 +14,17 @@ sidebar_label: Photoshop
## Setup
-To install the extension download [Extension Manager Command Line tool (ExManCmd)](https://github.com/Adobe-CEP/Getting-Started-guides/tree/master/Package%20Distribute%20Install#option-2---exmancmd).
-
-```
-ExManCmd /install {path to pype-setup}/repos/avalon-core/avalon/photoshop/extension.zxp
-```
+To install the extension, download, install [Anastasyi's Extention Manager](https://install.anastasiy.com/). Open Anastasyi's Extension Manager and select Photoshop in menu. Then go to `{path to pype}/repos/avalon-core/avalon/photoshop/extension.zxp`. Drag extension.zxp and drop it to Anastasyi's Extension Manager. The extension will install itself.
## Usage
When you launch Photoshop you will be met with the Workfiles app. If dont have any previous workfiles, you can just close this window.
-In Photoshop you can find the tools in the `Avalon` extension:
+In Photoshop you can find the tools in the `OpenPype` extension:
-
+
-You can show the extension panel by going to `Window` > `Extensions` > `Avalon`.
+You can show the extension panel by going to `Window` > `Extensions` > `OpenPype`.
### Create
@@ -57,35 +53,35 @@ With the `Creator` you have a variety of options to create:
When you are ready to share some work, you will need to publish. This is done by opening the `Pyblish` through the extensions `Publish` button.
-
+
This tool will run through checks to make sure the contents you are publishing is correct. Hit the "Play" button to start publishing.
-You may encounter issues with publishing which will be indicated with red squares. If these issues are within the validation section, then you can fix the issue. If there are issues outside of validation section, please let the Pype team know.
+You may encounter issues with publishing which will be indicated with red squares. If these issues are within the validation section, then you can fix the issue. If there are issues outside of validation section, please let the OpenPype team know.
#### Repair Validation Issues
All validators will give some description about what the issue is. You can inspect this by going into the validator through the arrow:
-
+
You can expand the errors by clicking on them for more details:
-
+
Some validator have repair actions, which will fix the issue. If you can identify validators with actions by the circle icon with an "A":
-
+
To access the actions, you right click on the validator. If an action runs successfully, the actions icon will turn green. Once all issues are fixed, you can just hit the "Refresh" button and try to publish again.
-
+
### Load
When you want to load existing published work, you can load in smart layers through the `Loader`. You can reach the `Loader` through the extension's `Load` button.
-
+
The supported families for Photoshop are:
diff --git a/website/docs/artist_hosts_unreal.md b/website/docs/artist_hosts_unreal.md
index 7a8476ac3c..1c2c22937c 100644
--- a/website/docs/artist_hosts_unreal.md
+++ b/website/docs/artist_hosts_unreal.md
@@ -6,18 +6,18 @@ sidebar_label: Unreal
## Introduction
-Pype supports Unreal in similar ways as in other DCCs Yet there are few specific you need to be aware of.
+OpenPype supports Unreal in similar ways as in other DCCs Yet there are few specific you need to be aware of.
### Project naming
Unreal doesn't support project names starting with non-alphabetic character. So names like `123_myProject` are
-invalid. If Pype detects such name it automatically prepends letter **P** to make it valid name, so `123_myProject` will become `P123_myProject`. There is also soft-limit on project name length to be shorter then 20 characters. Longer names will issue warning in Unreal Editor that there might be possible side effects.
+invalid. If OpenPype detects such name it automatically prepends letter **P** to make it valid name, so `123_myProject` will become `P123_myProject`. There is also soft-limit on project name length to be shorter then 20 characters. Longer names will issue warning in Unreal Editor that there might be possible side effects.
-## Pype global tools
+## OpenPype global tools
-Pype global tools can be found in *Window* main menu:
+OpenPype global tools can be found in *Window* main menu:
-
+
- [Create](artist_tools.md#creator)
- [Load](artist_tools.md#loader)
@@ -29,12 +29,12 @@ Pype global tools can be found in *Window* main menu:
### Loading
-To import Static Mesh model, just choose **Pype → Load ...** and select your mesh. Static meshes are transfered as FBX files as specified in [Unreal Engine 4 Static Mesh Pipeline](https://docs.unrealengine.com/en-US/Engine/Content/Importing/FBX/StaticMeshes/index.html). This action will create new folder with subset name (`unrealStaticMeshMain_CON` for example) and put all data into it. Inside, you can find:
+To import Static Mesh model, just choose **OpenPype → Load ...** and select your mesh. Static meshes are transfered as FBX files as specified in [Unreal Engine 4 Static Mesh Pipeline](https://docs.unrealengine.com/en-US/Engine/Content/Importing/FBX/StaticMeshes/index.html). This action will create new folder with subset name (`unrealStaticMeshMain_CON` for example) and put all data into it. Inside, you can find:
-In this case there is **lambert1**, material pulled from Maya when this static mesh was published, **unrealStaticMeshCube** is the geometry itself, **unrealStaticMeshCube_CON** is a *AssetContainer* type and is there to mark this directory as Avalon Container (to track changes) and to hold Pype metadata.
+In this case there is **lambert1**, material pulled from Maya when this static mesh was published, **unrealStaticMeshCube** is the geometry itself, **unrealStaticMeshCube_CON** is a *AssetContainer* type and is there to mark this directory as Avalon Container (to track changes) and to hold OpenPype metadata.
### Publishing
-Publishing of Static Mesh works in similar ways. Select your mesh in *Content Browser* and **Pype → Create ...**. This will create folder named by subset you've choosen - for example **unrealStaticMeshDefault_INS**. It this folder is that mesh and *Avalon Publish Instance* asset marking this folder as publishable instance and holding important metadata on it. If you want to publish this instance, go **Pype → Publish ...**
\ No newline at end of file
+Publishing of Static Mesh works in similar ways. Select your mesh in *Content Browser* and **OpenPype → Create ...**. This will create folder named by subset you've choosen - for example **unrealStaticMeshDefault_INS**. It this folder is that mesh and *Avalon Publish Instance* asset marking this folder as publishable instance and holding important metadata on it. If you want to publish this instance, go **OpenPype → Publish ...**
\ No newline at end of file
diff --git a/website/docs/artist_publish.md b/website/docs/artist_publish.md
index 5c9fe6a984..a7cb7a1bad 100644
--- a/website/docs/artist_publish.md
+++ b/website/docs/artist_publish.md
@@ -30,7 +30,7 @@ Keep in mind that while publishing the data might take you some extra time, it w
The Instances are categorized into ‘families’ based on what type of data they contain. Some instances might have multiple families if needed. A shot camera will for example have families 'camera' and 'review' to indicate that it's going to be used for review quicktime, but also exported into a file on disk.
-Following family definitions and requirements are Pype defaults and what we consider good industry practice, but most of the requirements can be easily altered to suit the studio or project needs.
+Following family definitions and requirements are OpenPype defaults and what we consider good industry practice, but most of the requirements can be easily altered to suit the studio or project needs.
Here's a list of supported families
| Family | Comment | Example Subsets |
@@ -53,7 +53,7 @@ Here's a list of supported families
| LayeredImage | Software agnostic layered image with metadata | Reference, ConceptArt |
| Review | Reviewable video or image. | |
| Matchmove | Matchmoved camera, potentially with geometry | main |
-| Workfile | Backup of the workfile with all it's content | uses the task name |
+| Workfile | Backup of the workfile with all its content | uses the task name |
| Nukenodes | Any collection of nuke nodes | maskSetup, usefulBackdrop |
| Yeticache | Cached out yeti fur setup | |
| YetiRig | Yeti groom ready to be applied to geometry cache | main, destroyed |
@@ -73,7 +73,7 @@ Here's a list of supported families
Clean geometry without any material assignments. Published model can be as small as a single mesh, or as complex as a full building. That is purely up to the artist or the supervisor. Models can contain hierarchy defined by groups or nulls for better organisation.
-Apart from model subsets, we also support LODs as extra level on top of subset. To publish LODs, you just need to prepare subsets for publishing names `modelMySubsetName_LOD##`, if pype finds `_LOD##` (hashes replaced with LOD level), it will automatically be considered a LOD of the given subset.
+Apart from model subsets, we also support LODs as extra level on top of subset. To publish LODs, you just need to prepare subsets for publishing names `modelMySubsetName_LOD##`, if OpenPype finds `_LOD##` (hashes replaced with LOD level), it will automatically be considered a LOD of the given subset.
Example Subsets:
`modelMain`, `modelProxy`, `modelSculpt`, `modelBroken`, `modelMain_LOD01`, `modelMain_LOD02`
@@ -84,7 +84,7 @@ Example representations:
### Look
-A package of materials, shaders, assignments, textures and attributes that collectively define a look of a model for rendering or preview purposes. This ca usually be applied only to the model is was authored for, or it's corresponding cache, however material sharing across multiple models is also possible. A look should be fully self-contained and ready for rendering.
+A package of materials, shaders, assignments, textures and attributes that collectively define a look of a model for rendering or preview purposes. This can usually be applied only to the model is was authored for, or its corresponding cache, however, material sharing across multiple models is also possible. A look should be fully self-contained and ready for rendering.
Example Subsets:
`lookMain`, `lookProxy`, `lookWet`, `lookDirty`, `lookBlue`, `lookRed`
@@ -99,7 +99,7 @@ contains the attributes and assignments and `/resources` folder with all the req
### Rig
-Characters or props with animation controls or other parameters, ready to be referenced into a scene and animated. Animation Rigs tend to be very software specific, but in general they tend to consist of Geometry, Bones or Joints, Controllers and Deformers. Pype in maya supports both, self-contained rigs, that include everything in one file, but also rigs that use nested references to bring in geometry, or even skeleton. By default we bake rigs into a single file during publishing, but that behaviour can be turned off to keep the nested references live in the animation scenes.
+Characters or props with animation controls or other parameters, ready to be referenced into a scene and animated. Animation Rigs tend to be very software specific, but in general they tend to consist of Geometry, Bones or Joints, Controllers and Deformers. OpenPype in maya supports both, self-contained rigs, that include everything in one file, but also rigs that use nested references to bring in geometry, or even skeleton. By default we bake rigs into a single file during publishing, but that behaviour can be turned off to keep the nested references live in the animation scenes.
Example Subsets:
`rigMain`, `rigMocap`, `rigSim`, `rigCamera`, `rigMuscle`
diff --git a/website/docs/artist_tools.md b/website/docs/artist_tools.md
index d5efd5870f..f03ea8e249 100644
--- a/website/docs/artist_tools.md
+++ b/website/docs/artist_tools.md
@@ -39,10 +39,10 @@ In Nuke it's either converting an existing write node to a publishable one, or s
### Usage
1. select what you want to publish from your scenes
-2. Open Creator from Avalon menu
+2. Open *Creator* from OpenPype menu
3. Choose what family (data type) you need to export
4. Type the name for you export. This name is how others are going to be able to refer to this particular subset when loading it into their scenes. Every assets should have a Main subset, but can have any number of other variants.
-5. Click on Create
+5. Click on *Create*
* * *
@@ -50,14 +50,14 @@ In Nuke it's either converting an existing write node to a publishable one, or s
Loader loads published subsets into your current scene or script.
### Usage
-1. open Loader from pipeline menu
+1. open *Loader* from OpenPype menu
2. select the asset where the subset you want to load is published
3. from subset list select the subset you want
4. right-click the subset
5. from action menu select what you want to do *(load, reference, ...)*
-
+
@@ -151,12 +151,12 @@ Library loader is extended [loader](#loader) which allows to load published subs
@@ -212,7 +212,7 @@ Once a subset is loaded, it turns into a container within a scene. This containe
The scene manager has a simple GUI focused on efficiency. You can see everything that has been previously loaded into the scene, how many time it's been loaded, what version and a lot of other information. Loaded assets are grouped by their asset name, subset name and representation. This grouping gives ability to apply changes for all instances of the loaded asset *(e.g. when __tree__ is loaded 20 times you can easily update version for all of them)*.
-
+
To interact with any container, you need to right click it and you'll see a drop down with possible actions. The key actions for production are already implemented, but more will be added over time.
@@ -240,8 +240,7 @@ Select containers or subsets you want to change, right-click selection, press `S
It's tool in Scene inventory tool that gives ability to switch asset, subset and representation of loaded assets.
-
-
+
Because loaded asset is in fact representation of version published in asset's subset it is possible to switch each of this part *(representation, version, subset and asset)*, but with limitations. Limitations are obvious as you can imagine when you have loaded `.ma` representation of `modelMain` subset from `car` asset it is not possible to switch subset to `modelHD` and keep same representation if `modelHD` does not have published `.ma` representation. It is possible to switch multiple loaded assets at once that makes this tool very powerful helper if all published assets contain same subsets and representations.
@@ -249,7 +248,7 @@ Because loaded asset is in fact representation of version published in asset's s
Switch tool won't let you cross the border of limitations and inform you when you have to specify more if impossible combination occurs *(It is also possible that there will be no possible combination for selected assets)*. Border is colored to red and confirm button is not enabled when specification is required.
-
+
Possible switches:
@@ -265,8 +264,7 @@ Possible switches:
We added one more switch layer above subset for LOD (Level Of Depth). That requires to have published subsets with name ending with **"_LOD{number}"** where number represents level (e.g. modelMain_LOD1). Has the same limitations as mentioned above. This is handy when you want to change only subset but keep same LOD or keep same subset but change LOD for multiple assets. This option is hidden if you didn't select subset that have published subset with LODs.
-
-
+
### Filtering
#### Filter by name
@@ -341,7 +339,7 @@ Let's say that the last version of the comp you published was v003 and now you'r
#### To open existing file:
-1. Open Workfiles tool from pipeline menu
+1. Open Workfiles tool from OpenPype menu
2. Select file from list - the latest version is the highest *(descendent ordering)*
3. Press `Open` button
@@ -355,7 +353,7 @@ Let's say that the last version of the comp you published was v003 and now you'r
#### To save new workfile
-1. Open Workfiles tool from pipeline menu
+1. Open Workfiles tool from OpenPype menu
2. Press `Save As` button
3. You can add optional comment to the filename, that will be appended at the end
4. Press `OK`
@@ -382,3 +380,35 @@ Look Assigner has GUI is made of two parts. On the left you will see the list of
4. Choose "Assign"
At this point you should have a model with all it's shaders applied correctly. The tool automatically loads the latest look available.
+
+
+## Subset Manager
+
+> Subset Manager lists all items which are meant for publishig and will be published if Publish is triggered
+
+### Details
+
+One or more items (instances) could be published any time Publish process is started. Each this publishable
+item must be created by Creator tool previously. Subset Manager provides easy way how to check which items,
+and how many, will be published.
+
+It also provides clean and preferrable way how to remove unwanted item from publishing.
+
+### Usage
+
+Subset Manager has GUI is made of two parts. On the left you will see the list of all the available publishable items in the scene and on the right side, details about these items.
+
+
+
+Any time new item is Created, it will show up here.
+
+Currently there is only single action, 'Remove instance' which cleans workfile file from publishable item metadata.
+This might not remove underlying host item, it depends on host and implementation!
+
+It might also happen that user deletes underlying host item(for example layer in Photoshop) directly in the host, but metadata will stay.
+This could result in phantom issues during publishing. Use Subset Manager to purge workfile from abandoned items.
+
+Please check behaviour in host of your choice.
diff --git a/website/docs/assets/aftereffects_creator.png b/website/docs/assets/aftereffects_creator.png
new file mode 100644
index 0000000000..203ecb6fb7
Binary files /dev/null and b/website/docs/assets/aftereffects_creator.png differ
diff --git a/website/docs/assets/aftereffects_creator_after.png b/website/docs/assets/aftereffects_creator_after.png
new file mode 100644
index 0000000000..3933202f71
Binary files /dev/null and b/website/docs/assets/aftereffects_creator_after.png differ
diff --git a/website/docs/assets/aftereffects_loader.png b/website/docs/assets/aftereffects_loader.png
new file mode 100644
index 0000000000..9fd69b04f7
Binary files /dev/null and b/website/docs/assets/aftereffects_loader.png differ
diff --git a/website/docs/assets/aftereffects_publish.png b/website/docs/assets/aftereffects_publish.png
new file mode 100644
index 0000000000..4cfe3d1d6b
Binary files /dev/null and b/website/docs/assets/aftereffects_publish.png differ
diff --git a/website/docs/assets/nuke_applyAllSettings.png b/website/docs/assets/nuke_applyAllSettings.png
index 0898430f91..913140fed1 100644
Binary files a/website/docs/assets/nuke_applyAllSettings.png and b/website/docs/assets/nuke_applyAllSettings.png differ
diff --git a/website/docs/assets/nuke_buildFirstWorkfile.png b/website/docs/assets/nuke_buildFirstWorkfile.png
index 96b3bca6eb..eab8f21a4a 100644
Binary files a/website/docs/assets/nuke_buildFirstWorkfile.png and b/website/docs/assets/nuke_buildFirstWorkfile.png differ
diff --git a/website/docs/assets/nuke_setColorspace.png b/website/docs/assets/nuke_setColorspace.png
index 2e968f96fe..8895c30594 100644
Binary files a/website/docs/assets/nuke_setColorspace.png and b/website/docs/assets/nuke_setColorspace.png differ
diff --git a/website/docs/assets/nuke_setFrameRanges.png b/website/docs/assets/nuke_setFrameRanges.png
index e4cf4b56a2..0289fc4dba 100644
Binary files a/website/docs/assets/nuke_setFrameRanges.png and b/website/docs/assets/nuke_setFrameRanges.png differ
diff --git a/website/docs/assets/nuke_setResolution.png b/website/docs/assets/nuke_setResolution.png
index 30e62ee9e5..3e40619884 100644
Binary files a/website/docs/assets/nuke_setResolution.png and b/website/docs/assets/nuke_setResolution.png differ
diff --git a/website/docs/assets/photoshop_extension.PNG b/website/docs/assets/photoshop_extension.PNG
index 6277aca387..ef7081443d 100644
Binary files a/website/docs/assets/photoshop_extension.PNG and b/website/docs/assets/photoshop_extension.PNG differ
diff --git a/website/docs/assets/settings/Screenshot_1.png b/website/docs/assets/settings/Screenshot_1.png
new file mode 100644
index 0000000000..12c34e8f05
Binary files /dev/null and b/website/docs/assets/settings/Screenshot_1.png differ
diff --git a/website/docs/assets/settings/anatomy_01.png b/website/docs/assets/settings/anatomy_01.png
new file mode 100644
index 0000000000..92b7e880d6
Binary files /dev/null and b/website/docs/assets/settings/anatomy_01.png differ
diff --git a/website/docs/assets/settings/anatomy_roots01.png b/website/docs/assets/settings/anatomy_roots01.png
new file mode 100644
index 0000000000..56cda7345b
Binary files /dev/null and b/website/docs/assets/settings/anatomy_roots01.png differ
diff --git a/website/docs/assets/settings/anatomy_roots02.png b/website/docs/assets/settings/anatomy_roots02.png
new file mode 100644
index 0000000000..e55793118f
Binary files /dev/null and b/website/docs/assets/settings/anatomy_roots02.png differ
diff --git a/website/docs/assets/settings/anatomy_roots03.png b/website/docs/assets/settings/anatomy_roots03.png
new file mode 100644
index 0000000000..9c47a189fe
Binary files /dev/null and b/website/docs/assets/settings/anatomy_roots03.png differ
diff --git a/website/docs/assets/settings/applications_01.png b/website/docs/assets/settings/applications_01.png
new file mode 100644
index 0000000000..52c31f6649
Binary files /dev/null and b/website/docs/assets/settings/applications_01.png differ
diff --git a/website/docs/assets/settings/colours_01.png b/website/docs/assets/settings/colours_01.png
new file mode 100644
index 0000000000..927c6e0a2b
Binary files /dev/null and b/website/docs/assets/settings/colours_01.png differ
diff --git a/website/docs/assets/settings/colours_02.png b/website/docs/assets/settings/colours_02.png
new file mode 100644
index 0000000000..b304fa35f3
Binary files /dev/null and b/website/docs/assets/settings/colours_02.png differ
diff --git a/website/docs/assets/settings/override_breadcrumbs.png b/website/docs/assets/settings/override_breadcrumbs.png
new file mode 100644
index 0000000000..03eea756ef
Binary files /dev/null and b/website/docs/assets/settings/override_breadcrumbs.png differ
diff --git a/website/docs/assets/settings/studio_defaults.gif b/website/docs/assets/settings/studio_defaults.gif
new file mode 100644
index 0000000000..4825e60501
Binary files /dev/null and b/website/docs/assets/settings/studio_defaults.gif differ
diff --git a/website/docs/assets/settings/studio_defaults_remove.gif b/website/docs/assets/settings/studio_defaults_remove.gif
new file mode 100644
index 0000000000..cedd9803d4
Binary files /dev/null and b/website/docs/assets/settings/studio_defaults_remove.gif differ
diff --git a/website/docs/assets/settings/tools_01.png b/website/docs/assets/settings/tools_01.png
new file mode 100644
index 0000000000..9837309994
Binary files /dev/null and b/website/docs/assets/settings/tools_01.png differ
diff --git a/website/docs/assets/tools_subset_manager.png b/website/docs/assets/tools_subset_manager.png
new file mode 100644
index 0000000000..6a1e48dbd5
Binary files /dev/null and b/website/docs/assets/tools_subset_manager.png differ
diff --git a/website/docs/changelog.md b/website/docs/changelog.md
index 13f220c58c..bec4a02173 100644
--- a/website/docs/changelog.md
+++ b/website/docs/changelog.md
@@ -4,18 +4,109 @@ title: Changelog
sidebar_label: Changelog
---
-
+## [2.16.0](https://github.com/pypeclub/pype/tree/2.16.0)
-## [2.15.0](https://github.com/pypeclub/pype/tree/2.15.0)
-
-_**release date:** 2021-02-08_
-
-[Full Changelog](https://github.com/pypeclub/pype/compare/2.15.0-rc1...2.15.0)
+ _**release date:** 2021-03-22_
+
+[Full Changelog](https://github.com/pypeclub/pype/compare/2.15.3...2.16.0)
**Enhancements:**
+- Nuke: deadline submit limit group filter [\#1167](https://github.com/pypeclub/pype/pull/1167)
+- Maya: support for Deadline Group and Limit Groups - backport 2.x [\#1156](https://github.com/pypeclub/pype/pull/1156)
+- Maya: fixes for Redshift support [\#1152](https://github.com/pypeclub/pype/pull/1152)
+- Nuke: adding preset for a Read node name to all img and mov Loaders [\#1146](https://github.com/pypeclub/pype/pull/1146)
+- nuke deadline submit with environ var from presets overrides [\#1142](https://github.com/pypeclub/pype/pull/1142)
+- Change timers after task change [\#1138](https://github.com/pypeclub/pype/pull/1138)
+- Nuke: shortcuts for Pype menu [\#1127](https://github.com/pypeclub/pype/pull/1127)
+- Nuke: workfile template [\#1124](https://github.com/pypeclub/pype/pull/1124)
+- Sites local settings by site name [\#1117](https://github.com/pypeclub/pype/pull/1117)
+- Reset loader's asset selection on context change [\#1106](https://github.com/pypeclub/pype/pull/1106)
+- Bulk mov render publishing [\#1101](https://github.com/pypeclub/pype/pull/1101)
+- Photoshop: mark publishable instances [\#1093](https://github.com/pypeclub/pype/pull/1093)
+- Added ability to define BG color for extract review [\#1088](https://github.com/pypeclub/pype/pull/1088)
+- TVPaint extractor enhancement [\#1080](https://github.com/pypeclub/pype/pull/1080)
+- Photoshop: added support for .psb in workfiles [\#1078](https://github.com/pypeclub/pype/pull/1078)
+- Optionally add task to subset name [\#1072](https://github.com/pypeclub/pype/pull/1072)
+- Only extend clip range when collecting. [\#1008](https://github.com/pypeclub/pype/pull/1008)
+- Collect audio for farm reviews. [\#1073](https://github.com/pypeclub/pype/pull/1073)
+
+
+**Fixed bugs:**
+
+- Fix path spaces in jpeg extractor [\#1174](https://github.com/pypeclub/pype/pull/1174)
+- Maya: Bugfix: superclass for CreateCameraRig [\#1166](https://github.com/pypeclub/pype/pull/1166)
+- Maya: Submit to Deadline - fix typo in condition [\#1163](https://github.com/pypeclub/pype/pull/1163)
+- Avoid dot in repre extension [\#1125](https://github.com/pypeclub/pype/pull/1125)
+- Fix versions variable usage in standalone publisher [\#1090](https://github.com/pypeclub/pype/pull/1090)
+- Collect instance data fix subset query [\#1082](https://github.com/pypeclub/pype/pull/1082)
+- Fix getting the camera name. [\#1067](https://github.com/pypeclub/pype/pull/1067)
+- Nuke: Ensure "NUKE\_TEMP\_DIR" is not part of the Deadline job environment. [\#1064](https://github.com/pypeclub/pype/pull/1064)
+
+### [2.15.3](https://github.com/pypeclub/pype/tree/2.15.3)
+
+ _**release date:** 2021-02-26_
+
+[Full Changelog](https://github.com/pypeclub/pype/compare/2.15.2...2.15.3)
+
+**Enhancements:**
+
+- Maya: speedup renderable camera collection [\#1053](https://github.com/pypeclub/pype/pull/1053)
+- Harmony - add regex search to filter allowed task names for collectin… [\#1047](https://github.com/pypeclub/pype/pull/1047)
+
+**Fixed bugs:**
+
+- Ftrack integrate hierarchy fix [\#1085](https://github.com/pypeclub/pype/pull/1085)
+- Explicit subset filter in anatomy instance data [\#1059](https://github.com/pypeclub/pype/pull/1059)
+- TVPaint frame offset [\#1057](https://github.com/pypeclub/pype/pull/1057)
+- Auto fix unicode strings [\#1046](https://github.com/pypeclub/pype/pull/1046)
+
+### [2.15.2](https://github.com/pypeclub/pype/tree/2.15.2)
+
+ _**release date:** 2021-02-19_
+
+[Full Changelog](https://github.com/pypeclub/pype/compare/2.15.1...2.15.2)
+
+**Enhancements:**
+
+- Maya: Vray scene publishing [\#1013](https://github.com/pypeclub/pype/pull/1013)
+
+**Fixed bugs:**
+
+- Fix entity move under project [\#1040](https://github.com/pypeclub/pype/pull/1040)
+- smaller nuke fixes from production [\#1036](https://github.com/pypeclub/pype/pull/1036)
+- TVPaint thumbnail extract fix [\#1031](https://github.com/pypeclub/pype/pull/1031)
+
+### [2.15.1](https://github.com/pypeclub/pype/tree/2.15.1)
+
+ _**release date:** 2021-02-12_
+
+[Full Changelog](https://github.com/pypeclub/pype/compare/2.15.0...2.15.1)
+
+**Enhancements:**
+
+- Delete version as loader action [\#1011](https://github.com/pypeclub/pype/pull/1011)
+- Delete old versions [\#445](https://github.com/pypeclub/pype/pull/445)
+
+**Fixed bugs:**
+
+- PS - remove obsolete functions from pywin32 [\#1006](https://github.com/pypeclub/pype/pull/1006)
+- Clone description of review session objects. [\#922](https://github.com/pypeclub/pype/pull/922)
+
+## [2.15.0](https://github.com/pypeclub/pype/tree/2.15.0)
+
+ _**release date:** 2021-02-09_
+
+[Full Changelog](https://github.com/pypeclub/pype/compare/2.14.6...2.15.0)
+
+**Enhancements:**
+
+- Resolve - loading and updating clips [\#932](https://github.com/pypeclub/pype/pull/932)
+- Release/2.15.0 [\#926](https://github.com/pypeclub/pype/pull/926)
+- Photoshop: add option for template.psd and prelaunch hook [\#894](https://github.com/pypeclub/pype/pull/894)
- Nuke: deadline presets [\#993](https://github.com/pypeclub/pype/pull/993)
- Maya: Alembic only set attributes that exists. [\#986](https://github.com/pypeclub/pype/pull/986)
+- Harmony: render local and handle fixes [\#981](https://github.com/pypeclub/pype/pull/981)
- PSD Bulk export of ANIM group [\#965](https://github.com/pypeclub/pype/pull/965)
- AE - added prelaunch hook for opening last or workfile from template [\#944](https://github.com/pypeclub/pype/pull/944)
- PS - safer handling of loading of workfile [\#941](https://github.com/pypeclub/pype/pull/941)
@@ -29,13 +120,13 @@ _**release date:** 2021-02-08_
- Maya: handle referenced AOVs for Vray [\#824](https://github.com/pypeclub/pype/pull/824)
- DWAA/DWAB support on windows [\#795](https://github.com/pypeclub/pype/pull/795)
- Unreal: animation, layout and setdress updates [\#695](https://github.com/pypeclub/pype/pull/695)
-- Photoshop: add option for template.psd and prelaunch hook [\#894](https://github.com/pypeclub/pype/pull/894)
**Fixed bugs:**
- Maya: Looks - disable hardlinks [\#995](https://github.com/pypeclub/pype/pull/995)
- Fix Ftrack custom attribute update [\#982](https://github.com/pypeclub/pype/pull/982)
- Prores ks in burnin script [\#960](https://github.com/pypeclub/pype/pull/960)
+- terminal.py crash on import [\#839](https://github.com/pypeclub/pype/pull/839)
- Extract review handle bizarre pixel aspect ratio [\#990](https://github.com/pypeclub/pype/pull/990)
- Nuke: add nuke related env var to sumbission [\#988](https://github.com/pypeclub/pype/pull/988)
- Nuke: missing preset's variable [\#984](https://github.com/pypeclub/pype/pull/984)
@@ -44,6 +135,7 @@ _**release date:** 2021-02-08_
- nuke: wrong frame offset in mov loader [\#971](https://github.com/pypeclub/pype/pull/971)
- Create project structure action fix multiroot [\#967](https://github.com/pypeclub/pype/pull/967)
- PS: remove pywin installation from hook [\#964](https://github.com/pypeclub/pype/pull/964)
+- Prores ks in burnin script [\#959](https://github.com/pypeclub/pype/pull/959)
- Subset family is now stored in subset document [\#956](https://github.com/pypeclub/pype/pull/956)
- DJV new version arguments [\#954](https://github.com/pypeclub/pype/pull/954)
- TV Paint: Fix single frame Sequence [\#953](https://github.com/pypeclub/pype/pull/953)
@@ -55,10 +147,14 @@ _**release date:** 2021-02-08_
- Maya: Deadline submitter - shared data access violation [\#831](https://github.com/pypeclub/pype/pull/831)
- Maya: Take into account vray master AOV switch [\#822](https://github.com/pypeclub/pype/pull/822)
-### [2.14.6](https://github.com/pypeclub/pype/tree/2.14.6)
+**Merged pull requests:**
-_**release date:** 2021-01-15_
+- Refactor blender to 3.0 format [\#934](https://github.com/pypeclub/pype/pull/934)
+### [2.14.6](https://github.com/pypeclub/pype/tree/2.14.6)
+
+ _**release date:** 2021-01-15_
+
[Full Changelog](https://github.com/pypeclub/pype/compare/2.14.5...2.14.6)
**Fixed bugs:**
@@ -70,34 +166,30 @@ _**release date:** 2021-01-15_
- Hiero: cut videos with correct secons [\#892](https://github.com/pypeclub/pype/pull/892)
- Faster sync to avalon preparation [\#869](https://github.com/pypeclub/pype/pull/869)
+### [2.14.5](https://github.com/pypeclub/pype/tree/2.14.5)
-
-
-### [2.14.5](https://github.com/pypeclub/pype/tree/2.14.5)
-
-_**release date:** 2021-01-06_
-
+ _**release date:** 2021-01-06_
+
[Full Changelog](https://github.com/pypeclub/pype/compare/2.14.4...2.14.5)
-
+**Merged pull requests:**
-### [2.14.4](https://github.com/pypeclub/pype/tree/2.14.4)
+- Pype logger refactor [\#866](https://github.com/pypeclub/pype/pull/866)
-_**release date:** 2020-12-18_
+### [2.14.4](https://github.com/pypeclub/pype/tree/2.14.4)
+ _**release date:** 2020-12-18_
+
[Full Changelog](https://github.com/pypeclub/pype/compare/2.14.3...2.14.4)
**Merged pull requests:**
- Fix - AE - added explicit cast to int [\#837](https://github.com/pypeclub/pype/pull/837)
+### [2.14.3](https://github.com/pypeclub/pype/tree/2.14.3)
-
-
-### [2.14.3](https://github.com/pypeclub/pype/tree/2.14.3)
-
-_**release date:** 2020-12-16_
-
+ _**release date:** 2020-12-16_
+
[Full Changelog](https://github.com/pypeclub/pype/compare/2.14.2...2.14.3)
**Fixed bugs:**
@@ -110,21 +202,20 @@ _**release date:** 2020-12-16_
- respecting space in path [\#823](https://github.com/pypeclub/pype/pull/823)
-
-
### [2.14.2](https://github.com/pypeclub/pype/tree/2.14.2)
-_**release date:** 2020-12-04_
-
+ _**release date:** 2020-12-04_
+
[Full Changelog](https://github.com/pypeclub/pype/compare/2.14.1...2.14.2)
**Enhancements:**
-- AE: load background [\#774](https://github.com/pypeclub/pype/pull/774)
+- Collapsible wrapper in settings [\#767](https://github.com/pypeclub/pype/pull/767)
**Fixed bugs:**
- Harmony: template extraction and palettes thumbnails on mac [\#768](https://github.com/pypeclub/pype/pull/768)
+- TVPaint store context to workfile metadata \(764\) [\#766](https://github.com/pypeclub/pype/pull/766)
- Extract review audio cut fix [\#763](https://github.com/pypeclub/pype/pull/763)
**Merged pull requests:**
@@ -132,14 +223,17 @@ _**release date:** 2020-12-04_
- AE: fix publish after background load [\#781](https://github.com/pypeclub/pype/pull/781)
- TVPaint store members key [\#769](https://github.com/pypeclub/pype/pull/769)
-
-
### [2.14.1](https://github.com/pypeclub/pype/tree/2.14.1)
-_**release date:** 2020-11-27_
+ _**release date:** 2020-11-27_
[Full Changelog](https://github.com/pypeclub/pype/compare/2.14.0...2.14.1)
+**Enhancements:**
+
+- Settings required keys in modifiable dict [\#770](https://github.com/pypeclub/pype/pull/770)
+- Extract review may not add audio to output [\#761](https://github.com/pypeclub/pype/pull/761)
+
**Fixed bugs:**
- After Effects: frame range, file format and render source scene fixes [\#760](https://github.com/pypeclub/pype/pull/760)
@@ -149,7 +243,6 @@ _**release date:** 2020-11-27_
- Maya: multiple renderable cameras in layer didn't work [\#744](https://github.com/pypeclub/pype/pull/744)
- Ftrack integrate custom attributes fix [\#742](https://github.com/pypeclub/pype/pull/742)
-
## [2.14.0](https://github.com/pypeclub/pype/tree/2.14.0)
diff --git a/website/docs/dev_build.md b/website/docs/dev_build.md
new file mode 100644
index 0000000000..01e53918d2
--- /dev/null
+++ b/website/docs/dev_build.md
@@ -0,0 +1,191 @@
+---
+id: dev_build
+title: Build openPYPE from source
+sidebar_label: Build
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+To build Pype you currently need (on all platforms):
+
+- **[Python 3.7](https://www.python.org/downloads/)** as we are following [vfx platform](https://vfxplatform.com).
+- **[git](https://git-scm.com/downloads)**
+
+We use [CX_Freeze](https://cx-freeze.readthedocs.io/en/latest) to freeze the code and all dependencies.
+
+
+
+
+
+
+More tools might be needed for installing some dependencies (for example for **OpenTimelineIO**) - mostly
+development tools like [CMake](https://cmake.org/) and [Visual Studio](https://visualstudio.microsoft.com/cs/downloads/)
+
+### Clone repository:
+```sh
+git clone --recurse-submodules git@github.com:pypeclub/pype.git
+```
+
+### Run from source
+
+For development purposes it is possible to run OpenPype directly from the source. We provide a simple launcher script for this.
+
+To start OpenPype from source you need to
+
+1) Run `.\tools\create_env.ps1` to create virtual environment in `.\venv`
+2) Run `.\tools\run_tray.ps1` if you have all required dependencies on your machine you should be greeted with OpenPype igniter window and once you give it your Mongo URL, with OpenPype icon in the system tray.
+
+
+### To build openPype:
+
+1) Run `.\tools\create_env.ps1` to create virtual environment in `.\venv`
+2) Run `.\tools\build.ps1` to build pype executables in `.\build\`
+
+To create distributable openPype versions, run `./tools/create_zip.ps1` - that will
+create zip file with name `pype-vx.x.x.zip` parsed from current pype repository and
+copy it to user data dir. You can specify `--path /path/to/zip` to force it into a different
+location. This can be used to prepare new version releases for artists in the studio environment
+without the need to re-build the whole package
+
+
+
+
+
+
+To build pype on linux you wil need:
+
+- **[curl](https://curl.se)** on systems that doesn't have one preinstalled.
+- Python header files installed (**python3-dev** on Ubuntu for example).
+- **[CMake](https://cmake.org/)**: to build some external openPype dependencies.
+- **bzip2**, **readline** and **sqlite3** libraries.
+
+Because some Linux distros come with newer Python version pre-installed, you might
+need to install **3.7** version and make use of it explicitly.
+Your best bet is probably using [pyenv](https://github.com/pyenv/pyenv).
+
+You can use your package manager to install **git** and **cmake**.
+Use curl for pyenv installation
+
+:::note Install build requirements for **Ubuntu**
+
+
+```sh
+sudo apt install build-essential checkinstall
+sudo apt install git cmake curl
+sudo apt install libbz2-dev libreadline-dev libsqlite3-dev
+```
+
+In case you run in error about `xcb` when running Pype,
+you'll need also additional libraries for Qt5:
+
+```sh
+sudo apt install qt5-default
+```
+:::
+
+:::note Install build requirements for **Centos**
+
+```sh
+sudo yum install git cmake python3-devel python3-pip
+sudo yum install bzip2-devel readline-devel sqlite-devel
+```
+
+In case you run in error about `xcb` when running Pype,
+you'll need also additional libraries for Qt5:
+
+```sh
+sudo yum install qt5-qtbase-devel
+```
+
+:::
+
+#### Common steps for all Distros
+
+Use pyenv to prepare Python version for Pype build
+
+```sh
+curl https://pyenv.run | bash
+
+# you can add those to ~/.bashrc
+export PATH="$HOME/.pyenv/bin:$PATH"
+eval "$(pyenv init -)"
+eval "$(pyenv virtualenv-init -)"
+
+# reload shell
+exec $SHELL
+
+# install Python 3.7.9
+pyenv install -v 3.7.9
+
+# change path to pype 3
+cd /path/to/pype-3
+
+# set local python version
+pyenv local 3.7.9
+
+```
+
+#### To build Pype:
+
+1. Run `.\tools\create_env.sh` to create virtual environment in `.\venv`
+2. Run `.\tools\build.sh` to build pype executables in `.\build\`
+
+
+
+
+To build pype on MacOS you wil need:
+
+- **[Homebrew](https://brew.sh)**, Easy way of installing everything necessary is to use.
+- **[CMake](https://cmake.org/)** to build some external openPype dependencies.
+- **XCode Command Line Tools** (or some other build system)
+
+1) Install **Homebrew**:
+```sh
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+2) Install **cmake**:
+```sh
+brew install cmake
+```
+
+3) Install [pyenv](https://github.com/pyenv/pyenv):
+```sh
+brew install pyenv
+echo 'eval "$(pypenv init -)"' >> ~/.zshrc
+pyenv init
+exec "$SHELL"
+PATH=$(pyenv root)/shims:$PATH
+```
+
+4) Pull in required Python version 3.7.x
+```sh
+# install Python build dependences
+brew install openssl readline sqlite3 xz zlib
+
+# replace with up-to-date 3.7.x version
+pyenv install 3.7.9
+```
+
+5) Set local Python version
+```sh
+# switch to Pype source directory
+pyenv local 3.7.9
+```
+
+#### To build Pype:
+
+1. Run `.\tools\create_env.sh` to create virtual environment in `.\venv`
+2. Run `.\tools\build.sh` to build Pype executables in `.\build\`
+
+
+
diff --git a/website/docs/dev_contribute.md b/website/docs/dev_contribute.md
new file mode 100644
index 0000000000..6655ec88c1
--- /dev/null
+++ b/website/docs/dev_contribute.md
@@ -0,0 +1,85 @@
+---
+id: dev_contribute
+title: Contribute to openPype development
+sidebar_label: Contribute
+---
+
+## What should you do if ...
+
+### You found a bug.
+
+1. Check in the issues and our [bug triage](https://github.com/pypeclub/pype/projects/2) to make sure it wasn't reported already.
+2. Ask on our [discord](http://pype.community/chat) Often, what appears as a bug, might be the intended behavior for someone else.
+3. Create a new issue.
+4. Use the issue template for you PR please.
+
+
+### You wrote a patch that fixes a bug.
+
+- Open a new GitHub pull request with the patch.
+- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+
+### You intend to add a new feature or change an existing one.
+
+- Open a new thread in the [github discussions](https://github.com/pypeclub/pype/discussions/new)
+- Do not open issue until the suggestion is discussed. We will convert accepted suggestions into backlog and point them to the relevant discussion thread to keep the context.
+
+### You have questions about the source code.
+
+Open a new question on [github discussions](https://github.com/pypeclub/pype/discussions/new)
+
+
+## Branching Strategy
+
+As we move to 3.x as the primary supported version of OpenPype and only keep Pype 2.15 on bugfixes and client sponsored feature requests, we need to be very careful with merging strategy.
+
+These are the important branches to remember.
+
+### OpenPype 3.x
+
+**`main`** - Production branch with stable releases
+
+**`develop`** - Development branch where we merge all PRs during the development
+
+**`release/3.x.x`** - Testing branch for a release, once a release branch is crated, no new features
+are accepted for the given release. Bugfixes, however, are expected. Once the branch is stable it is
+merged to `main` and `develop` and `main` is tagged with a new release
+
+**`feature/{Issue#}-{Issue_name}`** - development of new features
+
+**`bugfix/{Issue#}-{Issue_name}`** - bug fixes
+
+**`hotfix/{Issue#}-{Issue_name}`** - production critical hotfixes (always created from `main`)
+
+### OpenPype 2.x
+
+Branching is identical to 3.x development, however all the branches should be pre-pended with
+`2.x/` namespace. For example `2.x/feature/1025-support_exporting_of_alembic`,
+`2.x/bugfix/wrong_colourspace_in_maya`
+
+Main and develop for 2.x development are `2.x/main` and `2.x/develop`
+
+
+A few important notes about 2.x and 3.x development:
+
+- 3.x features are not backported to 2.x unless specifically requested.
+- 3.x bugs and hotfixes can be ported to 2.x if they are relevant or severe.
+- 2.x features and bugs MUST be ported to 3.x at the same time.
+
+## Pull Requests
+
+- Each 2.x PR MUST have a corresponding 3.x PR in github. Without 3.x PR, 2.x features will not be merged! Luckily most of the code is compatible, albeit sometimes in a different place after the refactoring. Porting from 2.x to 3.x should be really easy.
+- Please keep the corresponding 2 and 3 PR names the same so they can be easily identified from the PR list page.
+- Each 2.x PR should be labeled with `2.x-dev` label.
+
+Inside each PR, put a link to the corresponding PR.
+
+Of course if you want to contribute, feel free to make a PR to only 2.x/develop or develop, based on what you are using. While reviewing the PRs, we might convert the code to corresponding PR for the other release ourselves.
+
+We might also change the target of you PR to and intermediate branch, rather than `develop` if we feel it requires some extra work on our end. That way, we preserve all your commits so you don't loos out on the contribution credits.
+
+
+
+
+If a PR is targeted at 2.x release it must be labelled with 2x-dev label in Github.
\ No newline at end of file
diff --git a/website/docs/dev_requirements.md b/website/docs/dev_requirements.md
new file mode 100644
index 0000000000..bbf3b1fb5b
--- /dev/null
+++ b/website/docs/dev_requirements.md
@@ -0,0 +1,131 @@
+---
+id: dev_requirements
+title: Requirements
+sidebar_label: Requirements
+---
+
+
+We aim to closely follow [**VFX Reference Platform**](https://vfxplatform.com/)
+
+OpenPype is written in Python 3 with specific elements still running in Python2 until all DCCs are fully updated. To see the list of those, that are not quite there yet, go to [VFX Python3 tracker](https://vfxpy.com/)
+
+The main things you will need to run and build pype are:
+
+- **Terminal** in your OS
+ - PowerShell 5.0+ (Windows)
+ - Bash (Linux)
+- [**Python 3.7.8**](#python) or higher
+- [**MongoDB**](#database)
+
+
+## OS
+
+It can be built and ran on all common platforms. We develop and test on the following:
+
+- **Windows** 10
+- **Linux**
+ - **Ubuntu** 20.04 LTS
+ - **Centos** 7
+- **Mac OSX**
+ - **10.15** Catalina
+ - **11.1** Big Sur (using Rosetta2)
+
+
+## Database
+
+Pype needs site-wide installation of **MongoDB**. It should be installed on
+reliable server, that all workstations (and possibly render nodes) can connect. This
+server holds **Avalon** database that is at the core of everything
+
+Depending on project size and number of artists working connection speed and
+latency influence performance experienced by artists. If remote working is required, this mongodb
+server must be accessible from Internet or cloud solution can be used. Reasonable backup plan
+or high availability options are recommended. *Replication* feature of MongoDB should be considered. This is beyond the
+scope of this documentation, please refer to [MongoDB Documentation](https://docs.mongodb.com/manual/replication/).
+
+Pype can run it's own instance of mongodb, mostly for testing and development purposes.
+For that it uses locally installed MongoDB.
+
+Download it from [mognoDB website](https://www.mongodb.com/download-center/community), install it and
+add to the `PATH`. On Windows, Pype tries to find it in standard installation destination or using `PATH`.
+
+To run mongoDB on server, use your server distribution tools to set it up (on Linux).
+
+## Python
+
+**Python 3.7.8** is the recommended version to use (as per [VFX platform CY2021](https://vfxplatform.com/)).
+
+If you're planning to run openPYPE on workstations from built executables (highly recommended), you will only need python for building and development, however, if you'd like to run from source centrally, every user will need python installed.
+
+## Hardware
+
+openPYPE should be installed on all workstations that need to use it, the same as any other application.
+
+There are no specific requirements for the hardware. If the workstation can run
+the major DCCs, it most probably can run openPYPE.
+
+Installed, it takes around 400MB of space, depending on the platform
+
+
+For well functioning ftrack event server, we recommend a linux virtual server with Ubuntu or CentOS. CPU and RAM allocation needs differ based on the studio size, but a 2GB of ram, with a dual core CPU and around 4GB of storage should suffice
+
+
+## Deployment
+
+For pushing pipeline updates to the artists, you will need to create a shared folder that
+will be accessible with at least Read permission to every OpenPype user in the studio.
+This can also be hosted on the cloud in fully distributed deployments.
+
+
+
+## Dependencies
+
+### Key projects we depend on
+
+- [**Avalon**](https://github.com/getavalon)
+- [**Pyblish**](https://github.com/pyblish)
+- [**OpenTimelineIO**](https://github.com/PixarAnimationStudios/OpenTimelineIO)
+- [**OpenImageIO**](https://github.com/OpenImageIO/oiio)
+- [**FFmpeg**](https://github.com/FFmpeg/FFmpeg)
+
+
+### Python modules we use and their licenses
+
+| Package | License |
+|-------------------------------------|--------------------------------------------------------------|
+| acre 1.0.0 | GNU Lesser General Public License v3 (LGPLv3) |
+| aiohttp 3.7.3 | Apache 2 |
+| aiohttp-json-rpc 0.13.3 | Apache 2.0 |
+| appdirs 1.4.4 | MIT |
+| blessed 1.17.12 | MIT |
+| click 7.1.2 | BSD-3-Clause |
+| clique 1.5.0 | Apache License (2.0) |
+| coverage 5.3.1 | Apache 2.0 |
+| cx-Freeze 6.5.1 | Python Software Foundation License |
+| docutils 0.16 | public domain, Python, 2-Clause BSD, GPL 3 (see COPYING.txt) |
+| flake8 3.8.4 | MIT |
+| ftrack-python-api 2.0.0 | Apache License (2.0) |
+| jinxed 1.0.1 | MPLv2.0
+| log4mongo 1.7.0 | BSD |
+| OpenTimelineIO 0.14.0.dev1 | Modified Apache 2.0 License |
+| Pillow 8.1.0 | HPND |
+| pyblish-base 1.8.8 | LGPL |
+| pycodestyle 2.6.0 | Expat license |
+| pydocstyle 5.1.1 | MIT |
+| pylint 2.6.0 | GPL |
+| pymongo 3.11.2 | Apache License, Version 2.0 |
+| pynput 1.7.2 | LGPLv3 |
+| PyQt5 5.15.2 | GPL v3 |
+| pytest 6.2.1 | MIT |
+| pytest-cov 2.11.0 | MIT |
+| pytest-print 0.2.1 | MIT |
+| pywin32-ctypes 0.2.0 | BSD |
+| Qt.py 1.3.2 | MIT |
+| six 1.15.0 | MIT |
+| speedcopy 2.1.0 | UNKNOWN |
+| Sphinx 3.4.3 | BSD |
+| sphinx-qt-documentation 0.3 | BSD-3-Clause |
+| sphinxcontrib-websupport 1.2.4 | BSD |
+| tqdm 4.56.0 | MPLv2.0, MIT Licences |
+| wheel 0.36.2 | MIT |
+| wsrpc-aiohttp 3.1.1 | Apache Software License |
diff --git a/website/docs/manager_ftrack.md b/website/docs/manager_ftrack.md
index d800fbd0ad..69faf6ae9d 100644
--- a/website/docs/manager_ftrack.md
+++ b/website/docs/manager_ftrack.md
@@ -4,13 +4,13 @@ title: Ftrack
sidebar_label: Project Manager
---
-Ftrack is currently the main project management option for Pype. This documentation assumes that you are familiar with Ftrack and it's basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](http://ftrack.rtd.ftrack.com/en/stable/).
+Ftrack is currently the main project management option for OpenPype. This documentation assumes that you are familiar with Ftrack and it's basic principles. If you're new to Ftrack, we recommend having a thorough look at [Ftrack Official Documentation](http://ftrack.rtd.ftrack.com/en/stable/).
## Project management
Setting project attributes is the key to properly working pipeline.
### New Project
-The best practice for creating a new project ready for pype.
+The best practice for creating a new project ready for OpenPype.
1. First of all you must [create a project](http://ftrack.rtd.ftrack.com/en/stable/using/managing_projects/creating_a_new_project.html) in Ftrack.
2. All the required attributes need to be populated. The easiest way to do it is by using [Prepare Project](manager_ftrack_actions#prepare-project) action.
@@ -31,7 +31,7 @@ This process is how data from Ftrack will get into Avalon database.
### How to synchronize
You can do synchronization with [Sync To Avalon](manager_ftrack_actions#sync-to-avalon) action.
-Synchronization can be automated with Pype's [event server](#event-server) and synchronization events. If your Ftrack is [prepared for pype](#prepare-ftrack-for-pype), the project should have custom attribute `Avalon auto-sync`. Check the custom attribute to allow auto-updates with event server.
+Synchronization can be automated with OpenPype's [event server](#event-server) and synchronization events. If your Ftrack is [prepared for OpenPype](#prepare-ftrack-for-pype), the project should have custom attribute `Avalon auto-sync`. Check the custom attribute to allow auto-updates with event server.
:::important
Always use `Sync To Avalon` action before you enable `Avalon auto-sync`!
@@ -57,6 +57,6 @@ There are certain situations that are very hard, or even impossible to handle au
- Re-structuring the project hierarchy when work is already being done.
- Renaming the Project
-If you need to move entity or change it's name it is possible only in the acse when no-one has worked on it yet. Once work is in progreess, you must archive the old one and create new.
+If you need to move entity or change its name it is possible only in the acse when no-one has worked on it yet. Once work is in progreess, you must archive the old one and create new.
-To archive entities you should use [Archive Asset/Subset](manager_ftrack_actions#delete-asset/subset) action. This will remove the selected entity from ftrack and avalon database in mostly non-destructive way, so it can be recovered later. To completely delete all traces of this such entity you'll need to go to pype archive and delete them from there.
+To archive entities you should use [Archive Asset/Subset](manager_ftrack_actions#delete-asset/subset) action. This will remove the selected entity from ftrack and avalon database in mostly non-destructive way, so it can be recovered later. To completely delete all traces of this such entity you'll need to go to OpenPype archive and delete them from there.
diff --git a/website/docs/manager_ftrack_actions.md b/website/docs/manager_ftrack_actions.md
index 27e96fd585..6349d4357f 100644
--- a/website/docs/manager_ftrack_actions.md
+++ b/website/docs/manager_ftrack_actions.md
@@ -39,7 +39,7 @@ Filtering can be more complicated for example a lot of actions can be shown only
* Entity types: Task
* User roles: All
-These actions *launch application with Pype initiated* and *start timer* for the selected Task. We recommend you to launch application this way.
+These actions *launch application with OpenPype initiated* and *start timer* for the selected Task. We recommend you to launch application this way.
:::important
Project Manager or Supervisor must set project's applications during project preparation otherwise you won't see them.
@@ -69,7 +69,7 @@ You must have DJV View installed and configured in studio-config to be able use
-## Pype Admin
+## OpenPype Admin
@@ -77,23 +77,23 @@ You must have DJV View installed and configured in studio-config to be able use
-A group of actions that are used for Pype Administration.
+A group of actions that are used for OpenPype Administration.
### Create/Update Avalon Attributes
* Entity types: All
* User roles: Pypeclub, Administrator
-Action creates and updates Ftrack's Custom Attributes that are needed to manage and run Pype within Ftrack. Most of custom attribute configurations are stored in Pype presets (*~/presets/ftrack/ftrack_custom_attributes.json*). It is not recommended to modify values stored in the file unless your studio used completely custom configuration.
+Action creates and updates Ftrack's Custom Attributes that are needed to manage and run OpenPype within Ftrack. Most of custom attribute configurations are stored in OpenPype presets (*Pype Settings → Project → Anatomy → Attributes*). It is not recommended to modify values stored in the file unless your studio used completely custom configuration.
### Sync to Avalon
* Entity types: Project, Typed Context
* User roles: Pypeclub, Administrator, Project manager
-Synchronization to Avalon is key process to keep Pype data updated. Action updates selected entities (Project, Shot, Sequence, etc.) and all nested entities to Avalon database. If action is successfully finished [Sync Hier Attrs](#sync-hier-attrs) action is triggered.
+Synchronization to Avalon is key process to keep OpenPype data updated. Action updates selected entities (Project, Shot, Sequence, etc.) and all nested entities to Avalon database. If action is successfully finished [Sync Hier Attrs](#sync-hier-attrs) action is triggered.
There are 2 versions of **Sync to Avalon** first labeled as **server** second as **local**.
* **server** version will be processed with [event server](admin_ftrack#event-server)
-* **local** version will be processed with user's Pype tray application
+* **local** version will be processed with user's OpenPype tray application
It is recommended to use **local** version if possible to avoid unnecessary deceleration of event server.
@@ -105,7 +105,7 @@ Synchronization to Avalon of Ftrack's hierarchical Custom attributes is a bit co
There are 2 versions of **Sync Hier Attrs** first labeled as **server** second as **local**.
* **server** version will be processed with [event server](admin_ftrack#event-server)
-* **local** version will be processed with user's Pype tray application
+* **local** version will be processed with user's OpenPype tray application
It is recommended to use **local** version if possible to avoid unnecessary deceleration of event server.
@@ -147,35 +147,6 @@ Propagates the thumbnail of the selected entity to its first direct children ent
-
-A group of actions that are used after significant workflow or Pype codebase changes. They are mostly single-use.
-
-### Custom attr doc (deprecated)
-This action is project specific and fixes some custom attributes after previous significant and backwards incompatible changes introduced during early Pype development.
-
-Pype requires few changes in Ftrack's default custom attributes, specifically **Frame start**, **Frame end** and **Handles** *(fstart, fend, handles)*. This action modifies them based on these requirements. Splits **Handles** to **Frame handles start** and **Frame handles end** *(handleStart, handleEnd)* and sets **Frame start** and **Frame end** as hierarchical. Action is time-consuming hence it is possible to make changes only on specific projects. It also keeps a backup of values on older projects by adding **_old** suffix to the names of default custom attributes *(e.g. fstart_old)*.
-
-:::warning
-Do not remove Custom attributes with supplement **_old** if you didn't convert all projects. You'll lose that data if you do.
-:::
-
-
-### Attrs remap (deprecated)
-This action helps with changes of attributes that happened during early Pype development.
-
-Fixes are made in pipeline database. Action is required when you update Pype pipeline to version 2.1.0 or higher. You can totally ignore this action if you never used an older version of Pype pipeline than version 2.1.0 .
-
----
-
-
-
## Prepare Project
@@ -187,7 +158,7 @@ Fixes are made in pipeline database. Action is required when you update Pype pip
* Entity types: Project
* User roles: Pypeclub, Administrator, Project manager
-Allows project managers and coordinator to *set basic project attributes* needed for Pype to operate, *Create project folders* if you want and especially *prepare Project specific [anatomy](admin_config#anatomy) and [presets](admin_config#presets)* files for you.
+Allows project managers and coordinator to *set basic project attributes* needed for OpenPype to operate, *Create project folders* if you want and especially *prepare Project specific [anatomy](admin_config#anatomy) and [presets](admin_config#presets)* files for you.
:::tip
It is possible to use this action during the lifetime of a project but we recommend using it only once at the start of the project.
@@ -249,7 +220,7 @@ You should use this action if you need to delete Entities or Asset Versions othe
*Create Project Structure* helps to create basic folder structure and may create the main ftrack entities for the project.
-Structure is loaded from [presets](admin_config#presets) *(~/presets/tools/project_folder_structure.json)*. You should examine that preset to see how it works. Preset may contain dictionaries of nested dictionaries where each key represents a folder name. Key and all it's parents will be also created in Ftrack if the key ends with `[ftrack]`. Default Ftrack entity type is *Folder* but entity type can be specified using `[ftrack.{entity type}]`. To create *Sequence* with name *Seq_001* key should look like `Seq_001[ftrack.Sequence]`.
+Structure is loaded from [presets](admin_config#presets) *(Pype Settings → Project → Global → Project Folder Structure)*. You should examine that preset to see how it works. Preset may contain dictionaries of nested dictionaries where each key represents a folder name. Key and all it's parents will be also created in Ftrack if the key ends with `[ftrack]`. Default Ftrack entity type is *Folder* but entity type can be specified using `[ftrack.{entity type}]`. To create *Sequence* with name *Seq_001* key should look like `Seq_001[ftrack.Sequence]`.
:::note
Please keep in mind this action is meant to make your project setup faster at the very beginning, but it does not create folders for each shot and asset. For creating asset folder refer to `Create Folders` Action
@@ -270,13 +241,16 @@ Please keep in mind this action is meant to make your project setup faster at th
* Entity types: Typed Context, Task
* User roles: All
-Creates folders for a selected asset in based on project [Anatomy](admin_config#anatomy) templates.
+Creates folders for a selected asset in based on project templates.
It is usually not necessary to launch this action because folders are created automatically every time you start working on a task. However it can be handy if you need to create folders before any work begins or you want to use applications that don't have pipeline implementation.
-:::tip
+
+
---
Multi-platform open-source pipeline built around the Avalon platform, expanding it with extra features and integrations. Pype connects asset database, project management and time tracking into a single modular system. It has tight integration with Ftrack, but it can also run independently.
+
Open-source pipeline for visual effects and animation built on top of the Avalon framework, expanding it with extra features and integrations. OpenPype connects your DCCs, asset database, project management and time tracking into a single system. It has a tight integration with Ftrack, but can also run independently or be integrated into a different project management solution.
- Avalon with Pype provides a safe and stable technical backbone for your studio, without the worry of a vendor lock. You will always have full access to the source and your project database will run locally.
+ OpenPype provides a robust platform for your studio, without the worry of a vendor lock. You will always have full access to the source-code and your project database will run locally or in the cloud of your choice.
+
-
About us
+
Why choose openPype?
- Our core team is formed from industry experts with years of production and pipeline experience. We perfectly understand the problems your studio is facing, because we’ve dealt with them, first hand, before. Instead of selling software, we offer our experience and time.
+ Pipeline is the technical backbone of your production. It means, that whatever solution you use, it will cause vendor-lock to some extend.
+ You can mitigate this risk by developing purely in-house tools, however, that just shifts the problem from a software vendor to your developers. Sooner or later, you'll hit the limits of such solution. In-house tools tend to be undocumented, narrow focused and heavily dependent on a very few or even a single developer.
+ OpenPYPE aims to solve these problems. It has dedicated and growing team of developers and support staff, that can provide the comfort of a commercial solution, while giving you the benefit of a full source-code access. You can build and deploy it yourself, or even fork and continue in-house if you're not happy about where openPYPE is heading in the future.
+ 
+ 
@@ -343,17 +328,22 @@ function Home() {
- Unreal Engine
+ Unreal Engine (Beta)
- After Effects (Beta)
+ After Effects
- TV Paint (Beta)
+ TV Paint
+
+
+
+ 
+ DaVinci Resolve (Alpha)
@@ -366,20 +356,27 @@ function Home() {
Storyboard Pro
-
- 
+
+