From 0afc494ac83fd9bb1744e3c6dcd5bd047dd778c2 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Tue, 16 May 2023 16:10:19 -0400 Subject: [PATCH 01/18] [DOCS] Create addons area in pipeline-and-tools sidebar --- docs/.vitepress/config.ts | 22 +++++++++++++++++++++- docs/addons/addons_readme.md | 2 ++ docs/addons/anim_cupboard.md | 2 ++ docs/addons/asset_pipeline.md | 2 ++ docs/addons/blender_kitsu.md | 2 ++ docs/addons/blender_svn.md | 2 ++ docs/addons/bone_gizmos.md | 2 ++ docs/addons/cache_manager.md | 2 ++ docs/addons/contactsheet.md | 2 ++ docs/addons/geonode_shapekeys.md | 2 ++ docs/addons/grease_converter.md | 2 ++ docs/addons/lighting_overrider.md | 1 + docs/addons/pose_shape_keys.md | 1 + docs/addons/render_review.md | 1 + 14 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 docs/addons/addons_readme.md create mode 100644 docs/addons/anim_cupboard.md create mode 100644 docs/addons/asset_pipeline.md create mode 100644 docs/addons/blender_kitsu.md create mode 100644 docs/addons/blender_svn.md create mode 100644 docs/addons/bone_gizmos.md create mode 100644 docs/addons/cache_manager.md create mode 100644 docs/addons/contactsheet.md create mode 100644 docs/addons/geonode_shapekeys.md create mode 100644 docs/addons/grease_converter.md create mode 100644 docs/addons/lighting_overrider.md create mode 100644 docs/addons/pose_shape_keys.md create mode 100644 docs/addons/render_review.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 9b2b7e25..1a3b8564 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -10,7 +10,7 @@ export default defineConfig({ description: "Documentation for the Blender Studio pipeline and tools.", lastUpdated: true, cleanUrls: true, - srcExclude: ['**/README.md',], + srcExclude: ['**/README',], head: [ [ 'script', @@ -54,6 +54,26 @@ export default defineConfig({ { 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', items: [ diff --git a/docs/addons/addons_readme.md b/docs/addons/addons_readme.md new file mode 100644 index 00000000..15c0534d --- /dev/null +++ b/docs/addons/addons_readme.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/anim_cupboard.md b/docs/addons/anim_cupboard.md new file mode 100644 index 00000000..1a916592 --- /dev/null +++ b/docs/addons/anim_cupboard.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/asset_pipeline.md b/docs/addons/asset_pipeline.md new file mode 100644 index 00000000..9a403817 --- /dev/null +++ b/docs/addons/asset_pipeline.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/blender_kitsu.md b/docs/addons/blender_kitsu.md new file mode 100644 index 00000000..209000d5 --- /dev/null +++ b/docs/addons/blender_kitsu.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/blender_svn.md b/docs/addons/blender_svn.md new file mode 100644 index 00000000..798472bf --- /dev/null +++ b/docs/addons/blender_svn.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/bone_gizmos.md b/docs/addons/bone_gizmos.md new file mode 100644 index 00000000..42db980e --- /dev/null +++ b/docs/addons/bone_gizmos.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/cache_manager.md b/docs/addons/cache_manager.md new file mode 100644 index 00000000..74abdbc1 --- /dev/null +++ b/docs/addons/cache_manager.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/contactsheet.md b/docs/addons/contactsheet.md new file mode 100644 index 00000000..d170c28d --- /dev/null +++ b/docs/addons/contactsheet.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/geonode_shapekeys.md b/docs/addons/geonode_shapekeys.md new file mode 100644 index 00000000..41217225 --- /dev/null +++ b/docs/addons/geonode_shapekeys.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/grease_converter.md b/docs/addons/grease_converter.md new file mode 100644 index 00000000..63947dc1 --- /dev/null +++ b/docs/addons/grease_converter.md @@ -0,0 +1,2 @@ + + diff --git a/docs/addons/lighting_overrider.md b/docs/addons/lighting_overrider.md new file mode 100644 index 00000000..8212fca6 --- /dev/null +++ b/docs/addons/lighting_overrider.md @@ -0,0 +1 @@ + diff --git a/docs/addons/pose_shape_keys.md b/docs/addons/pose_shape_keys.md new file mode 100644 index 00000000..0f2b92e4 --- /dev/null +++ b/docs/addons/pose_shape_keys.md @@ -0,0 +1 @@ + diff --git a/docs/addons/render_review.md b/docs/addons/render_review.md new file mode 100644 index 00000000..64de3a16 --- /dev/null +++ b/docs/addons/render_review.md @@ -0,0 +1 @@ + \ No newline at end of file -- 2.30.2 From 067f5cf6c021c77abd6d4c2ff051dd514e68c30f Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Tue, 16 May 2023 16:12:04 -0400 Subject: [PATCH 02/18] [DOCS] Blender-Kitsu Fix 'vitepress Invalid end tag." error --- scripts-blender/addons/blender_kitsu/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts-blender/addons/blender_kitsu/README.md b/scripts-blender/addons/blender_kitsu/README.md index 7f1932bd..cc5f1452 100644 --- a/scripts-blender/addons/blender_kitsu/README.md +++ b/scripts-blender/addons/blender_kitsu/README.md @@ -188,11 +188,11 @@ 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.
+The `Multi Edit` panel only appears when you select multiple metastrips that are all `initialized` but not `linked` yet.
![image info](./docs/images/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. +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.
###### 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. -- 2.30.2 From ddf5d3ba696466cbebc3adca8fae4cef3de0409b Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Tue, 16 May 2023 16:18:02 -0400 Subject: [PATCH 03/18] [DOCS] Move Blender-Kitsu Readme images to docs/media - README.md in gitea now has invalid images - Images are now viewable in `pipeline-and-tools/addons/blender_kitsu` --- .../context_animation_tools.jpg | Bin .../addons/blender_kitsu}/context_browser.jpg | Bin .../blender_kitsu}/context_lookdev_tools.jpg | Bin .../blender_kitsu}/error_active_project.jpg | Bin .../addons/blender_kitsu}/error_animation.jpg | Bin .../addons/blender_kitsu}/metastrip.001.jpg | Bin .../blender_kitsu}/prefs_anim_tools.jpg | Bin .../addons/blender_kitsu}/prefs_login.jpg | Bin .../addons/blender_kitsu}/prefs_lookdev.jpg | Bin .../addons/blender_kitsu}/prefs_misc.jpg | Bin .../blender_kitsu}/prefs_outdated_media.jpg | Bin .../addons/blender_kitsu}/prefs_project.jpg | Bin .../blender_kitsu}/sqe_init_selection.jpg | Bin .../addons/blender_kitsu}/sqe_init_shot.jpg | Bin .../addons/blender_kitsu}/sqe_link_shot.jpg | Bin .../addons/blender_kitsu}/sqe_metadata.jpg | Bin .../addons/blender_kitsu}/sqe_multi_edit.jpg | Bin .../sqe_multi_edit_advanced.jpg | Bin .../blender_kitsu}/sqe_outdated_overlay.jpg | Bin .../blender_kitsu}/sqe_outdated_scan.jpg | Bin .../blender_kitsu}/sqe_outdated_update.jpg | Bin .../media/addons/blender_kitsu}/sqe_pull.jpg | Bin .../blender_kitsu}/sqe_pull_entire_edit.jpg | Bin .../media/addons/blender_kitsu}/sqe_push.jpg | Bin .../sqe_sequence_color_init.jpg | Bin .../blender_kitsu}/sqe_sequence_colors.jpg | Bin .../addons/blender_kitsu/README.md | 52 +++++++++--------- 27 files changed, 26 insertions(+), 26 deletions(-) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/context_animation_tools.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/context_browser.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/context_lookdev_tools.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/error_active_project.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/error_animation.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/metastrip.001.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/prefs_anim_tools.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/prefs_login.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/prefs_lookdev.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/prefs_misc.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/prefs_outdated_media.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/prefs_project.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_init_selection.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_init_shot.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_link_shot.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_metadata.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_multi_edit.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_multi_edit_advanced.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_outdated_overlay.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_outdated_scan.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_outdated_update.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_pull.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_pull_entire_edit.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_push.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_sequence_color_init.jpg (100%) rename {scripts-blender/addons/blender_kitsu/docs/images => docs/media/addons/blender_kitsu}/sqe_sequence_colors.jpg (100%) diff --git a/scripts-blender/addons/blender_kitsu/docs/images/context_animation_tools.jpg b/docs/media/addons/blender_kitsu/context_animation_tools.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/context_animation_tools.jpg rename to docs/media/addons/blender_kitsu/context_animation_tools.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/context_browser.jpg b/docs/media/addons/blender_kitsu/context_browser.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/context_browser.jpg rename to docs/media/addons/blender_kitsu/context_browser.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/context_lookdev_tools.jpg b/docs/media/addons/blender_kitsu/context_lookdev_tools.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/context_lookdev_tools.jpg rename to docs/media/addons/blender_kitsu/context_lookdev_tools.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/error_active_project.jpg b/docs/media/addons/blender_kitsu/error_active_project.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/error_active_project.jpg rename to docs/media/addons/blender_kitsu/error_active_project.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/error_animation.jpg b/docs/media/addons/blender_kitsu/error_animation.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/error_animation.jpg rename to docs/media/addons/blender_kitsu/error_animation.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/metastrip.001.jpg b/docs/media/addons/blender_kitsu/metastrip.001.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/metastrip.001.jpg rename to docs/media/addons/blender_kitsu/metastrip.001.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/prefs_anim_tools.jpg b/docs/media/addons/blender_kitsu/prefs_anim_tools.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/prefs_anim_tools.jpg rename to docs/media/addons/blender_kitsu/prefs_anim_tools.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/prefs_login.jpg b/docs/media/addons/blender_kitsu/prefs_login.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/prefs_login.jpg rename to docs/media/addons/blender_kitsu/prefs_login.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/prefs_lookdev.jpg b/docs/media/addons/blender_kitsu/prefs_lookdev.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/prefs_lookdev.jpg rename to docs/media/addons/blender_kitsu/prefs_lookdev.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/prefs_misc.jpg b/docs/media/addons/blender_kitsu/prefs_misc.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/prefs_misc.jpg rename to docs/media/addons/blender_kitsu/prefs_misc.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/prefs_outdated_media.jpg b/docs/media/addons/blender_kitsu/prefs_outdated_media.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/prefs_outdated_media.jpg rename to docs/media/addons/blender_kitsu/prefs_outdated_media.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/prefs_project.jpg b/docs/media/addons/blender_kitsu/prefs_project.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/prefs_project.jpg rename to docs/media/addons/blender_kitsu/prefs_project.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_init_selection.jpg b/docs/media/addons/blender_kitsu/sqe_init_selection.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_init_selection.jpg rename to docs/media/addons/blender_kitsu/sqe_init_selection.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_init_shot.jpg b/docs/media/addons/blender_kitsu/sqe_init_shot.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_init_shot.jpg rename to docs/media/addons/blender_kitsu/sqe_init_shot.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_link_shot.jpg b/docs/media/addons/blender_kitsu/sqe_link_shot.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_link_shot.jpg rename to docs/media/addons/blender_kitsu/sqe_link_shot.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_metadata.jpg b/docs/media/addons/blender_kitsu/sqe_metadata.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_metadata.jpg rename to docs/media/addons/blender_kitsu/sqe_metadata.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_multi_edit.jpg b/docs/media/addons/blender_kitsu/sqe_multi_edit.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_multi_edit.jpg rename to docs/media/addons/blender_kitsu/sqe_multi_edit.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_multi_edit_advanced.jpg b/docs/media/addons/blender_kitsu/sqe_multi_edit_advanced.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_multi_edit_advanced.jpg rename to docs/media/addons/blender_kitsu/sqe_multi_edit_advanced.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_outdated_overlay.jpg b/docs/media/addons/blender_kitsu/sqe_outdated_overlay.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_outdated_overlay.jpg rename to docs/media/addons/blender_kitsu/sqe_outdated_overlay.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_outdated_scan.jpg b/docs/media/addons/blender_kitsu/sqe_outdated_scan.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_outdated_scan.jpg rename to docs/media/addons/blender_kitsu/sqe_outdated_scan.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_outdated_update.jpg b/docs/media/addons/blender_kitsu/sqe_outdated_update.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_outdated_update.jpg rename to docs/media/addons/blender_kitsu/sqe_outdated_update.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_pull.jpg b/docs/media/addons/blender_kitsu/sqe_pull.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_pull.jpg rename to docs/media/addons/blender_kitsu/sqe_pull.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_pull_entire_edit.jpg b/docs/media/addons/blender_kitsu/sqe_pull_entire_edit.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_pull_entire_edit.jpg rename to docs/media/addons/blender_kitsu/sqe_pull_entire_edit.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_push.jpg b/docs/media/addons/blender_kitsu/sqe_push.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_push.jpg rename to docs/media/addons/blender_kitsu/sqe_push.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_sequence_color_init.jpg b/docs/media/addons/blender_kitsu/sqe_sequence_color_init.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_sequence_color_init.jpg rename to docs/media/addons/blender_kitsu/sqe_sequence_color_init.jpg diff --git a/scripts-blender/addons/blender_kitsu/docs/images/sqe_sequence_colors.jpg b/docs/media/addons/blender_kitsu/sqe_sequence_colors.jpg similarity index 100% rename from scripts-blender/addons/blender_kitsu/docs/images/sqe_sequence_colors.jpg rename to docs/media/addons/blender_kitsu/sqe_sequence_colors.jpg diff --git a/scripts-blender/addons/blender_kitsu/README.md b/scripts-blender/addons/blender_kitsu/README.md index cc5f1452..b5cf66d0 100644 --- a/scripts-blender/addons/blender_kitsu/README.md +++ b/scripts-blender/addons/blender_kitsu/README.md @@ -44,7 +44,7 @@ If Kitsu is up and running and you can succesfully log in via the web interface ###### **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)
**Email**: The email you use to log in to kitsu
@@ -54,7 +54,7 @@ Press the login button. If the login was succesfull, the next step is.. ###### **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
@@ -62,7 +62,7 @@ Press the login button. If the login was succesfull, the next step is.. ###### **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
@@ -72,19 +72,19 @@ Press the login button. If the login was succesfull, the next step is.. ###### **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.
###### **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.
###### **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.
**Sequence Editor Render Directory**: Directory where sequence editor renderings will be saved before uploading them to kitsu. Cannot be edited
@@ -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. -![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. @@ -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. -![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 @@ -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)
- ![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 @@ -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.
-![image info](./docs/images/sqe_init_selection.jpg) +![image info](/media/addons/blender_kitsu/sqe_init_selection.jpg) ##### 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. -![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.).
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.
@@ -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.
-![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.
@@ -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.
-![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 >>**Note**: Global edit frame range will be saved in `"frame_in"` `"frame_out"` kitsu shot attribute
@@ -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.
-![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. >>**Note**: Frame ranges will **never** be updated when pulling data from Kitsu. They belong to the edit and will only be pushed to Kitsu.
If you have not sequence selected the `Pull Entire Edit` Operator will appear in the `Pull` panel.
-![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.
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.
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 The `Multi Edit` panel only appears when you select multiple metastrips that are all `initialized` but not `linked` yet.
-![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.
###### 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. -![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.
>**Pattern**: supports 3 wildcards. ``, ``, `` that can be used multiple times in any order.
@@ -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. -![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: -![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. -![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.
@@ -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.
-![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.
@@ -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`.
-![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.
**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.
@@ -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`.
-![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. @@ -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.
-![image info](./docs/images/error_animation.jpg) +![image info](/media/addons/blender_kitsu/error_animation.jpg) ## 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. -- 2.30.2 From fe91da6fb4d229c75ed45a289b29e40c07db5d51 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Tue, 16 May 2023 16:28:42 -0400 Subject: [PATCH 04/18] [DOCS] Standardize Addon README Titles --- scripts-blender/addons/anim_cupboard/README.md | 2 ++ scripts-blender/addons/asset_pipeline/README.md | 2 +- scripts-blender/addons/blender_kitsu/README.md | 2 +- scripts-blender/addons/blender_svn/README.md | 2 +- scripts-blender/addons/bone_gizmos/README.md | 5 +++-- scripts-blender/addons/cache_manager/README.md | 2 +- scripts-blender/addons/contactsheet/README.md | 2 +- scripts-blender/addons/grease_converter/README.md | 2 +- scripts-blender/addons/lighting_overrider/README.md | 2 ++ scripts-blender/addons/pose_shape_keys/README.md | 1 + scripts-blender/addons/render_review/README.md | 2 +- 11 files changed, 15 insertions(+), 9 deletions(-) diff --git a/scripts-blender/addons/anim_cupboard/README.md b/scripts-blender/addons/anim_cupboard/README.md index 97b9866d..8e636126 100644 --- a/scripts-blender/addons/anim_cupboard/README.md +++ b/scripts-blender/addons/anim_cupboard/README.md @@ -1,3 +1,5 @@ +# Anim Cupboard + Miscellaneous operators and tools requested by Blender Studio Animators. ### Select Similar Curves diff --git a/scripts-blender/addons/asset_pipeline/README.md b/scripts-blender/addons/asset_pipeline/README.md index ae5d247c..2889bb25 100644 --- a/scripts-blender/addons/asset_pipeline/README.md +++ b/scripts-blender/addons/asset_pipeline/README.md @@ -1,4 +1,4 @@ -# 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. ## Table of Contents diff --git a/scripts-blender/addons/blender_kitsu/README.md b/scripts-blender/addons/blender_kitsu/README.md index b5cf66d0..e0af4040 100644 --- a/scripts-blender/addons/blender_kitsu/README.md +++ b/scripts-blender/addons/blender_kitsu/README.md @@ -1,4 +1,4 @@ -# 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. ## Table of Contents diff --git a/scripts-blender/addons/blender_svn/README.md b/scripts-blender/addons/blender_svn/README.md index 52f817e8..c534926a 100644 --- a/scripts-blender/addons/blender_svn/README.md +++ b/scripts-blender/addons/blender_svn/README.md @@ -1,2 +1,2 @@ -# blender-purge +# Blender SVN blender-svn is a Blender add-on to interact with Subversion from within Blender. diff --git a/scripts-blender/addons/bone_gizmos/README.md b/scripts-blender/addons/bone_gizmos/README.md index 4b74ee0e..a4a41657 100644 --- a/scripts-blender/addons/bone_gizmos/README.md +++ b/scripts-blender/addons/bone_gizmos/README.md @@ -1,7 +1,8 @@ -# What are Bone Gizmos? +# Bone Gizmos +## 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. -# 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. ### Rigger UX diff --git a/scripts-blender/addons/cache_manager/README.md b/scripts-blender/addons/cache_manager/README.md index 879fc45c..5ceebbf9 100644 --- a/scripts-blender/addons/cache_manager/README.md +++ b/scripts-blender/addons/cache_manager/README.md @@ -1,4 +1,4 @@ -# cache-manager +# Cache Manager cache-Manager is a Blender Add-on to streamline the alembic cache workflow of assets. ## Disclaimer diff --git a/scripts-blender/addons/contactsheet/README.md b/scripts-blender/addons/contactsheet/README.md index 84fba197..4f0995b4 100644 --- a/scripts-blender/addons/contactsheet/README.md +++ b/scripts-blender/addons/contactsheet/README.md @@ -1,4 +1,4 @@ -# contactsheet +# Contact Sheet Blender Add-on to create a contactsheet from sequence editor strips. ## Installation diff --git a/scripts-blender/addons/grease_converter/README.md b/scripts-blender/addons/grease_converter/README.md index e947f77c..589411f2 100644 --- a/scripts-blender/addons/grease_converter/README.md +++ b/scripts-blender/addons/grease_converter/README.md @@ -1,4 +1,4 @@ -# grease-converter +# Grease Pencil Converter grease-converter is a Blender Add-on that can convert annotations to grease pencil objects and vise versa. ## Installation diff --git a/scripts-blender/addons/lighting_overrider/README.md b/scripts-blender/addons/lighting_overrider/README.md index 3cc0695f..13d2e0b1 100644 --- a/scripts-blender/addons/lighting_overrider/README.md +++ b/scripts-blender/addons/lighting_overrider/README.md @@ -1 +1,3 @@ +# 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. diff --git a/scripts-blender/addons/pose_shape_keys/README.md b/scripts-blender/addons/pose_shape_keys/README.md index e20bc862..26c448d2 100644 --- a/scripts-blender/addons/pose_shape_keys/README.md +++ b/scripts-blender/addons/pose_shape_keys/README.md @@ -1,3 +1,4 @@ +# Pose Shake Keys 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. diff --git a/scripts-blender/addons/render_review/README.md b/scripts-blender/addons/render_review/README.md index 370ce170..93167d58 100644 --- a/scripts-blender/addons/render_review/README.md +++ b/scripts-blender/addons/render_review/README.md @@ -1,4 +1,4 @@ -# render-review +# Render Review Blender Add-on to review renders from Flamenco with the Sequence Editor ## Table of Contents -- 2.30.2 From 4b23175ff6b07a9d01a0fa13fcd081f715825ad8 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 08:52:51 -0400 Subject: [PATCH 05/18] [DOCS] Clean-up addon's top level readme --- scripts-blender/README.md | 100 ++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 52 deletions(-) diff --git a/scripts-blender/README.md b/scripts-blender/README.md index 3711b5fe..3f6ceb5a 100644 --- a/scripts-blender/README.md +++ b/scripts-blender/README.md @@ -2,19 +2,15 @@ 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: Paul Golter -Maintainers: Nick Alberelli, Francesco Siddi, Demeter Dzadik +Author & Maintainer: 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. @@ -24,72 +20,72 @@ Author: Paul Golter 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 -Maintainer: Demeter Dzadik +Maintainers: Nick Alberelli, Francesco Siddi, Demeter Dzadik - -## 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 +## 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. Author & Maintainer: Demeter Dzadik -## geonode-shapekeys - -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 +## 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 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. 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 +Maintainer: Demeter Dzadik \ No newline at end of file -- 2.30.2 From 9c37325a243660c500bb16438521b4fcb492d5ed Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 09:06:20 -0400 Subject: [PATCH 06/18] [DOCS] Add Table of Contents to all readmes --- scripts-blender/addons/anim_cupboard/README.md | 7 +++++++ scripts-blender/addons/bone_gizmos/README.md | 7 +++++++ scripts-blender/addons/cache_manager/README.md | 7 +++++++ scripts-blender/addons/contactsheet/README.md | 4 ++++ scripts-blender/addons/geonode_shapekeys/README.md | 4 ++++ scripts-blender/addons/grease_converter/README.md | 7 +++++++ scripts-blender/addons/pose_shape_keys/README.md | 6 ++++++ 7 files changed, 42 insertions(+) diff --git a/scripts-blender/addons/anim_cupboard/README.md b/scripts-blender/addons/anim_cupboard/README.md index 8e636126..34220022 100644 --- a/scripts-blender/addons/anim_cupboard/README.md +++ b/scripts-blender/addons/anim_cupboard/README.md @@ -2,6 +2,13 @@ Miscellaneous operators and tools requested by Blender Studio Animators. +## Table of Contents +- [Features](#features) + - [Select Similar Curves](#select-similar-curves) + - [Lock Curves](#lock-curves) + - [Easy Constraints](#easy-constraints) + +## Features ### Select Similar Curves Location: Graph Editor -> Select -> Select Similar Curves diff --git a/scripts-blender/addons/bone_gizmos/README.md b/scripts-blender/addons/bone_gizmos/README.md index a4a41657..60d454e0 100644 --- a/scripts-blender/addons/bone_gizmos/README.md +++ b/scripts-blender/addons/bone_gizmos/README.md @@ -1,4 +1,11 @@ # Bone Gizmos + +## Table of Contents + +- [What are Bone Gizmos?](#what-are-bone-gizmos) +- [Using Bone Gizmos](#using-bone-gizmos) + - [Rigger UX](#rigger-ux) + - [Animator UX](#animator-ux) ## 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. diff --git a/scripts-blender/addons/cache_manager/README.md b/scripts-blender/addons/cache_manager/README.md index 5ceebbf9..0df6fed1 100644 --- a/scripts-blender/addons/cache_manager/README.md +++ b/scripts-blender/addons/cache_manager/README.md @@ -1,6 +1,13 @@ # Cache Manager 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) +- [Development](#development) + ## Disclaimer This addon is not used in the production of the Blender-Studio anymore and is not maintained actively. ## Installation diff --git a/scripts-blender/addons/contactsheet/README.md b/scripts-blender/addons/contactsheet/README.md index 4f0995b4..5e9df884 100644 --- a/scripts-blender/addons/contactsheet/README.md +++ b/scripts-blender/addons/contactsheet/README.md @@ -1,6 +1,10 @@ # Contact Sheet Blender Add-on to create a contactsheet from sequence editor strips. +## Table of Contents +- [Installation](#installation) +- [Features](#features) +- [Development](#development) ## Installation Download or clone this repository. 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. diff --git a/scripts-blender/addons/geonode_shapekeys/README.md b/scripts-blender/addons/geonode_shapekeys/README.md index e0fac1ae..a90b338a 100644 --- a/scripts-blender/addons/geonode_shapekeys/README.md +++ b/scripts-blender/addons/geonode_shapekeys/README.md @@ -1,5 +1,9 @@ # 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. +## Table of Contents + +- [Installation](#installation) +- [How to Use](#how-to-use) ## Installation Download or clone this repository. diff --git a/scripts-blender/addons/grease_converter/README.md b/scripts-blender/addons/grease_converter/README.md index 589411f2..5fb22d8e 100644 --- a/scripts-blender/addons/grease_converter/README.md +++ b/scripts-blender/addons/grease_converter/README.md @@ -1,6 +1,13 @@ # Grease Pencil Converter 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) +- [Development](#development) + + ## Installation Download or clone this repository. 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. diff --git a/scripts-blender/addons/pose_shape_keys/README.md b/scripts-blender/addons/pose_shape_keys/README.md index 26c448d2..d9dd52e5 100644 --- a/scripts-blender/addons/pose_shape_keys/README.md +++ b/scripts-blender/addons/pose_shape_keys/README.md @@ -1,5 +1,11 @@ # Pose Shake Keys +## Table of Contents + +- [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. 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. -- 2.30.2 From 84efc21e065fcb172f5b303722bcd3a30aa439fd Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 09:11:50 -0400 Subject: [PATCH 07/18] [DOCS] Move images for Grease_Converter --- .../addons/grease_converter}/adjustments_panel.jpg | Bin .../grease_converter}/convert_to_grease_pencil.jpg | Bin scripts-blender/addons/grease_converter/README.md | 4 +++- 3 files changed, 3 insertions(+), 1 deletion(-) rename {scripts-blender/addons/grease_converter/docs/images => docs/media/addons/grease_converter}/adjustments_panel.jpg (100%) rename {scripts-blender/addons/grease_converter/docs/images => docs/media/addons/grease_converter}/convert_to_grease_pencil.jpg (100%) diff --git a/scripts-blender/addons/grease_converter/docs/images/adjustments_panel.jpg b/docs/media/addons/grease_converter/adjustments_panel.jpg similarity index 100% rename from scripts-blender/addons/grease_converter/docs/images/adjustments_panel.jpg rename to docs/media/addons/grease_converter/adjustments_panel.jpg diff --git a/scripts-blender/addons/grease_converter/docs/images/convert_to_grease_pencil.jpg b/docs/media/addons/grease_converter/convert_to_grease_pencil.jpg similarity index 100% rename from scripts-blender/addons/grease_converter/docs/images/convert_to_grease_pencil.jpg rename to docs/media/addons/grease_converter/convert_to_grease_pencil.jpg diff --git a/scripts-blender/addons/grease_converter/README.md b/scripts-blender/addons/grease_converter/README.md index 5fb22d8e..382607b9 100644 --- a/scripts-blender/addons/grease_converter/README.md +++ b/scripts-blender/addons/grease_converter/README.md @@ -19,12 +19,14 @@ After the add-on is installed you have 2 new operators available. - Located in the 3DView Side Panel (N)-> View -> Annotations Panel - Converts active annotation to Grease Pencil Object and link it in the active Scene. - drawing + ![drawing](/media/addons/grease_converter/convert_to_grease_pencil.jpg) - **grease_converter.convert_to_annotation**: - 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) - - drawing + + ![drawing](/media/addons/grease_converter/adjustments_panel.jpg) - >**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 -- 2.30.2 From d0f03bcf843a313e695e26375d37bf9d12c9e919 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 09:35:12 -0400 Subject: [PATCH 08/18] [DOCS] Link blogpsot (with video) to Asset Pipeline --- scripts-blender/addons/asset_pipeline/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts-blender/addons/asset_pipeline/README.md b/scripts-blender/addons/asset_pipeline/README.md index 2889bb25..06510c70 100644 --- a/scripts-blender/addons/asset_pipeline/README.md +++ b/scripts-blender/addons/asset_pipeline/README.md @@ -1,5 +1,5 @@ # 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. [Video Presentation avaliable here](https://youtu.be/IBTEBhAouKc?t=527) ## Table of Contents - [Installation](#installation) -- 2.30.2 From 0edadf9e5cbce25589bc09e9d3ddc34dad48c9fa Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 09:35:21 -0400 Subject: [PATCH 09/18] [DOCS] Link blogpsot (with video) to Blender Kitsu --- scripts-blender/addons/blender_kitsu/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scripts-blender/addons/blender_kitsu/README.md b/scripts-blender/addons/blender_kitsu/README.md index e0af4040..05028446 100644 --- a/scripts-blender/addons/blender_kitsu/README.md +++ b/scripts-blender/addons/blender_kitsu/README.md @@ -1,5 +1,7 @@ # 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. + +[Checkout the Blender-Kitsu blogpost](https://studio.blender.org/blog/kitsu-addon-for-blender/) ## Table of Contents - [Installation](#installation) -- 2.30.2 From 9897b0ddf2c6ce8a4c0e33ec668afc1d9382d585 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 10:55:31 -0400 Subject: [PATCH 10/18] [DOCS] Update Blender-SVN readme --- scripts-blender/addons/blender_svn/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/scripts-blender/addons/blender_svn/README.md b/scripts-blender/addons/blender_svn/README.md index c534926a..424f4569 100644 --- a/scripts-blender/addons/blender_svn/README.md +++ b/scripts-blender/addons/blender_svn/README.md @@ -1,2 +1,18 @@ # Blender SVN 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 +You can install the add-on by cloning the Blender Studio Tools repository using git, and then copying the blender-svn/blender_svn folder (the deeper one) into your "addons" folder (location depending on your OS). + +## 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. -- 2.30.2 From d6b7d7356d04379fdca61f96d3f495052d191400 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:01:53 -0400 Subject: [PATCH 11/18] [DOCS] Add Lighing_Overrider readme --- .../addons/lighting_overrider/README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/scripts-blender/addons/lighting_overrider/README.md b/scripts-blender/addons/lighting_overrider/README.md index 13d2e0b1..c55eb633 100644 --- a/scripts-blender/addons/lighting_overrider/README.md +++ b/scripts-blender/addons/lighting_overrider/README.md @@ -1,3 +1,17 @@ # 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. +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. + +- [Installation](#installation) +- [Features](#features) + + +## Installation +Download or clone this repository. +In the root project folder you will find 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` \ No newline at end of file -- 2.30.2 From ddb526591cc94624ef0995780a8e4769271de352 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:02:05 -0400 Subject: [PATCH 12/18] [DOCS] Link video to contact sheet README --- scripts-blender/addons/contactsheet/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts-blender/addons/contactsheet/README.md b/scripts-blender/addons/contactsheet/README.md index 5e9df884..1dfff410 100644 --- a/scripts-blender/addons/contactsheet/README.md +++ b/scripts-blender/addons/contactsheet/README.md @@ -1,5 +1,7 @@ # Contact Sheet Blender Add-on to create a contactsheet from sequence editor strips. + +[Checkout the Contact Sheet Blogpost](https://studio.blender.org/blog/contact-sheet-addon/) ## Table of Contents - [Installation](#installation) -- 2.30.2 From 3b43e733ecc6c5620519f520719693e37b152fcf Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:03:23 -0400 Subject: [PATCH 13/18] [DOCS] Lighting Overrider add table of contents heading --- scripts-blender/addons/lighting_overrider/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts-blender/addons/lighting_overrider/README.md b/scripts-blender/addons/lighting_overrider/README.md index c55eb633..dfe3b90a 100644 --- a/scripts-blender/addons/lighting_overrider/README.md +++ b/scripts-blender/addons/lighting_overrider/README.md @@ -2,6 +2,7 @@ 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) -- 2.30.2 From fec51dca214247de68abade826d41498c528c1a2 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:23:08 -0400 Subject: [PATCH 14/18] [DOCS] Standardize addon installation instructions --- scripts-blender/addons/anim_cupboard/README.md | 6 ++++++ scripts-blender/addons/asset_pipeline/README.md | 5 +++-- scripts-blender/addons/blender_kitsu/README.md | 5 +++-- scripts-blender/addons/blender_svn/README.md | 4 +++- scripts-blender/addons/bone_gizmos/README.md | 8 +++++++- scripts-blender/addons/cache_manager/README.md | 5 +++-- scripts-blender/addons/contactsheet/README.md | 5 +++-- scripts-blender/addons/geonode_shapekeys/README.md | 5 +++-- scripts-blender/addons/grease_converter/README.md | 5 +++-- scripts-blender/addons/lighting_overrider/README.md | 5 +++-- scripts-blender/addons/pose_shape_keys/README.md | 8 +++++++- scripts-blender/addons/render_review/README.md | 5 +++-- 12 files changed, 47 insertions(+), 19 deletions(-) diff --git a/scripts-blender/addons/anim_cupboard/README.md b/scripts-blender/addons/anim_cupboard/README.md index 34220022..0454e7ce 100644 --- a/scripts-blender/addons/anim_cupboard/README.md +++ b/scripts-blender/addons/anim_cupboard/README.md @@ -3,11 +3,17 @@ 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 diff --git a/scripts-blender/addons/asset_pipeline/README.md b/scripts-blender/addons/asset_pipeline/README.md index 06510c70..e9d56ae2 100644 --- a/scripts-blender/addons/asset_pipeline/README.md +++ b/scripts-blender/addons/asset_pipeline/README.md @@ -21,8 +21,9 @@ asset-pipeline is a Blender Add-on that manages the Asset Pipeline of the Blende ## Installation -Download or clone this repository. -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. +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 `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/). diff --git a/scripts-blender/addons/blender_kitsu/README.md b/scripts-blender/addons/blender_kitsu/README.md index 05028446..f7c8ab62 100644 --- a/scripts-blender/addons/blender_kitsu/README.md +++ b/scripts-blender/addons/blender_kitsu/README.md @@ -32,8 +32,9 @@ blender-kitsu is a Blender Add-on to interact with Kitsu from within Blender. It - [Development](#development) ## Installation -Download or clone this repository. -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. +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_kitsu` folder. Place this folder in your Blender addons directory or create a sym link to it. ## How to get started After installing you need to setup the addon preferences to fit your environment. diff --git a/scripts-blender/addons/blender_svn/README.md b/scripts-blender/addons/blender_svn/README.md index 424f4569..ccf76856 100644 --- a/scripts-blender/addons/blender_svn/README.md +++ b/scripts-blender/addons/blender_svn/README.md @@ -7,7 +7,9 @@ blender-svn is a Blender add-on to interact with Subversion from within Blender. - [Installation](#installation) - [Features](#features) ## Installation -You can install the add-on by cloning the Blender Studio Tools repository using git, and then copying the blender-svn/blender_svn folder (the deeper one) into your "addons" folder (location depending on your OS). +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. diff --git a/scripts-blender/addons/bone_gizmos/README.md b/scripts-blender/addons/bone_gizmos/README.md index 60d454e0..cbaa5f5b 100644 --- a/scripts-blender/addons/bone_gizmos/README.md +++ b/scripts-blender/addons/bone_gizmos/README.md @@ -1,11 +1,17 @@ # 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. diff --git a/scripts-blender/addons/cache_manager/README.md b/scripts-blender/addons/cache_manager/README.md index 0df6fed1..596de0fe 100644 --- a/scripts-blender/addons/cache_manager/README.md +++ b/scripts-blender/addons/cache_manager/README.md @@ -11,8 +11,9 @@ cache-Manager is a Blender Add-on to streamline the alembic cache workflow of as ## Disclaimer This addon is not used in the production of the Blender-Studio anymore and is not maintained actively. ## Installation -Download or clone this repository. -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. +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 `cache_manager` folder. Place this folder in your Blender addons directory or create a sym link to it. ## How to get started After installing the addon you need to setup the addon preferences. diff --git a/scripts-blender/addons/contactsheet/README.md b/scripts-blender/addons/contactsheet/README.md index 1dfff410..91b3ff85 100644 --- a/scripts-blender/addons/contactsheet/README.md +++ b/scripts-blender/addons/contactsheet/README.md @@ -8,8 +8,9 @@ Blender Add-on to create a contactsheet from sequence editor strips. - [Features](#features) - [Development](#development) ## Installation -Download or clone this repository. -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. +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 `contactsheet` folder. Place this folder in your Blender addons directory or create a symlink to it. ## Features After the addon is enabled you will find a `Contactsheet` tab in the Sequence Editor Toolbar. diff --git a/scripts-blender/addons/geonode_shapekeys/README.md b/scripts-blender/addons/geonode_shapekeys/README.md index a90b338a..2f77b12b 100644 --- a/scripts-blender/addons/geonode_shapekeys/README.md +++ b/scripts-blender/addons/geonode_shapekeys/README.md @@ -6,8 +6,9 @@ GeoNode Shape Keys is a Blender Add-on that lets you deform linked and overridde - [How to Use](#how-to-use) ## Installation -Download or clone this repository. -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. +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 `geonode_shapekeys`a Place this folder in your Blender addons directory or create a symlink to it. # How to use The add-on's UI is only visible on linked and overridden meshes. diff --git a/scripts-blender/addons/grease_converter/README.md b/scripts-blender/addons/grease_converter/README.md index 382607b9..b967a6cb 100644 --- a/scripts-blender/addons/grease_converter/README.md +++ b/scripts-blender/addons/grease_converter/README.md @@ -9,8 +9,9 @@ grease-converter is a Blender Add-on that can convert annotations to grease penc ## Installation -Download or clone this repository. -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. +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 `grease_converter` folder. Place this folder in your Blender addons directory or create a symlink to it. ## How to get started After the add-on is installed you have 2 new operators available. diff --git a/scripts-blender/addons/lighting_overrider/README.md b/scripts-blender/addons/lighting_overrider/README.md index dfe3b90a..9f3b5e65 100644 --- a/scripts-blender/addons/lighting_overrider/README.md +++ b/scripts-blender/addons/lighting_overrider/README.md @@ -8,8 +8,9 @@ System to create, manage and apply python overrides in a flexible and reliable w ## Installation -Download or clone this repository. -In the root project folder you will find the 'lighting_overrider' folder. Place this folder in your Blender addons directory or create a symlink to it. +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 diff --git a/scripts-blender/addons/pose_shape_keys/README.md b/scripts-blender/addons/pose_shape_keys/README.md index d9dd52e5..9c8438b2 100644 --- a/scripts-blender/addons/pose_shape_keys/README.md +++ b/scripts-blender/addons/pose_shape_keys/README.md @@ -1,7 +1,7 @@ # Pose Shake Keys ## Table of Contents - +- [Installation](#installation) - [Basic Workflow](#basic-workflow) - [Example Use Cases](#example-use-cases) @@ -11,6 +11,12 @@ It also lets you manage multiple copies of a shape key together. Each copy can h 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: - 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. diff --git a/scripts-blender/addons/render_review/README.md b/scripts-blender/addons/render_review/README.md index 93167d58..602522b7 100644 --- a/scripts-blender/addons/render_review/README.md +++ b/scripts-blender/addons/render_review/README.md @@ -8,8 +8,9 @@ Blender Add-on to review renders from Flamenco with the Sequence Editor - [Development](#development) ## Installation -Download or clone this repository. -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. +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 `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. -- 2.30.2 From 5880cc8f627ab51c923eaf9a30a0e83310b41eb6 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:25:19 -0400 Subject: [PATCH 15/18] [DOCS] Fix Flamenco URL in render-reivew addon --- scripts-blender/addons/render_review/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts-blender/addons/render_review/README.md b/scripts-blender/addons/render_review/README.md index 602522b7..d4787cbc 100644 --- a/scripts-blender/addons/render_review/README.md +++ b/scripts-blender/addons/render_review/README.md @@ -16,7 +16,7 @@ After install you need to configure the addon in the addon preferences. ## Before you get started -This addon requires a specific folder structure of the rendering pipeline. This structure is defined by Flamenco +This addon requires a specific folder structure of the rendering pipeline. This structure is defined by Flamenco If you have a different folder structure the addon might not work as expected. -- 2.30.2 From 0aeaf96fa3387050e16731649c3de99b9fe4aaad Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:30:19 -0400 Subject: [PATCH 16/18] [DOCS] remove legacy development messages --- scripts-blender/addons/asset_pipeline/README.md | 6 ------ scripts-blender/addons/blender_kitsu/README.md | 6 ------ scripts-blender/addons/cache_manager/README.md | 9 --------- scripts-blender/addons/contactsheet/README.md | 5 ----- scripts-blender/addons/grease_converter/README.md | 6 ------ scripts-blender/addons/render_review/README.md | 5 ----- 6 files changed, 37 deletions(-) diff --git a/scripts-blender/addons/asset_pipeline/README.md b/scripts-blender/addons/asset_pipeline/README.md index e9d56ae2..dc5bea83 100644 --- a/scripts-blender/addons/asset_pipeline/README.md +++ b/scripts-blender/addons/asset_pipeline/README.md @@ -7,7 +7,6 @@ asset-pipeline is a Blender Add-on that manages the Asset Pipeline of the Blende - [Configuration](#configuration) - [Task Layers](#task_layers.py) - [Hooks](#hooks.py) -- [Development](#development) - [Getting Started as a Developer](#getting-started-as-a-developer) - [Context](#context) - [UI](#ui) @@ -298,12 +297,7 @@ def test_hook_F(context: bpy.types.Context, asset_collection: bpy.types.Collecti 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 diff --git a/scripts-blender/addons/blender_kitsu/README.md b/scripts-blender/addons/blender_kitsu/README.md index f7c8ab62..87118930 100644 --- a/scripts-blender/addons/blender_kitsu/README.md +++ b/scripts-blender/addons/blender_kitsu/README.md @@ -29,7 +29,6 @@ blender-kitsu is a Blender Add-on to interact with Kitsu from within Blender. It - [Error System](#error-system) - [Troubleshoot](#troubleshoot) - [Credits](#credits) -- [Development](#development) ## Installation 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git` @@ -275,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/). 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/basic-usage/ -Create a sym link in your blender addons directory to the blender_kitsu folder. diff --git a/scripts-blender/addons/cache_manager/README.md b/scripts-blender/addons/cache_manager/README.md index 596de0fe..a82dad99 100644 --- a/scripts-blender/addons/cache_manager/README.md +++ b/scripts-blender/addons/cache_manager/README.md @@ -6,7 +6,6 @@ cache-Manager is a Blender Add-on to streamline the alembic cache workflow of as - [Installation](#installation) - [How to Get Started](#how-to-get-started) - [Features](#features) -- [Development](#development) ## Disclaimer This addon is not used in the production of the Blender-Studio anymore and is not maintained actively. @@ -37,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.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. - - diff --git a/scripts-blender/addons/contactsheet/README.md b/scripts-blender/addons/contactsheet/README.md index 91b3ff85..89ecf2a8 100644 --- a/scripts-blender/addons/contactsheet/README.md +++ b/scripts-blender/addons/contactsheet/README.md @@ -6,7 +6,6 @@ Blender Add-on to create a contactsheet from sequence editor strips. - [Installation](#installation) - [Features](#features) -- [Development](#development) ## 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/` @@ -21,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. 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. diff --git a/scripts-blender/addons/grease_converter/README.md b/scripts-blender/addons/grease_converter/README.md index b967a6cb..a8cd14ad 100644 --- a/scripts-blender/addons/grease_converter/README.md +++ b/scripts-blender/addons/grease_converter/README.md @@ -5,7 +5,6 @@ grease-converter is a Blender Add-on that can convert annotations to grease penc - [Installation](#installation) - [How to get Started](#how-to-get-started) -- [Development](#development) ## Installation @@ -29,8 +28,3 @@ After the add-on is installed you have 2 new operators available. ![drawing](/media/addons/grease_converter/adjustments_panel.jpg) - >**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 -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/ diff --git a/scripts-blender/addons/render_review/README.md b/scripts-blender/addons/render_review/README.md index d4787cbc..7378f20e 100644 --- a/scripts-blender/addons/render_review/README.md +++ b/scripts-blender/addons/render_review/README.md @@ -5,7 +5,6 @@ Blender Add-on to review renders from Flamenco with the Sequence Editor - [Installation](#installation) - [Before you get started](#before-you-get-started) - [Features](#features) -- [Development](#development) ## Installation 1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git` @@ -29,10 +28,6 @@ expected. 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 - 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 -- 2.30.2 From 6d24a4b1d4d0eb8c565ce09d6d23b9ea3915a415 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:31:14 -0400 Subject: [PATCH 17/18] [DOCS] Fix Flamenco-docs URL in render-reivew addon --- scripts-blender/addons/render_review/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts-blender/addons/render_review/README.md b/scripts-blender/addons/render_review/README.md index 7378f20e..5ee554d9 100644 --- a/scripts-blender/addons/render_review/README.md +++ b/scripts-blender/addons/render_review/README.md @@ -31,4 +31,4 @@ and copies it over to the shot_preview folder with automatic versioning incremen ## Links -Flamenco Doc +Flamenco Doc -- 2.30.2 From 3823f4c4bd062622f95556a84770219bf0f98a31 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 11:34:16 -0400 Subject: [PATCH 18/18] [DOCS] standardize external links --- scripts-blender/addons/asset_pipeline/README.md | 4 +++- scripts-blender/addons/blender_kitsu/README.md | 2 +- scripts-blender/addons/contactsheet/README.md | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/scripts-blender/addons/asset_pipeline/README.md b/scripts-blender/addons/asset_pipeline/README.md index dc5bea83..d3c81d87 100644 --- a/scripts-blender/addons/asset_pipeline/README.md +++ b/scripts-blender/addons/asset_pipeline/README.md @@ -1,5 +1,7 @@ # 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. [Video Presentation avaliable here](https://youtu.be/IBTEBhAouKc?t=527) +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 - [Installation](#installation) diff --git a/scripts-blender/addons/blender_kitsu/README.md b/scripts-blender/addons/blender_kitsu/README.md index 87118930..e69a2d74 100644 --- a/scripts-blender/addons/blender_kitsu/README.md +++ b/scripts-blender/addons/blender_kitsu/README.md @@ -1,7 +1,7 @@ # 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. -[Checkout the Blender-Kitsu blogpost](https://studio.blender.org/blog/kitsu-addon-for-blender/) +[Blender-Kitsu blogpost](https://studio.blender.org/blog/kitsu-addon-for-blender/) ## Table of Contents - [Installation](#installation) diff --git a/scripts-blender/addons/contactsheet/README.md b/scripts-blender/addons/contactsheet/README.md index 89ecf2a8..5e4ecd52 100644 --- a/scripts-blender/addons/contactsheet/README.md +++ b/scripts-blender/addons/contactsheet/README.md @@ -1,7 +1,7 @@ # Contact Sheet Blender Add-on to create a contactsheet from sequence editor strips. -[Checkout the Contact Sheet Blogpost](https://studio.blender.org/blog/contact-sheet-addon/) +[Contact Sheet Blogpost](https://studio.blender.org/blog/contact-sheet-addon/) ## Table of Contents - [Installation](#installation) -- 2.30.2