Include Addon READMEs in Pipeline Docs #49

Merged
Nick Alberelli merged 18 commits from docs/addon-readmes into main 2023-05-17 17:52:31 +02:00
55 changed files with 260 additions and 143 deletions

View File

@ -10,7 +10,7 @@ export default defineConfig({
description: "Documentation for the Blender Studio pipeline and tools.", description: "Documentation for the Blender Studio pipeline and tools.",
lastUpdated: true, lastUpdated: true,
cleanUrls: true, cleanUrls: true,
srcExclude: ['**/README.md',], srcExclude: ['**/README',],
head: [ head: [
[ [
'script', 'script',
@ -54,6 +54,26 @@ export default defineConfig({
{ text: 'Rigging', link: '/pipeline-overview/rigging'}, { text: 'Rigging', link: '/pipeline-overview/rigging'},
] ]
}, },
{
text: 'Addons',
link:'/addons/addons_readme',
collapsed: true,
items: [
{ text: 'Anim Cupboard', link: '/addons/anim_cupboard'},
{ text: 'Asset Pipeline', link: '/addons/asset_pipeline'},
{ text: 'Blender Kitsu', link: '/addons/blender_kitsu'},
{ text: 'Blender SVN', link: '/addons/blender_svn'},
{ text: 'Blender Gizmos', link: '/addons/bone_gizmos'},
{ text: 'Cache Manager', link: '/addons/cache_manager'},
{ text: 'Contact Sheet', link: '/addons/contactsheet'},
{ text: 'Geonode Shapekeys', link: '/addons/geonode_shapekeys'},
{ text: 'Grase Converter', link: '/addons/grease_converter'},
{ text: 'Lighting Overrider', link: '/addons/lighting_overrider'},
{ text: 'Pose Shape Keys', link: '/addons/pose_shape_keys'},
{ text: 'Render Review', link: '/addons/render_review'},
]
},
{ {
text: 'Naming Conventions', text: 'Naming Conventions',
items: [ items: [

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/anim_cupboard/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/asset_pipeline/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/blender_kitsu/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/blender_svn/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/bone_gizmos/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/cache_manager/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/contactsheet/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/geonode_shapekeys/README.md-->

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/grease_converter/README.md-->

View File

@ -0,0 +1 @@
<!--@include: ../../scripts-blender/addons/lighting_overrider/README.md-->

View File

@ -0,0 +1 @@
<!--@include: ../../scripts-blender/addons/pose_shape_keys/README.md-->

View File

@ -0,0 +1 @@
<!--@include: ../../scripts-blender/addons/render_review/README.md-->

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

Before

Width:  |  Height:  |  Size: 8.8 KiB

After

Width:  |  Height:  |  Size: 8.8 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

Before

Width:  |  Height:  |  Size: 9.4 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

Before

Width:  |  Height:  |  Size: 6.1 KiB

After

Width:  |  Height:  |  Size: 6.1 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 8.0 KiB

After

Width:  |  Height:  |  Size: 8.0 KiB

View File

Before

Width:  |  Height:  |  Size: 8.6 KiB

After

Width:  |  Height:  |  Size: 8.6 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 9.8 KiB

After

Width:  |  Height:  |  Size: 9.8 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 7.1 KiB

View File

Before

Width:  |  Height:  |  Size: 5.7 KiB

After

Width:  |  Height:  |  Size: 5.7 KiB

View File

Before

Width:  |  Height:  |  Size: 7.0 KiB

After

Width:  |  Height:  |  Size: 7.0 KiB

View File

Before

Width:  |  Height:  |  Size: 5.8 KiB

After

Width:  |  Height:  |  Size: 5.8 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

Before

Width:  |  Height:  |  Size: 9.6 KiB

After

Width:  |  Height:  |  Size: 9.6 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -2,19 +2,15 @@
Most add-ons used in the Blender Studio pipeline. Most add-ons used in the Blender Studio pipeline.
## blender-kitsu
Add-on used by animation, layout, and editorial department to push video files of shot versions to Kitsu. It also has features that are not directly related to Kitsu but support certain aspects of the Blender Studio Pipeline. ## Anim Cupboard
**shot-builder** : tools used by animators or TDs to build .blend files by pulling in shot data from a production's Kitsu database, by linking characters, sets, and props that are used by a given shot. Author: Jeroen Bakker Add-on with miscellaneous tools for animators.
**anim-setup** : Sub-module that automates the setup of animation within shot_builder. Author: Paul Golter Author & Maintainer: Demeter Dzadik
Author: Paul Golter
Maintainers: Nick Alberelli, Francesco Siddi, Demeter Dzadik
## asset-pipeline ## Asset Pipeline
Add-on that manages the Asset Pipeline, used by Modeling, Shading and Rigging departments to be able to work on different aspects of the same asset, primarily characters. Each department works in their own files (char.modeling, char.shading, char.rigging), and push and pull changes from a publish file (char.v001.blend), where all the different data is combined into the final character file. Add-on that manages the Asset Pipeline, used by Modeling, Shading and Rigging departments to be able to work on different aspects of the same asset, primarily characters. Each department works in their own files (char.modeling, char.shading, char.rigging), and push and pull changes from a publish file (char.v001.blend), where all the different data is combined into the final character file.
@ -24,72 +20,72 @@ Author: Paul Golter
Maintainers: Demeter Dzadik, Simon Thommes Maintainers: Demeter Dzadik, Simon Thommes
## render-review ## Blender Kitsu
Add-on to review renders from flamenco with the sequence editor, and push and approve them on Kitsu. Add-on used by animation, layout, and editorial department to push video files of shot versions to Kitsu. It also has features that are not directly related to Kitsu but support certain aspects of the Blender Studio Pipeline.
**Shot Builder** : tools used by animators or TDs to build .blend files by pulling in shot data from a production's Kitsu database, by linking characters, sets, and props that are used by a given shot. Author: Jeroen Bakker
**Anim Setup** : Sub-module that automates the setup of animation within shot_builder. Author: Paul Golter
Author: Paul Golter Author: Paul Golter
Maintainer: Demeter Dzadik Maintainers: Nick Alberelli, Francesco Siddi, Demeter Dzadik
## Blender Svn
## contactsheet
Add-on to create a contactsheet from sequence editor strips.
Author: Paul Golter
## anim-cupboard
Add-on with miscellaneous tools for animators.
Author & Maintainer: Demeter Dzadik
## lighting-overrider
Add-on to create, manage and apply python overrides in a flexible and reliable way as they are used in the lighting process of the Blender Studio pipeline on a shot and sequence level.
Author & Maintainer: Simon Thommes
## blender-svn
Add-on that is intended as a UI for the SVN (Subversion) file versioning system which we use at the studio. Currently doesn't support check-out, but once a check-out is done, it supports all common SVN operations, including resolving conflicts. The currently opened .blend file must be in an SVN repository for the UI to appear. Add-on that is intended as a UI for the SVN (Subversion) file versioning system which we use at the studio. Currently doesn't support check-out, but once a check-out is done, it supports all common SVN operations, including resolving conflicts. The currently opened .blend file must be in an SVN repository for the UI to appear.
Author & Maintainer: Demeter Dzadik Author & Maintainer: Demeter Dzadik
## geonode-shapekeys ## Bone Gizmos
Add-on used by animators to sculpt on linked and overridden meshes.
Author & Maintainer: Demeter Dzadik
## pose-shape-keys
Add-on used by the rigging department to manage and maintain shapekeys.
Author & Maintainer: Demeter Dzadik
## bone-gizmos
Add-on that attempts to prototype a system for using meshes for the manipulation of armatures. Design task: https://projects.blender.org/blender/blender/issues/92218 Add-on that attempts to prototype a system for using meshes for the manipulation of armatures. Design task: https://projects.blender.org/blender/blender/issues/92218
Author & Maintainer: Demeter Dzadik Author & Maintainer: Demeter Dzadik
## Cache Manager
## grease-converter Add-on to streamline the alembic cache workflow of assets.
Author: Paul Golter
## Contact Sheet
Add-on to create a contactsheet from sequence editor strips.
Author: Paul Golter
## Geonode Shapekeys
Add-on used by animators to sculpt on linked and overridden meshes.
Author & Maintainer: Demeter Dzadik
## Grease Converter
Add-on that can convert annotations to grease pencil objects and vise versa. Add-on that can convert annotations to grease pencil objects and vise versa.
Author: Paul Golter Author: Paul Golter
## cache-manager ## Lighting Overrider
Add-on to streamline the alembic cache workflow of assets. Add-on to create, manage and apply python overrides in a flexible and reliable way as they are used in the lighting process of the Blender Studio pipeline on a shot and sequence level.
Author & Maintainer: Simon Thommes
## Pose Shape Keys
Add-on used by the rigging department to manage and maintain shapekeys.
Author & Maintainer: Demeter Dzadik
## Render Review
Add-on to review renders from flamenco with the sequence editor, and push and approve them on Kitsu.
Author: Paul Golter Author: Paul Golter
Maintainer: Demeter Dzadik

View File

@ -1,5 +1,20 @@
# Anim Cupboard
Miscellaneous operators and tools requested by Blender Studio Animators. Miscellaneous operators and tools requested by Blender Studio Animators.
## Table of Contents
- [Installation](#installation)
- [Features](#features)
- [Select Similar Curves](#select-similar-curves)
- [Lock Curves](#lock-curves)
- [Easy Constraints](#easy-constraints)
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `anim_cupboard` folder. Place this folder in your Blender addons directory or create a sym link to it.
## Features
### Select Similar Curves ### Select Similar Curves
Location: Graph Editor -> Select -> Select Similar Curves Location: Graph Editor -> Select -> Select Similar Curves

View File

@ -1,13 +1,14 @@
# asset-pipeline # Asset Pipeline
asset-pipeline is a Blender Add-on that manages the Asset Pipeline of the Blender Studio. It includes an Asset Builder and an Asset Updater. asset-pipeline is a Blender Add-on that manages the Asset Pipeline of the Blender Studio. It includes an Asset Builder and an Asset Updater.
[Asset Pipeline Presentation](https://youtu.be/IBTEBhAouKc?t=527)
## Table of Contents ## Table of Contents
- [Installation](#installation) - [Installation](#installation)
- [How to get started](#how-to-get-started) - [How to get started](#how-to-get-started)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Task Layers](#task_layers.py) - [Task Layers](#task_layers.py)
- [Hooks](#hooks.py) - [Hooks](#hooks.py)
- [Development](#development)
- [Getting Started as a Developer](#getting-started-as-a-developer) - [Getting Started as a Developer](#getting-started-as-a-developer)
- [Context](#context) - [Context](#context)
- [UI](#ui) - [UI](#ui)
@ -21,8 +22,9 @@ asset-pipeline is a Blender Add-on that manages the Asset Pipeline of the Blende
## Installation ## Installation
Download or clone this repository. 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
In the root project folder you will find the 'asset_pipeline' folder. Place this folder in your Blender addons directory or create a sym link to it. 2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `asset_pipeline` folder. Place this folder in your Blender addons directory or create a sym link to it.
> **_NOTE:_** This add-on depends on other add-ons that are in the [Blender Studio Tools](https://developer.blender.org/diffusion/BSTS/). > **_NOTE:_** This add-on depends on other add-ons that are in the [Blender Studio Tools](https://developer.blender.org/diffusion/BSTS/).
@ -297,12 +299,7 @@ def test_hook_F(context: bpy.types.Context, asset_collection: bpy.types.Collecti
print(asset_collection.name) print(asset_collection.name)
``` ```
## 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/
Create a sym link in your blender addons directory to the asset_pipeline folder.
## Getting Started as a Developer ## Getting Started as a Developer

View File

@ -1,6 +1,8 @@
# blender-kitsu # Blender Kitsu
blender-kitsu is a Blender Add-on to interact with Kitsu from within Blender. It also has features that are not directly related to Kitsu but support certain aspects of the Blender Studio Pipeline. blender-kitsu is a Blender Add-on to interact with Kitsu from within Blender. It also has features that are not directly related to Kitsu but support certain aspects of the Blender Studio Pipeline.
[Blender-Kitsu blogpost](https://studio.blender.org/blog/kitsu-addon-for-blender/)
## Table of Contents ## Table of Contents
- [Installation](#installation) - [Installation](#installation)
- [How to get started](#how-to-get-started) - [How to get started](#how-to-get-started)
@ -27,11 +29,11 @@ blender-kitsu is a Blender Add-on to interact with Kitsu from within Blender. It
- [Error System](#error-system) - [Error System](#error-system)
- [Troubleshoot](#troubleshoot) - [Troubleshoot](#troubleshoot)
- [Credits](#credits) - [Credits](#credits)
- [Development](#development)
## Installation ## Installation
Download or clone this repository. 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
In the root project folder you will find the 'blender_kitsu' folder. Place this folder in your Blender addons directory or create a sym link to it. 2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `blender_kitsu` folder. Place this folder in your Blender addons directory or create a sym link to it.
## How to get started ## How to get started
After installing you need to setup the addon preferences to fit your environment. After installing you need to setup the addon preferences to fit your environment.
@ -44,7 +46,7 @@ If Kitsu is up and running and you can succesfully log in via the web interface
###### **Setup Login Data** ###### **Setup Login Data**
![image info](./docs/images/prefs_login.jpg) ![image info](/media/addons/blender_kitsu/prefs_login.jpg)
>**Host**: The webadress of your kitsu server (e.G https://kitsu.mydomain.com)<br/> >**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/> **Email**: The email you use to log in to kitsu<br/>
@ -54,7 +56,7 @@ Press the login button. If the login was succesfull, the next step is..
###### **Setup Project Settings** ###### **Setup Project Settings**
![image info](./docs/images/prefs_project.jpg) ![image info](/media/addons/blender_kitsu/prefs_project.jpg)
>**Project Root Directory**: Path to the root of your project. Will later be used to configurate the addon on a per project basis<br/> >**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 +64,7 @@ Press the login button. If the login was succesfull, the next step is..
###### **Setup Animation Tools** ###### **Setup Animation Tools**
![image info](./docs/images/prefs_anim_tools.jpg) ![image info](/media/addons/blender_kitsu/prefs_anim_tools.jpg)
>**Playblast Root Directory**: Path to a directory in which playblasts will be saved to<br/> >**Playblast Root Directory**: Path to a directory in which playblasts will be saved to<br/>
@ -72,19 +74,19 @@ Press the login button. If the login was succesfull, the next step is..
###### **Setup Lookdev Tools** ###### **Setup Lookdev Tools**
![image info](./docs/images/prefs_lookdev.jpg) ![image info](/media/addons/blender_kitsu/prefs_lookdev.jpg)
>**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/> >**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** ###### **Setup Media Search Paths**
![image info](./docs/images/prefs_outdated_media.jpg) ![image info](/media/addons/blender_kitsu/prefs_outdated_media.jpg)
>**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/> >**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** ###### **Setup Miscellaneous**
![image info](./docs/images/prefs_misc.jpg) ![image info](/media/addons/blender_kitsu/prefs_misc.jpg)
>**Thumbnail Directory**: Directory where thumbnails will be saved before uploading them to kitsu. Cannot be edited.<br/> >**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/> **Sequence Editor Render Directory**: Directory where sequence editor renderings will be saved before uploading them to kitsu. Cannot be edited<br/>
@ -103,7 +105,7 @@ blender-kitsu sequence editor tools were constructed with the idea in mind to ha
##### Metastrips ##### 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. 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.
![image info](./docs/images/metastrip.001.jpg) ![image info](/media/addons/blender_kitsu/metastrip.001.jpg)
>**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. >**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 +115,7 @@ This will import a metastrip.mp4 (1000 frame black video) file which is saved in
###### Initialize a Shot ###### 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. 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.
![image info](./docs/images/sqe_init_shot.jpg) ![image info](/media/addons/blender_kitsu/sqe_init_shot.jpg)
2. Case A: Shot does **already exist** on Kitsu 2. Case A: Shot does **already exist** on Kitsu
@ -121,7 +123,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/> 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/>
![image info](./docs/images/sqe_link_shot.jpg) ![image info](/media/addons/blender_kitsu/sqe_link_shot.jpg)
3. Case B: Shot **does not exist** on Kitsu yet 3. Case B: Shot **does not exist** on Kitsu yet
@ -134,12 +136,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) 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/> >**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/>
![image info](./docs/images/sqe_init_selection.jpg) ![image info](/media/addons/blender_kitsu/sqe_init_selection.jpg)
##### Metadata ##### 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. 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.
![image info](./docs/images/sqe_metadata.jpg) ![image info](/media/addons/blender_kitsu/sqe_metadata.jpg)
The frame range will be updated by using the Blender editing tools on the strip. (trimming, sliding, etc.). <br/> 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/> 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 +149,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/> 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/>
![image info](./docs/images/sqe_sequence_color_init.jpg) ![image info](/media/addons/blender_kitsu/sqe_sequence_color_init.jpg)
All this information and more can be `pushed` to kitsu which bring us to the next panel. <br/> All this information and more can be `pushed` to kitsu which bring us to the next panel. <br/>
@ -156,7 +158,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/> In the `Push` panel you will find all the operators that push data to Kitsu. <br/>
![image info](./docs/images/sqe_push.jpg) ![image info](/media/addons/blender_kitsu/sqe_push.jpg)
>**Metadata**: Pushes metadata of shot: sequence, shotname, frame range, sequence_color >**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/> >>**Note**: Global edit frame range will be saved in `"frame_in"` `"frame_out"` kitsu shot attribute <br/>
@ -169,35 +171,35 @@ If you select multiple metastrips it will always use the middle frame to create
##### Pull ##### Pull
In the `Pull` panel you will find all the operators that pull data from Kitsu to a metastrip. <br/> In the `Pull` panel you will find all the operators that pull data from Kitsu to a metastrip. <br/>
![image info](./docs/images/sqe_pull.jpg) ![image info](/media/addons/blender_kitsu/sqe_pull.jpg)
>**Metadata**: Pulls metadata of shot: sequence, shotname, shot description and updates the strip name to match the shotname. >**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/> >>**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/> If you have not sequence selected the `Pull Entire Edit` Operator will appear in the `Pull` panel.<br/>
![image info](./docs/images/sqe_pull_entire_edit.jpg) ![image info](/media/addons/blender_kitsu/sqe_pull_entire_edit.jpg)
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/> 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/> 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: As a result a bigger edit with nice sequence_colors can look pretty cool:
![image info](./docs/images/sqe_sequence_colors.jpg) ![image info](/media/addons/blender_kitsu/sqe_sequence_colors.jpg)
##### Multi Edit ##### Multi Edit
The `Multi Edit` panel only appears when you select multiple metastrips that are all `initialized` but not `linked` yet. </br> The `Multi Edit` panel only appears when you select multiple metastrips that are all `initialized` but not `linked` yet. <br/>
![image info](./docs/images/sqe_multi_edit.jpg) ![image info](/media/addons/blender_kitsu/sqe_multi_edit.jpg)
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. </b3> 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 ###### 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. If you check the `Advanced` checkbox next to the counter value, you have access to advance settings to customize the operator even more.
![image info](./docs/images/sqe_multi_edit_advanced.jpg) ![image info](/media/addons/blender_kitsu/sqe_multi_edit_advanced.jpg)
You can adjust the number of counter digits, the incrementation size and also the `Pattern` it will use to generate the shot name. <br/> 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/> >**Pattern**: supports 3 wildcards. `<Sequence>`, `<Counter>`, `<Project>` that can be used multiple times in any order. <br/>
@ -207,15 +209,15 @@ You can adjust the number of counter digits, the incrementation size and also th
##### General Sequence Editor Tools ##### 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. In the general tab you can find some tools that don't directly relate to Kitsu but are useful for editing.
![image info](./docs/images/sqe_outdated_scan.jpg) ![image info](/media/addons/blender_kitsu/sqe_outdated_scan.jpg)
`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: `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:
![image info](./docs/images/sqe_outdated_overlay.jpg) ![image info](/media/addons/blender_kitsu/sqe_outdated_overlay.jpg)
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. 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.
![image info](./docs/images/sqe_outdated_update.jpg) ![image info](/media/addons/blender_kitsu/sqe_outdated_update.jpg)
>**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/> >**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 +228,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/> To create 'context' you can find the `Context Browser` in the `Kitsu` panel in the sidebar of the 3D Viewport. <br/>
![image info](./docs/images/context_browser.jpg) ![image info](/media/addons/blender_kitsu/context_browser.jpg)
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/> 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 +241,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/> The animation tools will show up when you selected a `Task Type` with the name `Animation`. <br/>
![image info](./docs/images/context_animation_tools.jpg) ![image info](/media/addons/blender_kitsu/context_animation_tools.jpg)
>**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/> >**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/> **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 +252,7 @@ The animation tools will show up when you selected a `Task Type` with the name `
##### Lookdev Tools ##### Lookdev Tools
The lookdev tools will show up when you selected a `Task Type` with the name `Lighting` | `Rendering` | `Compositing`. <br/> The lookdev tools will show up when you selected a `Task Type` with the name `Lighting` | `Rendering` | `Compositing`. <br/>
![image info](./docs/images/context_lookdev_tools.jpg) ![image info](/media/addons/blender_kitsu/context_lookdev_tools.jpg)
>**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. >**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 +261,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/> 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/>
![image info](./docs/images/error_animation.jpg) ![image info](/media/addons/blender_kitsu/error_animation.jpg)
## Troubleshoot ## 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. 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.
@ -272,9 +274,4 @@ This project uses gazu as a submodule to interact with the gazu data base. Gazu
The file at ./blender_kitsu/sqe/draw.py is copied and modified from the blender-cloud-addon (https://developer.blender.org/diffusion/BCA/). The file at ./blender_kitsu/sqe/draw.py is copied and modified from the blender-cloud-addon (https://developer.blender.org/diffusion/BCA/).
Original author of this file is: Sybren A. Stuevel. 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/
Create a sym link in your blender addons directory to the blender_kitsu folder.

View File

@ -1,2 +1,20 @@
# blender-purge # Blender SVN
blender-svn is a Blender add-on to interact with Subversion from within Blender. blender-svn is a Blender add-on to interact with Subversion from within Blender.
[Blender-SVN Demo Video](https://studio.blender.org/films/charge/gallery/?asset=5999)
## Table of Contents
- [Installation](#installation)
- [Features](#features)
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `blender_svn` folder. Place this folder in your Blender addons directory or create a sym link to it.
## Features
- UI appears when the currently opened .blend file is in an SVN repository.
- You can enter your SVN username and password to this repository, which will be stored until you disable the add-on.
- Display a list of all files in the repository that are outdated, modified, newly added, replaced, conflicted, etc, with the relevant available operations next to them.
- Saves the SVN log into a text file in the background, and displays it in the UI. This was important to us because normally, accessing the svn log has been very slow for us.
Download updates, commit changes, resolve conflicts, all from within Blender.
- If you're working in an outdated file, Blender will show you a very ugly and very aggressive warning.

View File

@ -1,7 +1,21 @@
# What are Bone Gizmos? # Bone Gizmos
## Table of Contents
- [Installation](#installation)
- [What are Bone Gizmos?](#what-are-bone-gizmos)
- [Using Bone Gizmos](#using-bone-gizmos)
- [Rigger UX](#rigger-ux)
- [Animator UX](#animator-ux)
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `bone_gizmos` folder. Place this folder in your Blender addons directory or create a sym link to it.
## What are Bone Gizmos?
This add-on is a prototype for a potential future Mesh Gizmos feature in Blender. See [this](https://developer.blender.org/T92218) task for more details. This add-on is a prototype for a potential future Mesh Gizmos feature in Blender. See [this](https://developer.blender.org/T92218) task for more details.
# Using Bone Gizmos ## Using Bone Gizmos
The UI for Bone Gizmos can be found under Properties Editor->Bone->Viewport Display->Custom Gimzo. You need to be in pose mode and have an active bone. You just need to select a mesh and optionally, a vertex group or face map that the gizmo should be bound to. The UI for Bone Gizmos can be found under Properties Editor->Bone->Viewport Display->Custom Gimzo. You need to be in pose mode and have an active bone. You just need to select a mesh and optionally, a vertex group or face map that the gizmo should be bound to.
### Rigger UX ### Rigger UX

View File

@ -1,11 +1,18 @@
# cache-manager # Cache Manager
cache-Manager is a Blender Add-on to streamline the alembic cache workflow of assets. cache-Manager is a Blender Add-on to streamline the alembic cache workflow of assets.
## Table of Contents
- [Installation](#installation)
- [How to Get Started](#how-to-get-started)
- [Features](#features)
## Disclaimer ## Disclaimer
This addon is not used in the production of the Blender-Studio anymore and is not maintained actively. This addon is not used in the production of the Blender-Studio anymore and is not maintained actively.
## Installation ## Installation
Download or clone this repository. 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
In the root project folder you will find the 'cache_manager' folder. Place this folder in your Blender addons directory or create a sym link to it. 2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `cache_manager` folder. Place this folder in your Blender addons directory or create a sym link to it.
## How to get started ## How to get started
After installing the addon you need to setup the addon preferences. After installing the addon you need to setup the addon preferences.
@ -29,11 +36,3 @@ You can control if modifiers should be disabled / enabled during import /export:
- modifier_name.cacheoff -> modifier off for export on for import - modifier_name.cacheoff -> modifier off for export on for import
- modifier_name.cacheon -> modifier on for export off for import - modifier_name.cacheon -> modifier on for export off for import
## 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/
Create a sym link in your blender addons directory to the blezou folder.

View File

@ -1,9 +1,15 @@
# contactsheet # Contact Sheet
Blender Add-on to create a contactsheet from sequence editor strips. Blender Add-on to create a contactsheet from sequence editor strips.
[Contact Sheet Blogpost](https://studio.blender.org/blog/contact-sheet-addon/)
## Table of Contents
- [Installation](#installation)
- [Features](#features)
## Installation ## Installation
Download or clone this repository. 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
In the root project folder you will find the 'contactsheet' folder. Place this folder in your Blender addons directory or create a symlink to it. 2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `contactsheet` folder. Place this folder in your Blender addons directory or create a symlink to it.
## Features ## Features
After the addon is enabled you will find a `Contactsheet` tab in the Sequence Editor Toolbar. After the addon is enabled you will find a `Contactsheet` tab in the Sequence Editor Toolbar.
@ -14,9 +20,5 @@ You can overwrite the resolution of the contactsheet by adjusting the X and Y sl
The number of rows and columns is automatically calculated. It can also be overwritten by toggling the lock button. The number of rows and columns is automatically calculated. It can also be overwritten by toggling the lock button.
Check the addon preferences there you find some options to customize the contactsheet even more. Check the addon preferences there you find some options to customize the contactsheet even more.
## 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/
Create a sym link in your Blender addons directory to the contactsheet/contactsheet folder. Create a sym link in your Blender addons directory to the contactsheet/contactsheet folder.

View File

@ -1,9 +1,14 @@
# GeoNode Shape Keys # GeoNode Shape Keys
GeoNode Shape Keys is a Blender Add-on that lets you deform linked and overridden meshes using sculpt mode in a roundabout way using a geometry node set-up. While the current override system doesn't support adding or editing shape keys on overridden meshes, it does allow you to add modifiers, so this add-on leverages that. GeoNode Shape Keys is a Blender Add-on that lets you deform linked and overridden meshes using sculpt mode in a roundabout way using a geometry node set-up. While the current override system doesn't support adding or editing shape keys on overridden meshes, it does allow you to add modifiers, so this add-on leverages that.
## Table of Contents
- [Installation](#installation)
- [How to Use](#how-to-use)
## Installation ## Installation
Download or clone this repository. 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
In the root project folder you will find the 'geonode_shapekeys' (the one with the underscore, not the dash) folder. Place this folder in your Blender addons directory or create a symlink to it. 2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `geonode_shapekeys`a Place this folder in your Blender addons directory or create a symlink to it.
# How to use # How to use
The add-on's UI is only visible on linked and overridden meshes. The add-on's UI is only visible on linked and overridden meshes.

View File

@ -1,9 +1,16 @@
# grease-converter # Grease Pencil Converter
grease-converter is a Blender Add-on that can convert annotations to grease pencil objects and vise versa. grease-converter is a Blender Add-on that can convert annotations to grease pencil objects and vise versa.
## Table of Contents
- [Installation](#installation)
- [How to get Started](#how-to-get-started)
## Installation ## Installation
Download or clone this repository. 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
In the root project folder you will find the 'grease_converter' folder. Place this folder in your Blender addons directory or create a symlink to it. 2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `grease_converter` folder. Place this folder in your Blender addons directory or create a symlink to it.
## How to get started ## How to get started
After the add-on is installed you have 2 new operators available. After the add-on is installed you have 2 new operators available.
@ -12,15 +19,12 @@ After the add-on is installed you have 2 new operators available.
- Located in the 3DView Side Panel (N)-> View -> Annotations Panel - Located in the 3DView Side Panel (N)-> View -> Annotations Panel
- Converts active annotation to Grease Pencil Object and link it in the active Scene. - Converts active annotation to Grease Pencil Object and link it in the active Scene.
- <img src="./docs/images/convert_to_grease_pencil.jpg" alt="drawing" width="300"/> - <img src="./docs/images/convert_to_grease_pencil.jpg" alt="drawing" width="300"/>
![drawing](/media/addons/grease_converter/convert_to_grease_pencil.jpg)
- **grease_converter.convert_to_annotation**: - **grease_converter.convert_to_annotation**:
- Located in the 3DView Header -> Object -> Convert - Located in the 3DView Header -> Object -> Convert
- Active objects needs to be grease pencil object. Will convert it to Annotation Grease Pencil Object. Uses Tint Color and Stroke Thickness attribute found in the Adjustments Panel for final annotation color and stroke thickness. (Annotations are a simple version of GreasePencil and only support **one* color and stoke thickness per layer) - Active objects needs to be grease pencil object. Will convert it to Annotation Grease Pencil Object. Uses Tint Color and Stroke Thickness attribute found in the Adjustments Panel for final annotation color and stroke thickness. (Annotations are a simple version of GreasePencil and only support **one* color and stoke thickness per layer)
- <img src="./docs/images/adjustments_panel.jpg" alt="drawing" width="300"/>
- >**Note**: If the grease pencil object has it's transforms not applied or a parent you will be prompted with a warning as these are not taken in to account yet
## Development ![drawing](/media/addons/grease_converter/adjustments_panel.jpg)
In the project root you will find a `pyproject.toml` and `peotry.lock` file. - >**Note**: If the grease pencil object has it's transforms not applied or a parent you will be prompted with a warning as these are not taken in to account yet
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/

View File

@ -1 +1,19 @@
System to create, manage and apply python overrides in a flexible and reliable way as they are used in the lighting process of the Blender Studio pipeline. # Lighting Overrider
System to create, manage and apply python overrides in a flexible and reliable way as they are used in the lighting process of the Blender Studio pipeline. Addon overrides specific settings of linked data.
## Table of Contents
- [Installation](#installation)
- [Features](#features)
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `lighting_overrider` folder. Place this folder in your Blender addons directory or create a symlink to it.
## Features
- Shot Settings
- Sequencer Settings
- auto-cleanup of depricated RNA overrides
- batch overriding settings of all selected objects with `Alt+O`

View File

@ -1,9 +1,22 @@
# Pose Shake Keys
## Table of Contents
- [Installation](#installation)
- [Basic Workflow](#basic-workflow)
- [Example Use Cases](#example-use-cases)
This addon lets you create shape keys that blend already deformed meshes into a previously stored shape. This addon lets you create shape keys that blend already deformed meshes into a previously stored shape.
It also lets you manage multiple copies of a shape key together. Each copy can have a different vertex group mask, or be applied mirrored around the X axis. It also lets you manage multiple copies of a shape key together. Each copy can have a different vertex group mask, or be applied mirrored around the X axis.
You can find a detailed video tutorial on how to download, install and use the addon [here](https://studio.blender.org/training/blender-studio-rigging-tools/pose-shape-keys/). You can find a detailed video tutorial on how to download, install and use the addon [here](https://studio.blender.org/training/blender-studio-rigging-tools/pose-shape-keys/).
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `pose_shape_keys` folder. Place this folder in your Blender addons directory or create a sym link to it.
## Basic Workflow: ## Basic Workflow:
- Create a pose whose deformation you want to correct. A pose is defined as an Action and a frame number. - Create a pose whose deformation you want to correct. A pose is defined as an Action and a frame number.
- Create a Pose Key on the deformed mesh. Assign the action and the frame number. - Create a Pose Key on the deformed mesh. Assign the action and the frame number.

View File

@ -1,21 +1,21 @@
# render-review # Render Review
Blender Add-on to review renders from Flamenco with the Sequence Editor Blender Add-on to review renders from Flamenco with the Sequence Editor
## Table of Contents ## Table of Contents
- [Installation](#installation) - [Installation](#installation)
- [Before you get started](#before-you-get-started) - [Before you get started](#before-you-get-started)
- [Features](#features) - [Features](#features)
- [Development](#development)
## Installation ## Installation
Download or clone this repository. 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
In the root project folder you will find the 'render_review' folder. Place this folder in your Blender addons directory or create a sym link to it. 2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `render_review` folder. Place this folder in your Blender addons directory or create a sym link to it.
After install you need to configure the addon in the addon preferences. After install you need to configure the addon in the addon preferences.
## Before you get started ## Before you get started
This addon requires a specific folder structure of the rendering pipeline. This structure is defined by <a href="https://www.flamenco.io">Flamenco</a> This addon requires a specific folder structure of the rendering pipeline. This structure is defined by <a href="https://flamenco.blender.org">Flamenco</a>
If you have a different folder structure the addon might not work as If you have a different folder structure the addon might not work as
expected. expected.
@ -28,11 +28,7 @@ expected.
and copies it over to the shot_preview folder with automatic versioning incrementation and copies it over to the shot_preview folder with automatic versioning incrementation
- Creation of metadata.json files on approving renders and pushing renders to edit to keep track where a file came from - Creation of metadata.json files on approving renders and pushing renders to edit to keep track where a file came from
- Connection to `blender-kitsu` addon, that can be enabled and extends the functionality of some operators - Connection to `blender-kitsu` addon, that can be enabled and extends the functionality of some operators
## 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/
## Links ## Links
<a href="https://www.flamenco.io/docs/">Flamenco Doc</a> <a href="https://flamenco.blender.org/usage/quickstart/">Flamenco Doc</a>