Modify artist docstrings to contain Publisher related information and images

This commit is contained in:
Jakub Trllo 2023-02-21 17:50:47 +01:00
parent 08e2d36f19
commit bd3207f2b6
3 changed files with 68 additions and 86 deletions

View file

@ -43,13 +43,55 @@ You can start your work.
## Usage
In TVPaint you can find the Tools in OpenPype menu extension. The OpenPype Tools menu should be available in your work area. However, sometimes it happens that the Tools menu is hidden. You can display the extension panel by going to `Windows -> Plugins -> OpenPype`.
## Create & Publish
As you might already know, to be able to publish, you have to mark what should be published. The marking part is called **Create**. In TVPaint you can create and publish **[Reviews](#review)**, **[Workfile](#workfile)**, **[Render Layers](#render-layer)** and **[Render Passes](#render-pass)**.
## Create
In TVPaint you can create and publish **[Reviews](#review)**, **[Workfile](#workfile)**, **[Render Passes](#render-pass)** and **[Render Layers](#render-layer)**.
:::important
TVPaint integration tries to not guess what you want to publish from the scene. Therefore, you should tell what you want to publish.
:::
You have the possibility to organize your layers by using `Color group`.
![createlayer](assets/tvp_publisher.png)
On the bottom left corner of your timeline, you will note a `Color group` button.
### Review
`Review` will render all visible layers and create a reviewable output.
- Is automatically created without any manual work.
- You can disable the created instance if you want to skip review.
### Workfile
`Workfile` integrate the source TVPaint file during publishing. Publishing of workfile is useful for backups.
- Is automatically created without any manual work.
- You can disable the created instance if you want to skip review.
### Render Layer
<div class="row markdown">
<div class="col col--6 markdown">
Render Layer bakes all the animation layers of one particular color group together.
- In the **Create** tab, pick `Render Layer`
- Fill `variant`, type in the name that the final published RenderLayer should have according to the naming convention in your studio. *(L10, BG, Hero, etc.)*
- Color group will be renamed to the **variant** value
- Choose color group from combobox
- or select a layer of a particular color and set combobox to **&ltUse selection&gt**
- Hit `Create` button
You have just created Render Layer. Now choose any amount of animation layers that need to be rendered together and assign them the color group.
You can change `variant` later in **Publish** tab.
</div>
<div class="col col--6 markdown">
![createlayer](assets/tvp_create_layer.png)
</div>
</div>
<br/>
**How to mark TVPaint layer to a group**
In the bottom left corner of your timeline, you will note a **Color group** button.
![colorgroups](assets/tvp_color_groups.png)
@ -61,63 +103,29 @@ The timeline's animation layer can be marked by the color you pick from your Col
![timeline](assets/tvp_timeline_color.png)
:::important
OpenPype specifically never tries to guess what you want to publish from the scene. Therefore, you have to tell OpenPype what you want to publish. There are three ways how to publish render from the scene.
:::
When you want to publish `review` or `render layer` or `render pass`, open the `Creator` through the Tools menu `Create` button.
### Review
`Review` renders the whole file as is and sends the resulting QuickTime to Ftrack.
- Is automatically created during publishing.
### Workfile
`Workfile` stores the source workfile as is during publishing (e.g. for backup).
- Is automatically created during publishing.
### Render Layer
<div class="row markdown">
<div class="col col--6 markdown">
Render Layer bakes all the animation layers of one particular color group together.
- Choose any amount of animation layers that need to be rendered together and assign them a color group.
- Select any layer of a particular color
- Go to `Creator` and choose `RenderLayer`.
- In the `Subset`, type in the name that the final published RenderLayer should have according to the naming convention in your studio. *(L10, BG, Hero, etc.)*
- Press `Create`
- When you run [publish](#publish), the whole color group will be rendered together and published as a single `RenderLayer`
</div>
<div class="col col--6 markdown">
![createlayer](assets/tvp_create_layer.png)
</div>
</div>
### Render Pass
Render Passes are smaller individual elements of a Render Layer. A `character` render layer might
Render Passes are smaller individual elements of a [Render Layer](artist_hosts_tvpaint.md#render-layer). A `character` render layer might
consist of multiple render passes such as `Line`, `Color` and `Shadow`.
Render Passes are specific because they have to belong to a particular Render Layer. You have to select to which Render Layer the pass belongs. Try to refresh if you don't see demanded Render Layer in the options.
<div class="row markdown">
<div class="col col--6 markdown">
Render Passes are specific because they have to belong to a particular layer. If you try to create a render pass and did not create any render layers before, an error message will pop up.
When you want to create `RenderPass`
- choose one or several animation layers within one color group that you want to publish
- In the Creator, pick `RenderPass`
- Fill the `Subset` with the name of your pass, e.g. `Color`.
When you want to create Render Pass
- choose one or several TVPaint layers
- In the **Create** tab, pick `Render Pass`
- Fill the `variant` with desired name of pass, e.g. `Color`.
- Select Render Layer to which belongs in Render Layer combobox
- If you don't see new Render Layer try refresh first
- Press `Create`
You have just created Render Pass. Selected TVPaint layers should be marked with color group of Render Layer.
You can change `variant` or Render Layer later in **Publish** tab.
</div>
<div class="col col--6 markdown">
@ -126,48 +134,22 @@ When you want to create `RenderPass`
</div>
</div>
:::warning
You cannot change TVPaint layer name once you mark it as part of Render Pass. You would have to remove created Render Pass and create it again with new TVPaint layer name.
:::
<br></br>
In this example, OpenPype will render selected animation layers within the given color group. E.i. the layers *L020_colour_fx*, *L020_colour_mouth*, and *L020_colour_eye* will be rendered as one pass belonging to the yellow RenderLayer.
![renderpass](assets/tvp_timeline_color2.png)
:::note
You can check your RendrePasses and RenderLayers in [Subset Manager](#subset-manager) or you can start publishing. The publisher will show you a collection of all instances on the left side.
:::
---
## Publish
<div class="row markdown">
<div class="col col--6 markdown">
Now that you have created the required instances, you can publish them via `Publish` tool.
- Click on `Publish` in OpenPype Tools menu.
- wait until all instances are collected.
- You can check on the left side whether all your instances have been created and are ready for publishing.
- Fill the comment on the bottom of the window.
- Press the `Play` button to publish
</div>
<div class="col col--6 markdown">
![pyblish](assets/tvp_pyblish_render.png)
</div>
</div>
Once the `Publisher` turns gets green your renders have been published.
---
## Subset Manager
All created instances (render layers, passes, and reviews) will be shown as a simple list. If you don't want to publish some, right click on the item in the list and select `Remove instance`.
![subsetmanager](assets/tvp_subset_manager.png)
Now that you have created the required instances, you can publish them.
- Fill the comment on the bottom of the window
- Double check enabled instance and their context
- Press `Publish`
- Wait to finish
- Once the `Publisher` turns gets green your renders have been published.
---

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 170 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 130 KiB

Before After
Before After