Include Addon READMEs in Pipeline Docs #49
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 9.2 KiB After Width: | Height: | Size: 9.2 KiB |
|
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 8.8 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 9.4 KiB After Width: | Height: | Size: 9.4 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 8.0 KiB After Width: | Height: | Size: 8.0 KiB |
|
Before Width: | Height: | Size: 8.6 KiB After Width: | Height: | Size: 8.6 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 9.8 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 7.1 KiB After Width: | Height: | Size: 7.1 KiB |
|
Before Width: | Height: | Size: 5.7 KiB After Width: | Height: | Size: 5.7 KiB |
|
Before Width: | Height: | Size: 7.0 KiB After Width: | Height: | Size: 7.0 KiB |
|
Before Width: | Height: | Size: 5.8 KiB After Width: | Height: | Size: 5.8 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 9.6 KiB After Width: | Height: | Size: 9.6 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
@ -44,7 +44,7 @@ If Kitsu is up and running and you can succesfully log in via the web interface
|
||||
|
||||
###### **Setup Login Data**
|
||||
|
||||
|
||||
|
||||
|
||||
>**Host**: The webadress of your kitsu server (e.G https://kitsu.mydomain.com)<br/>
|
||||
**Email**: The email you use to log in to kitsu<br/>
|
||||
@ -54,7 +54,7 @@ Press the login button. If the login was succesfull, the next step is..
|
||||
|
||||
###### **Setup Project Settings**
|
||||
|
||||
|
||||
|
||||
|
||||
>**Project Root Directory**: Path to the root of your project. Will later be used to configurate the addon on a per project basis<br/>
|
||||
|
||||
@ -62,7 +62,7 @@ Press the login button. If the login was succesfull, the next step is..
|
||||
###### **Setup Animation Tools**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
>**Playblast Root Directory**: Path to a directory in which playblasts will be saved to<br/>
|
||||
@ -72,19 +72,19 @@ Press the login button. If the login was succesfull, the next step is..
|
||||
|
||||
###### **Setup Lookdev Tools**
|
||||
|
||||
|
||||
|
||||
|
||||
>**Render Presets Directory**: Path to a directory in which you can save .py files that will be displayed in render preset dropdown. More info in: How to use render presets.<br/>
|
||||
|
||||
###### **Setup Media Search Paths**
|
||||
|
||||
|
||||
|
||||
|
||||
>**Path List**: List of paths to top level directorys. Only media that is a child (recursive) of one of these directories will be scanned for outdated media.<br/>
|
||||
|
||||
###### **Setup Miscellaneous**
|
||||
|
||||
|
||||
|
||||
|
||||
>**Thumbnail Directory**: Directory where thumbnails will be saved before uploading them to kitsu. Cannot be edited.<br/>
|
||||
**Sequence Editor Render Directory**: Directory where sequence editor renderings will be saved before uploading them to kitsu. Cannot be edited<br/>
|
||||
@ -103,7 +103,7 @@ blender-kitsu sequence editor tools were constructed with the idea in mind to ha
|
||||
##### Metastrips
|
||||
Metastrips are regular Movie Strips that can be linked to a shot in kitsu. It is a good idea to create a seperate meta strip in a seperate channel that represents the shot. That gives you the freedom to assemble a shot out of multiple elements, like multiple storyboard pictures, and still have one metastrip that contains the full shot range.
|
||||
|
||||
|
||||
|
||||
|
||||
>**Good to know**: A metastrip can have 3 states. It can be **initialized** but **not** linked yet. That means the movie strips knows I am a metastrip but I don't have a relationship to a shot on Kitsu yet. It can be **linked**, which means the strip is already initialized and is linked to a sequence_id and shot_id on Kitsu. Only if a strip is linked you can exchange metadata, push thumbnails etc. The last state is **uninitialized** which basically means it's a regular movie strips and has nothing to do with kitsu.
|
||||
|
||||
@ -113,7 +113,7 @@ This will import a metastrip.mp4 (1000 frame black video) file which is saved in
|
||||
|
||||
###### Initialize a Shot
|
||||
1. Select a metastrip and open the `Kitsu` tab in the sidebar of the sequence editor. You will find multiple ways on how to initialize your strip.
|
||||
|
||||
|
||||
|
||||
2. Case A: Shot does **already exist** on Kitsu
|
||||
|
||||
@ -121,7 +121,7 @@ This will import a metastrip.mp4 (1000 frame black video) file which is saved in
|
||||
|
||||
2.2 Alternatively you can also link a shot by pasting the URL. (e.G: https://kitsu.yourdomain.com/productions/fc77c0b9-bb76-41c3-b843-c9b156f9b3ec/shots/e7e6be02-5574-4764-9077-965d57b1ec12) <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
3. Case B: Shot **does not exist** on Kitsu yet
|
||||
|
||||
@ -134,12 +134,12 @@ This will import a metastrip.mp4 (1000 frame black video) file which is saved in
|
||||
3.4 Execute the `Submit New Shot` operator in the `Push` Panel (Will warn you if the shot already exists on Kitsu)
|
||||
|
||||
>**Note**: Most of the operatos are selection sensitive. So you can do these operations for a batch of seqeuence strips. If you have nothing selected it will usually try to operate on all strips in the sequence editor. <br/>
|
||||
|
||||
|
||||
|
||||
##### Metadata
|
||||
If you select a single linked strip you will see a `Metadata` panel that shows you the information that is related to the sequence and shot the strip is linking to.
|
||||
|
||||
|
||||
|
||||
|
||||
The frame range will be updated by using the Blender editing tools on the strip. (trimming, sliding, etc.). <br/>
|
||||
If you execute the `Initialize Shot Start Frame` operator (refresh icon) the current in point of the strip will be remapped so the shot starts at 101 in the current editing state. <br/>
|
||||
@ -147,7 +147,7 @@ You can reassign the shot to another seqeunce by exeucting the `Link Sequence` O
|
||||
|
||||
If you linked in a sequence that has no `["data"]["color"]` attribute on Kitsu yet the gpu overlay line will be white. In order to add a new sequence color execute the `Add Sequence Color` operator. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
All this information and more can be `pushed` to kitsu which bring us to the next panel. <br/>
|
||||
@ -156,7 +156,7 @@ All this information and more can be `pushed` to kitsu which bring us to the nex
|
||||
|
||||
In the `Push` panel you will find all the operators that push data to Kitsu. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
>**Metadata**: Pushes metadata of shot: sequence, shotname, frame range, sequence_color
|
||||
>>**Note**: Global edit frame range will be saved in `"frame_in"` `"frame_out"` kitsu shot attribute <br/>
|
||||
@ -169,35 +169,35 @@ If you select multiple metastrips it will always use the middle frame to create
|
||||
##### Pull
|
||||
In the `Pull` panel you will find all the operators that pull data from Kitsu to a metastrip. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
>**Metadata**: Pulls metadata of shot: sequence, shotname, shot description and updates the strip name to match the shotname.
|
||||
>>**Note**: Frame ranges will **never** be updated when pulling data from Kitsu. They belong to the edit and will only be pushed to Kitsu.<br/>
|
||||
|
||||
If you have not sequence selected the `Pull Entire Edit` Operator will appear in the `Pull` panel.<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
After you selected the channel it will go through all shots on Kitsu, create a metastrip which will be linked to the respective shot and pulls all metadata. <br/>
|
||||
It will use te `frame_in` and `frame_out` attribute on Kitsu to determine the in and out points in the edit. So make sure these are up to date and don't overlap. <br/>
|
||||
|
||||
As a result a bigger edit with nice sequence_colors can look pretty cool:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
##### Multi Edit
|
||||
|
||||
The `Multi Edit` panel only appears when you select multiple metastrips that are all `initialized` but not `linked` yet. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
It is meant to be way to quickly setup lots of shots if they don't exist on Kitsu yet. You specify the sequence all shots should belong to and adjust the `Shot Counter Start` value. In the preview property you can see how all shots will be named when you execute the `Multi Edit Strip` operator. <br/>
|
||||
|
||||
###### Advanced Settings
|
||||
If you check the `Advanced` checkbox next to the counter value, you have access to advance settings to customize the operator even more.
|
||||
|
||||
|
||||
|
||||
|
||||
You can adjust the number of counter digits, the incrementation size and also the `Pattern` it will use to generate the shot name. <br/>
|
||||
>**Pattern**: supports 3 wildcards. `<Sequence>`, `<Counter>`, `<Project>` that can be used multiple times in any order. <br/>
|
||||
@ -207,15 +207,15 @@ You can adjust the number of counter digits, the incrementation size and also th
|
||||
##### General Sequence Editor Tools
|
||||
In the general tab you can find some tools that don't directly relate to Kitsu but are useful for editing.
|
||||
|
||||
|
||||
|
||||
|
||||
`Scan for outdated media` will scan the selected / all sequence strips for their source media file. It searches for a later version in the same directory as the source media. If the current media file is outdated it will highlight that strip with a red line in the sequence editor:
|
||||
|
||||
|
||||
|
||||
|
||||
To update the outdated strips you can select them individually and by clicking the `Arrow Up` or `Arrow Down` you cycle through the available versions on disk. You will be prompted with an information if you reached the latest or oldest version.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
>**Note**: The operator searches for a version string e.G `v001` and checks files that are named the same but have a different version. <br/>
|
||||
@ -226,7 +226,7 @@ blender-kitsu context features were constructed with the idea in mind to create
|
||||
|
||||
To create 'context' you can find the `Context Browser` in the `Kitsu` panel in the sidebar of the 3D Viewport. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
By selecting the different drop down menus you can browse through the Kitsu file structure and set e.G the active sequence, active shot and task type you want to work on. <br/>
|
||||
|
||||
@ -239,7 +239,7 @@ Depending on which `Task Type` you select different tool sets will be available.
|
||||
The animation tools will show up when you selected a `Task Type` with the name `Animation`. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
>**Create Playblast**: Will create a openGL viewport render of the viewport from which the operator was executed and uploads it to Kitsu. The `+` button increments the version of the playblast. If you would override an older version you will see a warning before the filepath. The `directory` button will open a file browser in the playblast directory. The playblast will be uploaded to the `Animation` Task Type of the active shot that was set in the `Context Browser`. The webbrowser will be opened after the playblast and should point to the respective shot on Kitsu. <br/>
|
||||
**Update Frame Range**: Will pull the frame range of the active shot from Kitsu and apply it to the scene. It will use the `['data']['3d_in']` and `['data']['3d_out']` attribute of the Kitsu shot. <br/>
|
||||
@ -250,7 +250,7 @@ The animation tools will show up when you selected a `Task Type` with the name `
|
||||
##### Lookdev Tools
|
||||
The lookdev tools will show up when you selected a `Task Type` with the name `Lighting` | `Rendering` | `Compositing`. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
>**Apply Render Preset**: Consists of a dropdown menu that displays all `.py` files which are present in the `Render Presets Directory` (defined in the addon preferences). Select the `.py` file you want to execute. When you hit the `Play` button the `main()` function of the python file will be executed. Very useful to quickly switch between different render settings.
|
||||
|
||||
@ -259,7 +259,7 @@ The lookdev tools will show up when you selected a `Task Type` with the name `Li
|
||||
blender-kitsu has different checks that are performed during file load or during editing. If it detects an error that prevents other operators to run it will display an error in the ui. <br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Troubleshoot
|
||||
blender-kitsu makes good use of logging and status reports. Most of the operators report information in the blender info bar. More detailed logs can be found in the blender system console. If you feel like anything went wrong, consider opening a console and check the logs.
|
||||
@ -275,6 +275,6 @@ Original author of this file is: Sybren A. Stuevel.
|
||||
## Development
|
||||
In the project root you will find a `pyproject.toml` and `peotry.lock` file.
|
||||
With `poetry` you can easily generate a virtual env for the project which should get you setup quickly.
|
||||
Basic Usage: https://python-poetry.org/docs/basic-usage/
|
||||
Basic Usage: https://python-poetry.org/basic-usage/
|
||||
|
||||
Create a sym link in your blender addons directory to the blender_kitsu folder.
|
||||
|
||||