From 3a4da7bf6a6530ab84d87550869044d256aec6eb Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 02:10:02 -0400 Subject: [PATCH 01/59] Docs: Move Gentoo related scripts to new section --- docs/.vitepress/config.ts | 62 ++++++++++--------- .../td}/installation.md | 0 .../workstations => gentoo/td}/maintaince.md | 6 +- .../workstations => gentoo/td}/overview.md | 0 .../workstations => gentoo/td}/render_farm.md | 2 +- .../user}/installing-software.md | 4 +- .../user}/introduction.md | 0 .../user}/running-blender.md | 0 .../project-setup => gentoo/user}/svn.md | 0 .../user}/troubleshooting.md | 6 +- .../organization/infrastructure.md | 4 +- 11 files changed, 43 insertions(+), 41 deletions(-) rename docs/{td-guide/workstations => gentoo/td}/installation.md (100%) rename docs/{td-guide/workstations => gentoo/td}/maintaince.md (95%) rename docs/{td-guide/workstations => gentoo/td}/overview.md (100%) rename docs/{td-guide/workstations => gentoo/td}/render_farm.md (98%) rename docs/{user-guide/project-setup/workstations => gentoo/user}/installing-software.md (94%) rename docs/{user-guide/project-setup/workstations => gentoo/user}/introduction.md (100%) rename docs/{user-guide/project-setup/workstations => gentoo/user}/running-blender.md (100%) rename docs/{user-guide/project-setup => gentoo/user}/svn.md (100%) rename docs/{user-guide/project-setup/workstations => gentoo/user}/troubleshooting.md (84%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index c9c47cdf..c5d22694 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -141,24 +141,8 @@ export default defineConfig({ text: 'User Guide', collapsed: false, items: [ - { - text: 'Project Setup', - collapsed: true, - items: [ - { text: 'Intro', link: '/user-guide/project-setup/intro' }, - { text: 'SVN', link: '/user-guide/project-setup/svn' }, - { - text: 'Workstation', - collapsed: true, - items: [ - { text: 'Introduction', link: '/user-guide/project-setup/workstations/introduction' }, - { text: 'Installing Software', link: '/user-guide/project-setup/workstations/installing-software' }, - { text: 'Running Blender', link: '/user-guide/project-setup/workstations/running-blender' }, - { text: 'Troubleshooting', link: '/user-guide/project-setup/workstations/troubleshooting' }, - ], - }, - ], - }, + { text: 'Project Setup', link: '/user-guide/project-setup/intro' }, + { text: 'Running Blender', link: '/user-guide/running_blender' }, { text: 'Organization', collapsed: true, @@ -177,17 +161,6 @@ export default defineConfig({ collapsed: false, items: [ {text: 'Project Setup', link: '/td-guide/project-setup'}, - { - text: 'Workstation', - collapsed: true, - items: [ - { text: 'Overview', link: '/td-guide/workstations/overview'}, - { text: 'Installation', link: '/td-guide/workstations/installation'}, - { text: 'Maintenance', link: '/td-guide/workstations/maintaince'}, - { text: 'Render Farm', link: '/td-guide/workstations/render_farm'}, - - ] - }, ] }, { @@ -207,7 +180,36 @@ export default defineConfig({ {text: 'Asset Publishing', link: '/archive/pipeline-proposal-2019/asset-publishing/introduction'}, {text: 'Character Pipeline Assistant', link: '/archive/pipeline-proposal-2019/asset-publishing/character-pipeline-assistant'}, ], - } + }, + { + text: 'Gentoo', + collapsed: true, + items: [ + { + text: 'TD', + collapsed: false, + items: [ + { text: 'Overview', link: '/gentoo/td/overview'}, + { text: 'Installation', link: '/gentoo/td/installation'}, + { text: 'Maintenance', link: '/gentoo/td/maintaince'}, + { text: 'Render Farm', link: '/gentoo/td/render_farm'}, + ], + }, + + { + text: 'User', + collapsed: false, + items: [ + { text: 'Introduction', link: '/gentoo/user/introduction' }, + { text: 'Installing Software', link: '/gentoo/user/installing-software' }, + { text: 'Running Blender', link: '/gentoo/user/running-blender' }, + { text: 'SVN', link: '/gentoo/user/svn' }, + { text: 'Troubleshooting', link: '/gentoo/user/troubleshooting' }, + + ] + }, + ], + }, ], }, markdown: { diff --git a/docs/td-guide/workstations/installation.md b/docs/gentoo/td/installation.md similarity index 100% rename from docs/td-guide/workstations/installation.md rename to docs/gentoo/td/installation.md diff --git a/docs/td-guide/workstations/maintaince.md b/docs/gentoo/td/maintaince.md similarity index 95% rename from docs/td-guide/workstations/maintaince.md rename to docs/gentoo/td/maintaince.md index 7ea94820..7935b452 100644 --- a/docs/td-guide/workstations/maintaince.md +++ b/docs/gentoo/td/maintaince.md @@ -17,7 +17,7 @@ are used in Gentoo see the [Gentoo Handbook](https://wiki.gentoo.org/wiki/Ebuild 2. `ssh user@build-server-addr` connect to your build server via ssh 3. Update the package recipes on the Build Server `emaint sync --repo blender-studio-overlay` -Once an update of the recipe is complete any affected packages can be installed our updated by following the [Installing Packages on Build Server](/td-guide/workstations/maintaince#installing-packages-on-build-server) guide. +Once an update of the recipe is complete any affected packages can be installed our updated by following the [Installing Packages on Build Server](/gentoo/td/maintaince#installing-packages-on-build-server) guide. ## Installing Packages on Build Server Packages need to be compiled on the Build Server and marked with a date to be able to discovered by the workstations. Follow the below steps to install/update a package on the build server. @@ -32,9 +32,9 @@ The command `emerge --oneshot {package-name}` compiles package, but does not add ::: ## Update Add-ons in `/shared/software/addons` - The software inside the `shared/software/addons` directory are the [Blender Studio Pipeline Add-ons](/addons/overview) and any other Add-ons that need to be distributed to all Blender Studio Users. These Add-ons are considered Live Packages. Live Packages are packages that fetch updates from the source repository directly and are not tied to a specific release. To update packages not included in `/shared/software/addons` see [Installing Software](/user-guide/project-setup/workstations/installing-software) + The software inside the `shared/software/addons` directory are the [Blender Studio Pipeline Add-ons](/addons/overview) and any other Add-ons that need to be distributed to all Blender Studio Users. These Add-ons are considered Live Packages. Live Packages are packages that fetch updates from the source repository directly and are not tied to a specific release. To update packages not included in `/shared/software/addons` see [Installing Software](/gentoo/user/installing-software) -1. Follow the instructions in [Installing Packages on Build Server](/td-guide/workstations/maintaince#installing-packages-on-build-server) using `blender-studio-tools` as the package name. +1. Follow the instructions in [Installing Packages on Build Server](/gentoo/td/maintaince#installing-packages-on-build-server) using `blender-studio-tools` as the package name. ### How to update to specific version? diff --git a/docs/td-guide/workstations/overview.md b/docs/gentoo/td/overview.md similarity index 100% rename from docs/td-guide/workstations/overview.md rename to docs/gentoo/td/overview.md diff --git a/docs/td-guide/workstations/render_farm.md b/docs/gentoo/td/render_farm.md similarity index 98% rename from docs/td-guide/workstations/render_farm.md rename to docs/gentoo/td/render_farm.md index f853ae16..880228d5 100644 --- a/docs/td-guide/workstations/render_farm.md +++ b/docs/gentoo/td/render_farm.md @@ -43,7 +43,7 @@ The Blender add-on also needs to be reloaded, make sure that Blender is restarte This section will only provide a quick rundown of how to update the Flamenco package that is part of the Render Farm setup. -For more details and how to update other packages, see the [Maintenance](/td-guide/workstations/maintaince) page. +For more details and how to update other packages, see the [Maintenance](/gentoo/td/maintaince) page. ::: info Note The Flamenco package should already have the correct [USE flags](https://wiki.gentoo.org/wiki/Handbook:AMD64/Working/USE) configured. diff --git a/docs/user-guide/project-setup/workstations/installing-software.md b/docs/gentoo/user/installing-software.md similarity index 94% rename from docs/user-guide/project-setup/workstations/installing-software.md rename to docs/gentoo/user/installing-software.md index 8258c37b..e2995a3c 100644 --- a/docs/user-guide/project-setup/workstations/installing-software.md +++ b/docs/gentoo/user/installing-software.md @@ -22,7 +22,7 @@ emerge is the default package manager, use emerge to install, update, and genera **emerge** provides commands to install packages onto your system including any dependencies. You must be **root** to make changes via **emerge**. _In this example package name is **spotify**._ -1. [Open Terminal and Become Root](/user-guide/project-setup/workstations/installing-software.md#open-terminal-and-become-root) +1. [Open Terminal and Become Root](/gentoo/user/installing-software.md#open-terminal-and-become-root) 2. Find avaliable packages using the `eix` for example: `eix spotify` ```bash @@ -68,7 +68,7 @@ Dependency resolution took 8.40 s. In this example package name is **spotify**. -1. [Open Terminal and Become Root](/user-guide/project-setup/workstations/installing-software.md#open-terminal-and-become-root) +1. [Open Terminal and Become Root](/gentoo/user/installing-software.md#open-terminal-and-become-root) 2. Remove a package and it’s dependacies safely. 1. `emerge --deselect spotify` 2. `emerge --depclean` diff --git a/docs/user-guide/project-setup/workstations/introduction.md b/docs/gentoo/user/introduction.md similarity index 100% rename from docs/user-guide/project-setup/workstations/introduction.md rename to docs/gentoo/user/introduction.md diff --git a/docs/user-guide/project-setup/workstations/running-blender.md b/docs/gentoo/user/running-blender.md similarity index 100% rename from docs/user-guide/project-setup/workstations/running-blender.md rename to docs/gentoo/user/running-blender.md diff --git a/docs/user-guide/project-setup/svn.md b/docs/gentoo/user/svn.md similarity index 100% rename from docs/user-guide/project-setup/svn.md rename to docs/gentoo/user/svn.md diff --git a/docs/user-guide/project-setup/workstations/troubleshooting.md b/docs/gentoo/user/troubleshooting.md similarity index 84% rename from docs/user-guide/project-setup/workstations/troubleshooting.md rename to docs/gentoo/user/troubleshooting.md index f285fac5..4ad511de 100644 --- a/docs/user-guide/project-setup/workstations/troubleshooting.md +++ b/docs/gentoo/user/troubleshooting.md @@ -16,11 +16,11 @@ _If successful, you will be greated with the following screen_ ![IPXE Boot Menu](/media/user-guide/workstations/gentoo_boot_menu.png) ## Run MEM Test -1. [Boot into IPXE](/user-guide/project-setup/workstations/troubleshooting.md#run-mem-test) +1. [Boot into IPXE](/gentoo/user/troubleshooting.md#run-mem-test) 2. Select “Run MemTest” ## Chrooting into the root drive (for recovery) -1. [Boot into IPXE](/user-guide/project-setup/workstations/troubleshooting.md#run-mem-test) +1. [Boot into IPXE](/gentoo/user/troubleshooting.md#run-mem-test) 2. Select Gentoo Installer (Blender Institute Customized) 3. Wait for Gentoo Installer to boot ![Gentoo Installer](/media/user-guide/workstations/gentoo_installer_boot.png) 4. Use CTR+C to cancel Installer @@ -30,7 +30,7 @@ _If successful, you will be greated with the following screen_ ## Recovery/Inspection of Linux Kernel -1. [Follow steps in Chrooting into the root drive](/user-guide/project-setup/workstations/troubleshooting.md#chrooting-into-the-root-drive-for-recovery) +1. [Follow steps in Chrooting into the root drive](/gentoo/user/troubleshooting.md#chrooting-into-the-root-drive-for-recovery) 2. Ensure the mount the boot drive is mounted **`mount /boot`** 3. Go into the kernel source dir **`cd /usr/src/linux`** 4. Use `make menuconfig` to enter linux kernel configuration diff --git a/docs/pipeline-overview/organization/infrastructure.md b/docs/pipeline-overview/organization/infrastructure.md index 43f16604..741bc8e7 100644 --- a/docs/pipeline-overview/organization/infrastructure.md +++ b/docs/pipeline-overview/organization/infrastructure.md @@ -10,8 +10,8 @@ Artists at Blender Studio use Linux workstations, running Gentoo Linux. While th Artist workstations double as clients for the render farm. -* [**Link to reference manual**](/user-guide/project-setup/workstations/introduction.md) -* [**Link to setup guide**](/td-guide/workstations/overview.md) +* [**Link to reference manual**](/gentoo/user/introduction.md) +* [**Link to setup guide**](/gentoo/td/overview.md) ## Shared storage We use two shared drives -- 2.30.2 From 88a81d374d11ad94a18e4d3fd7b781029ad75dbf Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 02:15:59 -0400 Subject: [PATCH 02/59] Docs: Update Gentoo Blender Guide --- docs/gentoo/user/running-blender.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/gentoo/user/running-blender.md b/docs/gentoo/user/running-blender.md index dfa9e54c..d86a60f7 100644 --- a/docs/gentoo/user/running-blender.md +++ b/docs/gentoo/user/running-blender.md @@ -28,7 +28,7 @@ ``` 3. Select a build by enter a number and pressing Enter to confirm -## Build Blender Locallly +## Build Blender Locally 1. Download Git repo @@ -46,4 +46,12 @@ make ``` -3. Find your built blender `cd ../build_linux` \ No newline at end of file +3. Find your built blender `cd ../build_linux` + +## Debug Build +1. Search for Blender in your Application Launcher +2. The application with the exact name `blender debug` without any suffix is the latest build, it should have a grey icon. + + \ No newline at end of file -- 2.30.2 From 2749877bebf31284a4e13b86b49ef96b7ca61a5d Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 02:38:45 -0400 Subject: [PATCH 03/59] Docs: Add Running Blender User Guide --- docs/user-guide/running_blender.md | 70 ++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs/user-guide/running_blender.md diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md new file mode 100644 index 00000000..8831e643 --- /dev/null +++ b/docs/user-guide/running_blender.md @@ -0,0 +1,70 @@ +# Running Blender + +## Launch Blender from Taskbar/Start Menu + +::: info Available on Gentoo +To learn more about running the Blender if you are on a Gentoo system please see the [Gentoo guide](/gentoo/user/running-blender.md), including how to run a [debug build](/gentoo/user/running-blender.md#debug-build). +::: + + +Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder. + + +::: info Python Requirement +Running this script requires python 2.7+, please ensure python is installed on your system before running blender with the below instructions +::: + +1. Search for Blender in your Application Launcher +2. The application with the name `blender {my_project}` without any suffix is the latest build. + + +![Image of Blender Icon in KDE Taskbar/Start Menu](/media/user-guide/launch_blender.mp4) + +## Launch Blender from Terminal + +To launch Blender from the terminal, open the tools directory within your project folder, and from the terminal use the run Blender script. + +```bash +cd /data/my_project/svn/tools +./run_blender.py +``` + + +## Update Blender + + + +This script will fetch the latest Blender download from https://builder.blender.org/download/ The Blender download for Linux, Mac, and Windows will be downloaded into the `{my_project}/shared/artifacts/blender` folder. It will keep up to 10 previous downloaded versions for backup. + +```bash +cd /data/my_project/svn/tools +./update_blender.py +``` +## Rollback Blender + +Use `rollback_blender.py` to switch the "current" version hosted in `{my_project}/shared/artifacts/blender` to one the older downloads, rolling back affects all users using your project. This is intended to be used to rollback to an older version in case of bugs in newer downloaded versions. + +```bash +cd /data/my_project/svn/tools +./rollback_blender.py +``` + + +### Rollback Blender Locally + +In some cases user may want to roll their machine's local blender to a previous version without affecting other users. + +```bash +cd /data/my_project/svn/tools +./rollback_blender_local.py +``` \ No newline at end of file -- 2.30.2 From c6691b3c87be7be4940c69e4549dfe493a724377 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 02:39:35 -0400 Subject: [PATCH 04/59] Docs: Add Gentoo Setup Guide --- docs/.vitepress/config.ts | 2 +- .../setup.md => td-guide/pipeline-setup.md} | 13 ++++++++++++- 2 files changed, 13 insertions(+), 2 deletions(-) rename docs/{pipeline-overview/quick-start/setup.md => td-guide/pipeline-setup.md} (92%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index c5d22694..90c2f859 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -54,7 +54,6 @@ export default defineConfig({ {text: 'Quick Start', collapsed: true, items: [ - { text: 'Pipeline Setup', link: '/pipeline-overview/quick-start/setup'}, { text: 'Pipeline Usage', link: '/pipeline-overview/quick-start/usage'}, ] }, @@ -160,6 +159,7 @@ export default defineConfig({ text: 'TD Guide', collapsed: false, items: [ + {text: 'Pipeline Setup', link: '/td-guide/pipeline-setup'}, {text: 'Project Setup', link: '/td-guide/project-setup'}, ] }, diff --git a/docs/pipeline-overview/quick-start/setup.md b/docs/td-guide/pipeline-setup.md similarity index 92% rename from docs/pipeline-overview/quick-start/setup.md rename to docs/td-guide/pipeline-setup.md index afd8798e..9388090b 100644 --- a/docs/pipeline-overview/quick-start/setup.md +++ b/docs/td-guide/pipeline-setup.md @@ -130,6 +130,17 @@ mkdir /data/my_project/shared/artifacts/addons cd /data/blender-studio-pipeline/scripts/pipeline-release ./package_local.py /data/my_project/shared/artifacts/addons ``` +### Install Blender Icon + +If a desktop icon is preferred to launch blender + +```bash +cd /data/my_project/svn/tools +./install_desktop_file.sh +``` +::: warning Linux only feature +October 19th 2023 -This feature is only available on linux at this time. Mac & Windows Users must launch Blender via the terminal. +::: ### Setup Blender Add-Ons @@ -142,7 +153,7 @@ cd /data/blender-studio-pipeline/scripts/pipeline-release 2. Search the 'Blender Kitsu' and use the checkbox to Enable the Add-On 3. Set the following settings in the add-on preferences - Login - - Host: `{my_kitsu_server_url}` *Set during [Kitsu Server Setup](/pipeline-overview/quick-start/setup.md#kitsu-server-setup)* + - Host: `{my_kitsu_server_url}` *Set during [Kitsu Server Setup](/td-guide/pipeline-setup.md#kitsu-server-setup)* - Username: `{username@studio.org}` - Password: `{user_password}` - Project Settings -- 2.30.2 From 6300884d59a0b9341d241385f2b45e4c398532a5 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 02:45:47 -0400 Subject: [PATCH 05/59] Docs: Describe when Blender is updated --- docs/gentoo/user/running-blender.md | 3 +++ docs/user-guide/running_blender.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/gentoo/user/running-blender.md b/docs/gentoo/user/running-blender.md index d86a60f7..5d4d1b4a 100644 --- a/docs/gentoo/user/running-blender.md +++ b/docs/gentoo/user/running-blender.md @@ -9,6 +9,9 @@ 1. Open a new Terminal window 2. Type command `blender` ## Roll Back Blender Build + +The Gentoo package manager will update blender daily, to roll back to a previous version follow the guide below. + 1. Login as ********root******** user using `su` 2. Run `rollback_blender.sh` from any folder diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index 8831e643..df17e164 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -44,7 +44,7 @@ cd /data/my_project/svn/tools TODO You can specify the branch to fetch by editing the `BLENDER_BRANCH` variable in the script file. ---> -This script will fetch the latest Blender download from https://builder.blender.org/download/ The Blender download for Linux, Mac, and Windows will be downloaded into the `{my_project}/shared/artifacts/blender` folder. It will keep up to 10 previous downloaded versions for backup. +This script will fetch the latest Blender download from https://builder.blender.org/download/ The Blender download for Linux, Mac, and Windows will be downloaded into the `{my_project}/shared/artifacts/blender` folder. It will keep up to 10 previous downloaded versions for backup. This Blender doesn't update automatically, at least one user in the project must manually initiate an update, all users will receive this update because blender is stored within the `shared` directory. ```bash cd /data/my_project/svn/tools -- 2.30.2 From 584be7a630dbdc6ed182316e1e3e06eed126ff18 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 02:56:34 -0400 Subject: [PATCH 06/59] Docs: Explain where add-ons/config is stored gentoo --- docs/gentoo/user/running-blender.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/gentoo/user/running-blender.md b/docs/gentoo/user/running-blender.md index 5d4d1b4a..b183e001 100644 --- a/docs/gentoo/user/running-blender.md +++ b/docs/gentoo/user/running-blender.md @@ -1,6 +1,12 @@ # Working with Blender ## Launch Blender from Taskbar/Start Menu +This will launch the Blender that is pre-installed on your workstation and updated daily via the package manager. Your Blender configuration including add-ons is stored at `$HOME/.config/blender/{version}/` + + + 1. Search for Blender in your Application Launcher 2. The application with the exact name `blender` without any suffix is the latest build. ![Image of Blender Icon in KDE Taskbar/Start Menu](/media/user-guide/launch_blender.mp4) -- 2.30.2 From 739517fa99f85dcdcf2fc4436d743cfa83b816ba Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 02:56:53 -0400 Subject: [PATCH 07/59] Docs: How often in Blender Updated Gentoo --- docs/gentoo/user/running-blender.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gentoo/user/running-blender.md b/docs/gentoo/user/running-blender.md index b183e001..f15510c4 100644 --- a/docs/gentoo/user/running-blender.md +++ b/docs/gentoo/user/running-blender.md @@ -16,7 +16,7 @@ TODO Verify with Sebastian 2. Type command `blender` ## Roll Back Blender Build -The Gentoo package manager will update blender daily, to roll back to a previous version follow the guide below. +Your workstation's package manager will update blender daily, to roll back to a previous version follow the guide below. 1. Login as ********root******** user using `su` 2. Run `rollback_blender.sh` from any folder -- 2.30.2 From 94abb228e516320b1515e74a5d0ea01c8ca717ba Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 03:09:01 -0400 Subject: [PATCH 08/59] Docs: Update Project Tools Add-Ons --- docs/user-guide/running_blender.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index df17e164..51acb644 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -67,4 +67,11 @@ In some cases user may want to roll their machine's local blender to a previous ```bash cd /data/my_project/svn/tools ./rollback_blender_local.py -``` \ No newline at end of file +``` + +### Update Blender Add-Ons +Blender Add-ons can be packaged directly from the [Blender Studio Pipeline](https://projects.blender.org/studio/blender-studio-pipeline) repository. + +```bash +cd /blender-studio-pipeline/scripts/pipeline-release +./package_local.py /{my_project}/shared/artifacts/addons \ No newline at end of file -- 2.30.2 From 5aae1898b1d84ba402a857ded8acca73a47429f1 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 03:12:12 -0400 Subject: [PATCH 09/59] Docs: Explain where add-ons/config is stored project-tools --- docs/user-guide/running_blender.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index 51acb644..d728c01d 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -9,7 +9,13 @@ To learn more about running the Blender if you are on a Gentoo system please see ::: -Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder. +Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder. Your Blender preferences are stored on a per project basis in `{directory-path}` + + + -- 2.30.2 From 4a72085271c8ec0c42bd780fa6daa7245b6878d5 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 13:18:48 -0400 Subject: [PATCH 11/59] Docs: Add Project Overview --- docs/.vitepress/config.ts | 2 +- docs/index.md | 2 +- docs/user-guide/project-overview.md | 78 ++++++++++++++++++++++++++ docs/user-guide/project-setup/intro.md | 13 ----- 4 files changed, 80 insertions(+), 15 deletions(-) create mode 100644 docs/user-guide/project-overview.md delete mode 100644 docs/user-guide/project-setup/intro.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 90c2f859..d1093752 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -140,7 +140,7 @@ export default defineConfig({ text: 'User Guide', collapsed: false, items: [ - { text: 'Project Setup', link: '/user-guide/project-setup/intro' }, + { text: 'Project Overview', link: '/user-guide/project-overview' }, { text: 'Running Blender', link: '/user-guide/running_blender' }, { text: 'Organization', diff --git a/docs/index.md b/docs/index.md index 47043d9f..77da4db6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ hero: link: /pipeline-overview/introduction - theme: alt text: User Guide - link: /user-guide/project-setup/intro + link: /user-guide/project-overview features: - title: Free Software diff --git a/docs/user-guide/project-overview.md b/docs/user-guide/project-overview.md new file mode 100644 index 00000000..4fb50329 --- /dev/null +++ b/docs/user-guide/project-overview.md @@ -0,0 +1,78 @@ +# Project Overview + +The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project. + +Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This means that absolute paths between operating systems will be the same. This is how the Blender Studio lays out their directories. External studios can use a different root folder for their projects (for example a user's home folder) but the studio TDs will be responsible for ensuring all paths are valid when syncing between operating systems. + +## Directory Layout + +### Project Layout + +The project folder contains all data about the current project, this directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`. + * `local` This is where the local copy of Blender and the add-ons will be installed. + * `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc) + * `svn` This the versioned controlled folder where the .blend production files will live. + +```bash +. +└── my_project/ + ├── local # The local copy of Blender and the add-ons will be installed. + ├── shared # Shared over the network (Syncthing, NFS, Dropbox, etc) + └── svn # Contains the `.blend` production files. (SVN, GIT-LFS, etc) +``` + + + +### Shared +This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure. + + + +```bash +. +├── bts # Behind the scenes +├── concepts # Concept art and paintings +├── development # Piches and boards +├── edit # VSE Editing sequences/exports +├── inspiration # Various inspirations & references +├── music +├── planning +├── pr +├── resources +├── script # Latest scripts for the movie +├── shot_packs # Shots for sharing online +├── training # Training produced for the production +└── videoref # Video shoots from animators +``` + + +### SVN +This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. + +```bash +. +└── svn / + ├── dev / # Anything related to early development or tests + │ ├── boards + │ ├── concepts + │ └── tests + ├── pre/ # For pre-production + │ ├── assets + │ └── shots + ├── pro/ # All files from the production + │ ├── assets/ # All assets from the production + │ │ ├── cam # Camera rig & setup + │ │ ├── chars # Characters & character variations + │ │ ├── fx # Effects + │ │ ├── lgt # Lighting setups + │ │ ├── lib + │ │ ├── maps # General textures and HDRIs + │ │ ├── nodes # General Node groups + │ │ ├── poses # Pose libraries for animation + │ │ ├── props + │ │ ├── scripts + │ │ └── sets + │ ├── config + │ └── shots #Structured into sequences + └── tools +``` diff --git a/docs/user-guide/project-setup/intro.md b/docs/user-guide/project-setup/intro.md deleted file mode 100644 index 1c0e6ea2..00000000 --- a/docs/user-guide/project-setup/intro.md +++ /dev/null @@ -1,13 +0,0 @@ -# Project Setup - -::: warning Work in Progress -30 Apr. 2023 - The content of this page is currently being edited/updated. -::: - -Write how to set up a project in a fully configured workstation and production enviroment. Probably links to other parts of the reference. - -* Ensure SVN access -* Ensure that Blender is configured with the 'shared' add-ons directory -* Ensure Kitsu access -* Checkout SVN project in the appropriate location -* ... -- 2.30.2 From 7ed844db42d736bf644611eb4359df367ce5a7ce Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 14:00:54 -0400 Subject: [PATCH 12/59] Docs: Add Note About Update --- docs/user-guide/running_blender.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index 4f235abf..8ecd70ee 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -52,6 +52,10 @@ TODO You can specify the branch to fetch by editing the `BLENDER_BRANCH` variabl This script will fetch the latest Blender download from https://builder.blender.org/download/ The Blender download for Linux, Mac, and Windows will be downloaded into the `{my_project}/shared/artifacts/blender` folder. It will keep up to 10 previous downloaded versions for backup. This Blender doesn't update automatically, at least one user in the project must manually initiate an update, all users will receive this update because blender is stored within the `shared` directory. +::: info Blender Studio Users +Internally to the Blender Studio only, the blender inside your project is automatically updated overnight, not manual update is required. +::: + ```bash cd /data/my_project/svn/tools ./update_blender.py -- 2.30.2 From 93d6033a400b795232278c17bb7743ca4c33e9a5 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 14:06:15 -0400 Subject: [PATCH 13/59] Docs: Rename Sections with Project Tools --- docs/.vitepress/config.ts | 13 ++++++++++--- .../{pipeline-setup.md => project-tools-setup.md} | 4 ++-- 2 files changed, 12 insertions(+), 5 deletions(-) rename docs/td-guide/{pipeline-setup.md => project-tools-setup.md} (96%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index d1093752..c574209d 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -140,8 +140,15 @@ export default defineConfig({ text: 'User Guide', collapsed: false, items: [ - { text: 'Project Overview', link: '/user-guide/project-overview' }, - { text: 'Running Blender', link: '/user-guide/running_blender' }, + { + text: 'Project Tools', + collapsed: true, + items: [ + { text: 'Project Overview', link: '/user-guide/project-overview' }, + { text: 'Running Blender', link: '/user-guide/running_blender' }, + ], + }, + { text: 'Organization', collapsed: true, @@ -159,7 +166,7 @@ export default defineConfig({ text: 'TD Guide', collapsed: false, items: [ - {text: 'Pipeline Setup', link: '/td-guide/pipeline-setup'}, + {text: 'Project Tools Setup', link: '/td-guide/project-tools-setup'}, {text: 'Project Setup', link: '/td-guide/project-setup'}, ] }, diff --git a/docs/td-guide/pipeline-setup.md b/docs/td-guide/project-tools-setup.md similarity index 96% rename from docs/td-guide/pipeline-setup.md rename to docs/td-guide/project-tools-setup.md index 9388090b..6d28c6cb 100644 --- a/docs/td-guide/pipeline-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -1,4 +1,4 @@ -# Pipeline Setup +# Project Tools Setup ::: warning Work in Progress 15 Oct. 2023 - The content of this page is currently being edited/updated. @@ -153,7 +153,7 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W 2. Search the 'Blender Kitsu' and use the checkbox to Enable the Add-On 3. Set the following settings in the add-on preferences - Login - - Host: `{my_kitsu_server_url}` *Set during [Kitsu Server Setup](/td-guide/pipeline-setup.md#kitsu-server-setup)* + - Host: `{my_kitsu_server_url}` *Set during [Kitsu Server Setup](/td-guide/project-tools-setup.md#kitsu-server-setup)* - Username: `{username@studio.org}` - Password: `{user_password}` - Project Settings -- 2.30.2 From 5120390f964bd53d36d8ccb795d7fd3fcff04b88 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 14:33:49 -0400 Subject: [PATCH 14/59] Docs: Add Mac Windows Linux Shortcuts --- docs/user-guide/running_blender.md | 45 ++++++++++++++++++------------ 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index 8ecd70ee..b15186b4 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -1,38 +1,47 @@ # Running Blender -## Launch Blender from Taskbar/Start Menu +## Create Blender Shortcut + +Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder. Your Blender preferences are stored on a per project basis in `{directory-path}` + +### Create Linux Shortcut -::: info Available on Gentoo -To learn more about running the Blender if you are on a Gentoo system please see the [Gentoo guide](/gentoo/user/running-blender.md), including how to run a [debug build](/gentoo/user/running-blender.md#debug-build). -::: +```bash +cd {my_project}/svn/tools +./install_desktop_file.sh +``` - -Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder. Your Blender preferences are stored on a per project basis in `{directory-path}` - - - -::: info Python Requirement -Running this script requires python 2.7+, please ensure python is installed on your system before running blender with the below instructions -::: - 1. Search for Blender in your Application Launcher 2. The application with the name `blender {my_project}` without any suffix is the latest build. +::: info Available on Gentoo +To learn more about running the Blender if you are on a Gentoo system please see the [Gentoo guide](/gentoo/user/running-blender.md), including how to run a [debug build](/gentoo/user/running-blender.md#debug-build). +::: + + + ![Image of Blender Icon in KDE Taskbar/Start Menu](/media/user-guide/launch_blender.mp4) +---> + +### Create Windows Shortcut + +1. Open the directory `{my_project}/svn/tools` +2. Create a shortcut to `launch_blender_win.bat` on your desktop + +### Create Mac Shortcut + +1. Open the directory `{my_project}/svn/tools` +2. In finder, select the `launch_blender_mac.command` and press `ctrl+shift+command+t` to add it to the dock. + ## Launch Blender from Terminal -- 2.30.2 From 96e5607cb031dbf3db89eadaac80c7aa4c7c53f5 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 14:34:02 -0400 Subject: [PATCH 15/59] Docs: Add Python Requirement --- docs/td-guide/project-tools-setup.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 6d28c6cb..2b65123d 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -8,6 +8,10 @@ In this guide, you will learn how to setup and use the Blender Studio Pipeline, the backbone of [Blender Open Movies](https://studio.blender.org/films/). This workflow relies on Blender, some Blender Add-Ons, and additional services like [Kitsu](https://www.cg-wire.com/kitsu) and [Flamenco](https://flamenco.blender.org/). Wether you are an individual with a single computer or a studio with a full network of workstations, this guide offers a straightforward approach to set up and use the pipeline, complete with easy-to-follow examples. +::: info Python Requirement +Running these scripts requires python 3.11+, please ensure python is installed on your system before running blender with the below instructions +::: + ## Clone Repository The Blender Studio Pipeline git repository contains many tools and resources used in deploying and managing a Blender Studio Pipeline. To start our pipeline we will need to clone this repository. @@ -20,6 +24,7 @@ git clone https://projects.blender.org/studio/blender-studio-pipeline.git ## Generate Folder Structure The first step in deploying the Blender Studio Pipeline is to create the correct folder structure. Many of the tools used in the Blender Studio require the following folder structure on each of your studio workstations. + 1. Create project root directory ```bash mkdir /data/my_project -- 2.30.2 From c09eb339c2f0babc6511a9895ee6633c2509ecee Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 14:36:03 -0400 Subject: [PATCH 16/59] Docs: Clear TODO --- docs/gentoo/user/running-blender.md | 3 --- docs/user-guide/running_blender.md | 5 ----- 2 files changed, 8 deletions(-) diff --git a/docs/gentoo/user/running-blender.md b/docs/gentoo/user/running-blender.md index f15510c4..2e360cfb 100644 --- a/docs/gentoo/user/running-blender.md +++ b/docs/gentoo/user/running-blender.md @@ -2,9 +2,6 @@ ## Launch Blender from Taskbar/Start Menu This will launch the Blender that is pre-installed on your workstation and updated daily via the package manager. Your Blender configuration including add-ons is stored at `$HOME/.config/blender/{version}/` - 1. Search for Blender in your Application Launcher diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index b15186b4..654d18e8 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -13,11 +13,6 @@ cd {my_project}/svn/tools ./install_desktop_file.sh ``` - - 1. Search for Blender in your Application Launcher 2. The application with the name `blender {my_project}` without any suffix is the latest build. -- 2.30.2 From 759eac57bed4187c460d34dfc73acd63f031fefc Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 14:40:48 -0400 Subject: [PATCH 17/59] Docs: Add Choosing Branch Info & Clear TODO --- docs/td-guide/project-tools-setup.md | 4 ++++ docs/user-guide/running_blender.md | 4 ---- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 2b65123d..6f758266 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -128,6 +128,10 @@ cd /data/my_project/svn/tools This will download the latest blender to `/data/my_project/local/blender` +::: info Choosing Branch to Install +You can specify a [daily build](https://builder.blender.org/download/daily/) branch to fetch by editing the `BLENDER_BRANCH` variable in the script file. +::: + ### Install Blender Add-Ons 2. Download required Add-Ons ```bash diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index 654d18e8..9518fe26 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -50,10 +50,6 @@ cd /data/my_project/svn/tools ## Update Blender - - This script will fetch the latest Blender download from https://builder.blender.org/download/ The Blender download for Linux, Mac, and Windows will be downloaded into the `{my_project}/shared/artifacts/blender` folder. It will keep up to 10 previous downloaded versions for backup. This Blender doesn't update automatically, at least one user in the project must manually initiate an update, all users will receive this update because blender is stored within the `shared` directory. ::: info Blender Studio Users -- 2.30.2 From aa1214e9eb8f4354026936eab3c0e55d440ef048 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 15:15:02 -0400 Subject: [PATCH 18/59] Docs: Improve Directoy Overview --- docs/user-guide/project-overview.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/project-overview.md b/docs/user-guide/project-overview.md index 4fb50329..49a64378 100644 --- a/docs/user-guide/project-overview.md +++ b/docs/user-guide/project-overview.md @@ -1,15 +1,15 @@ # Project Overview -The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project. +The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. -Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This means that absolute paths between operating systems will be the same. This is how the Blender Studio lays out their directories. External studios can use a different root folder for their projects (for example a user's home folder) but the studio TDs will be responsible for ensuring all paths are valid when syncing between operating systems. +Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder. ## Directory Layout ### Project Layout -The project folder contains all data about the current project, this directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`. - * `local` This is where the local copy of Blender and the add-ons will be installed. +The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project. + * `local` This is where the local copy of Blender and the add-ons will be installed. This directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`. * `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc) * `svn` This the versioned controlled folder where the .blend production files will live. @@ -27,7 +27,9 @@ The project folder contains all data about the current project, this directory i This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure. - +::: warning Work in Progress +15 Oct. 2023 - The following folder trees are out of data, and will soon be updated. +::: ```bash . ├── bts # Behind the scenes -- 2.30.2 From cce6364e73c17074e37ea235b3726462442d971c Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 15:15:45 -0400 Subject: [PATCH 19/59] Docs: Add Linux Custom Build Guide --- docs/user-guide/running_blender.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/running_blender.md index 9518fe26..7d6cbcc6 100644 --- a/docs/user-guide/running_blender.md +++ b/docs/user-guide/running_blender.md @@ -5,21 +5,22 @@ Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder. Your Blender preferences are stored on a per project basis in `{directory-path}` ### Create Linux Shortcut - ```bash cd {my_project}/svn/tools ./install_desktop_file.sh ``` - -1. Search for Blender in your Application Launcher -2. The application with the name `blender {my_project}` without any suffix is the latest build. - ::: info Available on Gentoo To learn more about running the Blender if you are on a Gentoo system please see the [Gentoo guide](/gentoo/user/running-blender.md), including how to run a [debug build](/gentoo/user/running-blender.md#debug-build). ::: +#### Launch with Custom Build on Linux +You must run the Create Linux Shortcut step before running a custom build. This will launch blender using your custom binary, but with the Add-On and preferences of your project + +1. Navigate to your custom Blender binary +2. Right Click the binary +3. Select `Open with > Blender {my_project}` + + +#### Initial Directory Set-Up +1. Sym-Link the SVN Folder to `/{my_project}/svn` or create your SVN Folder directly in the target directory. +2. Use the following commands to generate the below folder structure. + ```bash + cd /data/blender-studio-pipeline/scripts/project-tools + ./init_folder_structure /data/my_project/svn svn_folder_structure.json + ``` + +#### Add Existing Directory to User Workstation +1. Sym-Link the SVN Folder to `/{my_project}/svn` or Clone your SVN Folder directly into the target directory. + ```bash . -├── config -│ └── asset_pipeline_config -├── previz # Anything related to early development or pre-production tests -└── pro # All files from the production - ├── promo # Promotional material. Often created near the end of production - ├── animation_test # For pre-production - ├── shot_builder # Studio tool configs - ├── lib # All assets from the production - │ ├── brushes - │ ├── cam # Camera rig & setup - │ ├── char # Characters & character variations - │ ├── env # Environment asset libraries - │ ├── fx # Effects - │ ├── lgt # Lighting setups - │ ├── maps # General textures and HDRIs - │ ├── matlib # Materials - │ ├── nodes # General Node groups - │ ├── poselib # Pose libraries for animation - │ ├── props - │ ├── scripts - │ └── sets - └── shots #Structured into sequences +└── svn / + ├── dev / # Anything related to early development or tests + │ ├── boards + │ ├── concepts + │ └── tests + ├── pre/ # For pre-production + │ ├── assets + │ └── shots + ├── pro/ # All files from the production + │ ├── assets/ # All assets from the production + │ │ ├── cam # Camera rig & setup + │ │ ├── chars # Characters & character variations + │ │ ├── fx # Effects + │ │ ├── lgt # Lighting setups + │ │ ├── lib + │ │ ├── maps # General textures and HDRIs + │ │ ├── nodes # General Node groups + │ │ ├── poses # Pose libraries for animation + │ │ ├── props + │ │ ├── scripts + │ │ └── sets + │ ├── config + │ └── shots #Structured into sequences + └── tools ``` ## Kitsu Server Setup Kitsu is a project management software used by the Blender Studio for task management. The server is used to assign tasks to artists, as well as a track each shot as it moves through production The Kitsu server is required for automatically building shots. -- 2.30.2 From 8e67ae316cc84665f13d30b7fe33c6a5a7cf514f Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 16:16:25 -0400 Subject: [PATCH 25/59] Docs: Add Comments to SVN Folder Structure --- .../svn-folder-structure.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/naming-conventions/svn-folder-structure.md b/docs/naming-conventions/svn-folder-structure.md index 36e42cdf..d870c7a9 100644 --- a/docs/naming-conventions/svn-folder-structure.md +++ b/docs/naming-conventions/svn-folder-structure.md @@ -15,32 +15,32 @@ October 17th 2023 - The content of this page is currently being edited/updated. * `maps` folder ## Proposal adopted in October 2023: -``` -pro -├── assets -│ ├── chars +``` bash +pro # All files from the production +├── assets # All assets from the production +│ ├── chars # Characters & character variations │ │ ├── dog │ │ ├── cat │ │ └── .. -│ ├── props +│ ├── props # Rigged props that can have animation │ │ ├── rocket_exterior │ │ ├── wings │ │ └── ... -│ ├── sets +│ ├── sets # Static background elements │ │ ├── barn │ │ ├── rocket_interior │ │ └── ... -│ ├── lib +│ ├── lib # Libraries of smaller assets │ │ ├── rocks │ │ ├── trees │ │ ├── crates │ │ └── ... -│ ├── maps -│ ├── lgt -│ ├── cam -│ ├── fx -│ ├── poses -│ ├── nodes +│ ├── maps # General textures and HDRIs +│ ├── lgt # Lighting setups +│ ├── cam # Camera rig +│ ├── fx # Effects +│ ├── poses # Pose libraries for animation +│ ├── nodes # General Node groups │ └── scripts ├── shots │ ├── 000_titles @@ -50,13 +50,13 @@ pro │ ├── 900_animtest │ └── 990_promo └── config -pre -├── shots +pre # For pre-production +├── shots # Structured into sequences └── assets ├── cam ├── char └── ... -dev +dev # Anything related to early development or tests ├── concepts ├── boards ├── tests -- 2.30.2 From 06c5205aaaedb192694e299c86487dc1fb587233 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 16:27:59 -0400 Subject: [PATCH 26/59] Docs: Move Project Overview to User Guide & Link to Folder Pages --- docs/.vitepress/config.ts | 2 +- docs/index.md | 2 +- docs/td-guide/project-overview.md | 80 ------------------- docs/td-guide/project-tools-setup.md | 26 +----- .../project_tools/project-overview.md | 24 ++++++ 5 files changed, 30 insertions(+), 104 deletions(-) delete mode 100644 docs/td-guide/project-overview.md create mode 100644 docs/user-guide/project_tools/project-overview.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index dbd67b70..42ce7b14 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -138,6 +138,7 @@ export default defineConfig({ text: 'Project Tools', collapsed: true, items: [ + { text: 'Project Overview', link: '/user-guide/project_tools/project-overview' }, { text: 'Pipeline Usage', link: '/user-guide/quick_start'}, { text: 'Running Blender', link: '/user-guide/running_blender' }, ], @@ -164,7 +165,6 @@ export default defineConfig({ text: 'Project Tools', collapsed: true, items: [ - { text: 'Project Overview', link: '/td-guide/project-overview' }, {text: 'Project Setup', link: '/td-guide/project-tools-setup'}, ], }, diff --git a/docs/index.md b/docs/index.md index a33e4951..098348b4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ hero: link: /pipeline-overview/introduction - theme: alt text: User Guide - link: /td-guide/project-overview + link: /user-guide/project_tools/project-overview features: - title: Free Software diff --git a/docs/td-guide/project-overview.md b/docs/td-guide/project-overview.md deleted file mode 100644 index 49a64378..00000000 --- a/docs/td-guide/project-overview.md +++ /dev/null @@ -1,80 +0,0 @@ -# Project Overview - -The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. - -Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder. - -## Directory Layout - -### Project Layout - -The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project. - * `local` This is where the local copy of Blender and the add-ons will be installed. This directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`. - * `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc) - * `svn` This the versioned controlled folder where the .blend production files will live. - -```bash -. -└── my_project/ - ├── local # The local copy of Blender and the add-ons will be installed. - ├── shared # Shared over the network (Syncthing, NFS, Dropbox, etc) - └── svn # Contains the `.blend` production files. (SVN, GIT-LFS, etc) -``` - - - -### Shared -This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure. - - -::: warning Work in Progress -15 Oct. 2023 - The following folder trees are out of data, and will soon be updated. -::: -```bash -. -├── bts # Behind the scenes -├── concepts # Concept art and paintings -├── development # Piches and boards -├── edit # VSE Editing sequences/exports -├── inspiration # Various inspirations & references -├── music -├── planning -├── pr -├── resources -├── script # Latest scripts for the movie -├── shot_packs # Shots for sharing online -├── training # Training produced for the production -└── videoref # Video shoots from animators -``` - - -### SVN -This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. - -```bash -. -└── svn / - ├── dev / # Anything related to early development or tests - │ ├── boards - │ ├── concepts - │ └── tests - ├── pre/ # For pre-production - │ ├── assets - │ └── shots - ├── pro/ # All files from the production - │ ├── assets/ # All assets from the production - │ │ ├── cam # Camera rig & setup - │ │ ├── chars # Characters & character variations - │ │ ├── fx # Effects - │ │ ├── lgt # Lighting setups - │ │ ├── lib - │ │ ├── maps # General textures and HDRIs - │ │ ├── nodes # General Node groups - │ │ ├── poses # Pose libraries for animation - │ │ ├── props - │ │ ├── scripts - │ │ └── sets - │ ├── config - │ └── shots #Structured into sequences - └── tools -``` diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 36c19fef..8bd9c70a 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -55,31 +55,13 @@ mkdir /data/my_project/render/ This directory is used for the temporary storage of render files generated by Flamenco. This storage must be accessible by all computers using Flamenco for rendering, commonly this is a Network Attached Storage of some kind. In this guide, our renders will live in the root of our project directory. -::: warning Work in Progress -15 Oct. 2023 - The following folder trees are out of data, and will soon be updated. -::: + ### Populating `shared` This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure. - - -```bash -. -├── bts # Behind the scenes -├── concepts # Concept art and paintings -├── development # Piches and boards -├── edit # VSE Editing sequences/exports -├── inspiration # Various inspirations & references -├── music -├── planning -├── pr -├── resources -├── script # Latest scripts for the movie -├── shot_packs # Shots for sharing online -├── training # Training produced for the production -└── videoref # Video shoots from animators -``` - +::: warning Work in Progress +15 Oct. 2023 - The following folder trees are out of data, and will soon be updated. +::: ### Populating `SVN` This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. diff --git a/docs/user-guide/project_tools/project-overview.md b/docs/user-guide/project_tools/project-overview.md new file mode 100644 index 00000000..d99b9f9c --- /dev/null +++ b/docs/user-guide/project_tools/project-overview.md @@ -0,0 +1,24 @@ +# Project Overview + +The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. + +Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder. + +## Directory Layout + +The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project. + * `local` This is where the local copy of Blender and the add-ons will be installed. This directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`. + * `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc) + * `svn` This the versioned controlled folder where the .blend production files will live. + +```bash +. +└── my_project/ + ├── local # The local copy of Blender and the add-ons will be installed. + ├── shared # Shared over the network (Syncthing, NFS, Dropbox, etc) + └── svn # Contains the `.blend` production files. (SVN, GIT-LFS, etc) +``` + +To learn the layout of the above directories, see the [`shared`](/naming-conventions/shared-folder-structure.md) and [`svn`](/naming-conventions/svn-folder-structure.md) directory overviews. + +To learn more about setting up a production pipeline using the project tools see the [Project Tools Setup Guide](/td-guide/project-tools-setup.md) \ No newline at end of file -- 2.30.2 From df55c96b51b76a826e5542bbe72f1fd48459f654 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 16:28:07 -0400 Subject: [PATCH 27/59] Docs: Re-organize User Pages --- docs/.vitepress/config.ts | 4 ++-- docs/user-guide/{ => project_tools}/quick_start.md | 0 docs/user-guide/{ => project_tools}/running_blender.md | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/user-guide/{ => project_tools}/quick_start.md (100%) rename docs/user-guide/{ => project_tools}/running_blender.md (100%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 42ce7b14..7c212ed9 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -139,8 +139,8 @@ export default defineConfig({ collapsed: true, items: [ { text: 'Project Overview', link: '/user-guide/project_tools/project-overview' }, - { text: 'Pipeline Usage', link: '/user-guide/quick_start'}, - { text: 'Running Blender', link: '/user-guide/running_blender' }, + { text: 'Pipeline Usage', link: '/user-guide/project_tools/quick_start'}, + { text: 'Running Blender', link: '/user-guide/project_tools/running_blender' }, ], }, diff --git a/docs/user-guide/quick_start.md b/docs/user-guide/project_tools/quick_start.md similarity index 100% rename from docs/user-guide/quick_start.md rename to docs/user-guide/project_tools/quick_start.md diff --git a/docs/user-guide/running_blender.md b/docs/user-guide/project_tools/running_blender.md similarity index 100% rename from docs/user-guide/running_blender.md rename to docs/user-guide/project_tools/running_blender.md -- 2.30.2 From 4d3275528389a3d0cffa9f09261b70ed4bf1d709 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 16:41:24 -0400 Subject: [PATCH 28/59] Docs: Standardize `{My_Project}` and remove `/data` from non set-up pages --- docs/td-guide/project-tools-setup.md | 30 ++++++++--------- docs/user-guide/project_tools/quick_start.md | 32 +++++++++---------- .../project_tools/running_blender.md | 8 ++--- 3 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 8bd9c70a..61e122d1 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -27,7 +27,7 @@ The first step in deploying the Blender Studio Pipeline is to create the correct 1. Create project root directory ```bash -mkdir /data/my_project +mkdir /data/{my_project} ``` @@ -38,7 +38,7 @@ cd /data/blender-studio-pipeline/scripts/project-tools 3. Create base folder structure using ```bash -./init_project_folder_structure.py /data/my_project +./init_project_folder_structure.py /data/{my_project} ``` @@ -50,7 +50,7 @@ This will create the bones of your production's directories. 3. Create render directory ```bash -mkdir /data/my_project/render/ +mkdir /data/{my_project}/render/ ``` This directory is used for the temporary storage of render files generated by Flamenco. This storage must be accessible by all computers using Flamenco for rendering, commonly this is a Network Attached Storage of some kind. In this guide, our renders will live in the root of our project directory. @@ -71,7 +71,7 @@ This is the folder that should contain a version controlled file system to be sh 2. Use the following commands to generate the below folder structure. ```bash cd /data/blender-studio-pipeline/scripts/project-tools - ./init_folder_structure /data/my_project/svn svn_folder_structure.json + ./init_folder_structure /data/{my_project}/svn svn_folder_structure.json ``` #### Add Existing Directory to User Workstation @@ -116,11 +116,11 @@ The next step is to deploy the required software onto each of the studio's works 1. Download the latest Blender ```bash -cd /data/my_project/svn/tools +cd /data/{my_project}/svn/tools ./update_blender.py ``` -This will download the latest blender to `/data/my_project/local/blender` +This will download the latest blender to `/data/{my_project}/local/blender` ::: info Choosing Branch to Install You can specify a [daily build](https://builder.blender.org/download/daily/) branch to fetch by editing the `BLENDER_BRANCH` variable in the script file. @@ -129,16 +129,16 @@ You can specify a [daily build](https://builder.blender.org/download/daily/) bra ### Install Blender Add-Ons 2. Download required Add-Ons ```bash -mkdir /data/my_project/shared/artifacts/addons +mkdir /data/{my_project}/shared/artifacts/addons cd /data/blender-studio-pipeline/scripts/pipeline-release -./package_local.py /data/my_project/shared/artifacts/addons +./package_local.py /data/{my_project}/shared/artifacts/addons ``` ### Install Blender Icon If a desktop icon is preferred to launch blender ```bash -cd /data/my_project/svn/tools +cd /data/{my_project}/svn/tools ./install_desktop_file.sh ``` ::: warning Linux only feature @@ -161,9 +161,9 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W - Password: `{user_password}` - Project Settings - Select Production: Choose the current Production - - Project Root Directory: `/data/my_project/svn` + - Project Root Directory: `/data/{my_project}/svn` - Animation Tools - - Playblast directory: `/data/my_project/shared/shot_previews/` + - Playblast directory: `/data/{my_project}/shared/shot_previews/` ![Blender Kitsu Preferences](/media/pipeline-overview/quick-start/kitsu_pref.png) @@ -172,9 +172,9 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W 2. Search the 'Render Review' and use the checkbox to Enable the Add-On 3. Set the following settings in the add-on preferences - Ensure `Enable Blender Kitsu` is Enabled - - Render Farm: `/data/my_project/render/` - - Shot Frames: `/data/my_project/shared/shot_frames/` - - Shot Previews: `/data/my_project/shared/shot_previews/` + - Render Farm: `/data/{my_project}/render/` + - Shot Frames: `/data/{my_project}/shared/shot_frames/` + - Shot Previews: `/data/{my_project}/shared/shot_previews/` ![Render Review Preferences](/media/pipeline-overview/quick-start/render_review_pref.png) @@ -186,4 +186,4 @@ mkdir /data/flamenco_storage ``` 1. Follow the instructions at https://flamenco.blender.org/usage/quickstart/ to setup Flamenco 2. During Flamenco Manager Setup use `/data/flamenco_storage` as the shared storage directory -3. During Flamenco Manager Setup use `/data/my_project/local/blender/{os}/blender` as the Blender Executable Path +3. During Flamenco Manager Setup use `/data/{my_project}/local/blender/{os}/blender` as the Blender Executable Path diff --git a/docs/user-guide/project_tools/quick_start.md b/docs/user-guide/project_tools/quick_start.md index f50d060f..c581feaf 100644 --- a/docs/user-guide/project_tools/quick_start.md +++ b/docs/user-guide/project_tools/quick_start.md @@ -6,14 +6,14 @@ ## Launching Blender To launch Blender use the following command ```bash -cd /data/my_project/svn/tools +cd {my_project}/{my_project}/svn/tools ./run_blender.py ``` If a desktop icon is preferred to launch blender ```bash -cd /data/my_project/svn/tools +cd {my_project}/{my_project}/svn/tools ./install_desktop_file.sh ``` @@ -22,7 +22,7 @@ cd /data/my_project/svn/tools Most productions begin with a previz or storyboard step, showing the overall direction and plan for the production. By inputting this as video strip(s) into a VSE file we can automatically create the corresponding shots on the Kitsu Server directly from the VSE. 1. If not already ensure your project settings are setup [Blender Kitsu Add-On Preferences](https://studio.blender.org/pipeline/addons/blender_kitsu#how-to-get-started) -2. At the directory `/data/my_project/shared/edit` create a new "Video Editing" File. +2. At the directory `{my_project}/{my_project}/shared/edit` create a new "Video Editing" File. 3. Populate your new edit file with your previz video strips 4. With your first strip selected, in the Blender Kitsu side panel of the VSE select "Create Metastrip Active Shot” to create a new metastrip. 5. Next select “Init Active Shot”, and enter the Shot and Sequence names you would like to submit to Kitsu. @@ -38,7 +38,7 @@ The next step is to create an asset and store that information into the Kitsu Se 1. Launch Blender via [Launching Software] Guide 2. Under `Edit>Preferences>Add-Ons` ensure `Asset Pipeline` is enabled 3. Follow the[ asset pipeline guide](https://studio.blender.org/pipeline/addons/asset_pipeline#how-to-get-started) to create a new asset (optional) -4. Save the above asset within the directory `/data/my_project/svn/pro/lib/char` +4. Save the above asset within the directory `{my_project}/{my_project}/svn/pro/lib/char` 5. Create a matching entry in Kitsu for the above asset via the [Create Assets guide](https://kitsu.cg-wire.com/first_production/#create-assets) 6. Follow the [casting guide](https://forum.cg-wire.com/t/breakdown-casting-widget-for-kitsu/31) in the breakdown section to assign assets to shots. @@ -47,12 +47,12 @@ The next step is to create an asset and store that information into the Kitsu Se Inside your production’s directory the Shot Builder configuration files need to be created using the [examples](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs/examples) included in the Add-On directory. See the Shot Builder Config [Directory Layout](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs#directory-layout) for details. The only configuration file that requires production specific edits is `assets.py`. This configuration file links the Kitsu Asset entries to their corresponding files in the production directory. -1. Copy Configuration Files from [examples](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs/examples) to `/data/my_project/svn/pro/shot-builder/` +1. Copy Configuration Files from [examples](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs/examples) to `{my_project}/{my_project}/svn/pro/shot-builder/` 2. Update `assets.py` file with each asset you have in your `lib` folder see the [Shot Builder API](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs#api) -3. Ensure your camera rig is present at the path `/data/my_project/svn/pro/lib/cam/camera_rig.blend` +3. Ensure your camera rig is present at the path `{my_project}/{my_project}/svn/pro/lib/cam/camera_rig.blend` 4. Open a new Blender File, select `File>New>Shot File` 5. Select the desired Sequence/Shot from Kitsu and select OK to start Building -6. New file will be saved to `/data/my_project/svn/pro/shots/{sequence}/{shot}/{shot}.blend +6. New file will be saved to `{my_project}/{my_project}/svn/pro/shots/{sequence}/{shot}/{shot}.blend ## Playblast your First Shot Once your first shot is animated you are ready to render a playblast of this shot, which will be later imported into your edit .blend file. @@ -69,19 +69,19 @@ For each new task type, Anim/Layout etc needs to be added manually, then it can Returning to your edit .blend file, we can now load the playblast from the animation file into the edit. -1. Open your edit .blend file inside the directory `/data/my_project/shared/edit` +1. Open your edit .blend file inside the directory `{my_project}/{my_project}/shared/edit` 2. From the Sequencer Header select `Add>Movie` -3. Navigate to the directory of the playblast for your shot's .blend file `/data/my_project/shared/shot_previews/{sequence_name}/{shot_name}/{file_name}` and select the `.mp4` file +3. Navigate to the directory of the playblast for your shot's .blend file `{my_project}/{my_project}/shared/shot_previews/{sequence_name}/{shot_name}/{file_name}` and select the `.mp4` file 4. Place the new shot at the same timing as the corresponding metastrip ## Adjusting a Shot's Frame Range During production in some cases the frame range of a shot will change, either adjusting a shot's length or adjusting it's position in the edit. Once adjusted, we can update the shot .blend file's frame range so new playblasts will match this updated frame range. Once a new playblast is available the shot can automatically be updated in the VSE via the Blender Kitsu Add-On -1. Open your edit .blend file inside the directory `/data/my_project/shared/edit +1. Open your edit .blend file inside the directory `{my_project}/{my_project}/shared/edit 2. Select a shot and it's metastrip, adjust the timing of both strips so they remain in sync. 3. Select your metastrip, in the Kitsu Sidebar of the VSE Under Push select `Metadata 1 Shot` to push your shot's new frame range to the Kitsu Server 4. Open your shot .blend file inside the directory - `/data/my_project/svn/pro/shots/{sequence_name}/{shot_name}/ + `{my_project}/{my_project}/svn/pro/shots/{sequence_name}/{shot_name}/ 5. Inside the Kitsu Sidebar, under Playblast tools, if your frame range on Kitsu has changed you will see a red `Pull Frame Range` button. Select it to update the file's Frame Range 6. Adjust the shot's animation to accommodate the new frame range, then under Playblast use the `+` button to create a new version, then select `Create Playblast` to render a new playblast 7. Open your edit .blend file, and select the movie strip for the shot you would like to update. @@ -96,7 +96,7 @@ Once your shots are all ready to go, you can now render a final EXR from each of 3. In the properties panel navigate under Flamenco 1. Select `Fetch Job Types` 2. From the Dropdown select `Simple Blender Render` - 3. Set Render Output Directory to `/data/my_project/render/` + 3. Set Render Output Directory to `{my_project}/{my_project}/render/` 4. Set Add Path Components to `3` 5. Finally Select `Submit to Flamenco` @@ -123,16 +123,16 @@ Once the approved image sequences have been loaded into the main edit you are re 1. Open your Edit .blend file 2. Render Video as PNG Sequence - 1. Under `Properties>Output` Set the output directory to `/data/my_production/shared/edit/delivery/frames/` + 1. Under `Properties>Output` Set the output directory to `{my_project}/{my_project}/shared/edit/delivery/frames/` 2. Set the File Format to `PNG` 3. Select `Render>Render Animation` 3. Render Audio 1. Select `Render>Render Audio` 2. In the Side Panel select Container `.wav` - 3. Set the output directory to `/data/my_production/shared/edit/delivery/audio/` + 3. Set the output directory to `{my_project}/{my_project}/shared/edit/delivery/audio/` 4. Run Deliver script - 1. Copy the `delivery.py` from `/data/blender-studio-pipeline/film-delivery/` to the directory `/my_production/shared/edit/delivery/` - 2. Enter delivery directory `cd /my_production/shared/edit/delivery/ + 1. Copy the `delivery.py` from `{my_project}/blender-studio-pipeline/film-delivery/` to the directory `/{my_project}/shared/edit/delivery/` + 2. Enter delivery directory `cd /{my_project}/shared/edit/delivery/ 3. Encode audio with `./deliver.py --encode_audio audio/{name_of_audio}.wav` 4. Encode video with `.deliver.py --encode_video frames/` 5. Finally `.delivery.py --mux` diff --git a/docs/user-guide/project_tools/running_blender.md b/docs/user-guide/project_tools/running_blender.md index d70acaa2..6e57d32c 100644 --- a/docs/user-guide/project_tools/running_blender.md +++ b/docs/user-guide/project_tools/running_blender.md @@ -44,7 +44,7 @@ TODO Replace Image with Project-Tools version To launch Blender from the terminal, open the tools directory within your project folder, and from the terminal use the run Blender script. ```bash -cd /data/my_project/svn/tools +cd /{my_project}/svn/tools ./run_blender.py ``` @@ -61,7 +61,7 @@ Internally to the Blender Studio only, the blender inside your project is automa ::: ```bash -cd /data/my_project/svn/tools +cd /{my_project}/svn/tools ./update_blender.py ``` ## Rollback Blender @@ -69,7 +69,7 @@ cd /data/my_project/svn/tools Use `rollback_blender.py` to switch the "current" version hosted in `{my_project}/shared/artifacts/blender` to one the older downloads, rolling back affects all users using your project. This is intended to be used to rollback to an older version in case of bugs in newer downloaded versions. ```bash -cd /data/my_project/svn/tools +cd /{my_project}/svn/tools ./rollback_blender.py ``` @@ -79,7 +79,7 @@ cd /data/my_project/svn/tools In some cases user may want to roll their machine's local blender to a previous version without affecting other users. ```bash -cd /data/my_project/svn/tools +cd /{my_project}/svn/tools ./rollback_blender_local.py ``` -- 2.30.2 From e18a6bf9e539c9fb395a5d86e51b7f63d3415524 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 16:46:59 -0400 Subject: [PATCH 29/59] Docs: Remove Symlink from SVN setup guide --- docs/td-guide/project-tools-setup.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 61e122d1..a4c6fd7b 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -63,11 +63,16 @@ This is the folder that should be shared over the network. (By using Syncthing, 15 Oct. 2023 - The following folder trees are out of data, and will soon be updated. ::: + + + ### Populating `SVN` This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. #### Initial Directory Set-Up -1. Sym-Link the SVN Folder to `/{my_project}/svn` or create your SVN Folder directly in the target directory. +1. Create your SVN Folder directly in the target directory `/{my_project}/svn`. 2. Use the following commands to generate the below folder structure. ```bash cd /data/blender-studio-pipeline/scripts/project-tools @@ -75,7 +80,7 @@ This is the folder that should contain a version controlled file system to be sh ``` #### Add Existing Directory to User Workstation -1. Sym-Link the SVN Folder to `/{my_project}/svn` or Clone your SVN Folder directly into the target directory. +1. Clone your SVN Folder directly into the target directory `/{my_project}/svn`. ```bash -- 2.30.2 From 29fc1fad33a8ab50acc6353c93012cea6a42aba5 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 16:48:54 -0400 Subject: [PATCH 30/59] Docs: Re-organize TD Guide Section --- docs/.vitepress/config.ts | 11 +--- docs/td-guide/project-setup.md | 79 ---------------------------- docs/td-guide/project-tools-setup.md | 2 +- 3 files changed, 3 insertions(+), 89 deletions(-) delete mode 100644 docs/td-guide/project-setup.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 7c212ed9..831acc49 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -160,15 +160,8 @@ export default defineConfig({ { text: 'TD Guide', collapsed: true, - items: [ - { - text: 'Project Tools', - collapsed: true, - items: [ - {text: 'Project Setup', link: '/td-guide/project-tools-setup'}, - ], - }, - {text: 'Project Setup', link: '/td-guide/project-setup'}, + items: [ + {text: 'Project Tools Setup', link: '/td-guide/project-tools-setup'}, ] }, { diff --git a/docs/td-guide/project-setup.md b/docs/td-guide/project-setup.md deleted file mode 100644 index 6df17aaa..00000000 --- a/docs/td-guide/project-setup.md +++ /dev/null @@ -1,79 +0,0 @@ -# Project Setup - -::: warning Work in Progress -30 Apr. 2023 - The content of this page is currently being edited/updated. -::: - -* Setup SVN (access for users) -* Setup Kitsu project -* Commit intial folder structure - -## Project Directory - -```python -. -├── config -│ └── asset_pipeline_config -├── previz # Anything related to early development or pre-production tests -└── pro # All files from the production - ├── promo # Promotional material. Often created near the end of production - ├── animation_test # For pre-production - ├── shot_builder # Studio tool configs - ├── lib # All assets from the production - │   ├── brushes - │   ├── cam # Camera rig & setup - │   ├── char # Characters & character variations - │   ├── env # Environment asset libraries - │   ├── fx # Effects - │   ├── lgt # Lighting setups - │   ├── maps # General textures and HDRIs - │   ├── matlib # Materials - │   ├── nodes # General Node groups - │   ├── poselib # Pose libraries for animation - │   ├── props - │   ├── scripts - │   └── sets - └── shots #Structured into sequences - ``` - -## Render Directory - -``` -. -├── chaches -├── delivery -│   ├── audio -│   ├── color_preview -│   ├── mux -│   └── video -├── editorial -│   ├── edit -│   ├── export -│   ├── fonts -│   ├── score -│   └── sfx -├── farm_output -│   ├── lib -│   └── shots -├── plates -├── shot_frames -└── shot_previews -``` - -## Shared Directory - -```python -. -├── bts # Behind the scenes -├── concepts # Concept art and paintings -├── development # Piches and boards -├── inspiration # Various inspirations & references -├── music -├── planning -├── pr -├── resources -├── script # Latest scripts for the movie -├── shot_packs # Shots for sharing online -├── training # Training produced for the production -└── videoref # Video shoots from animators -``` diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index a4c6fd7b..7976914f 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -1,4 +1,4 @@ -# Project Setup +# Project Tools Setup ::: warning Work in Progress 15 Oct. 2023 - The content of this page is currently being edited/updated. -- 2.30.2 From 816ddcadc500d622b6d818e13b3cf5c6f17899e9 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 17:17:01 -0400 Subject: [PATCH 31/59] Docs: Rename User Guides --- docs/.vitepress/config.ts | 4 ++-- docs/user-guide/project_tools/quick_start.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 831acc49..be95efd3 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -139,8 +139,8 @@ export default defineConfig({ collapsed: true, items: [ { text: 'Project Overview', link: '/user-guide/project_tools/project-overview' }, - { text: 'Pipeline Usage', link: '/user-guide/project_tools/quick_start'}, - { text: 'Running Blender', link: '/user-guide/project_tools/running_blender' }, + { text: 'Project Usage', link: '/user-guide/project_tools/quick_start'}, + { text: 'Project Blender', link: '/user-guide/project_tools/running_blender' }, ], }, diff --git a/docs/user-guide/project_tools/quick_start.md b/docs/user-guide/project_tools/quick_start.md index c581feaf..ff632141 100644 --- a/docs/user-guide/project_tools/quick_start.md +++ b/docs/user-guide/project_tools/quick_start.md @@ -1,4 +1,4 @@ -# Pipeline Usage +# Project Usage ::: warning Work in Progress 15 Oct. 2023 - The content of this page is currently being edited/updated. -- 2.30.2 From d053deb157b876754c65426f81d8350f3a340204 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 17:55:37 -0400 Subject: [PATCH 32/59] Docs: Rename User Project Tool Pages --- docs/.vitepress/config.ts | 4 ++-- .../project_tools/{running_blender.md => project-blender.md} | 2 +- .../project_tools/{quick_start.md => project-usage.md} | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename docs/user-guide/project_tools/{running_blender.md => project-blender.md} (97%) rename docs/user-guide/project_tools/{quick_start.md => project-usage.md} (100%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index be95efd3..1c6e09e8 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -139,8 +139,8 @@ export default defineConfig({ collapsed: true, items: [ { text: 'Project Overview', link: '/user-guide/project_tools/project-overview' }, - { text: 'Project Usage', link: '/user-guide/project_tools/quick_start'}, - { text: 'Project Blender', link: '/user-guide/project_tools/running_blender' }, + { text: 'Project Usage', link: '/user-guide/project_tools/project-usage'}, + { text: 'Project Blender', link: '/user-guide/project_tools/project-blender' }, ], }, diff --git a/docs/user-guide/project_tools/running_blender.md b/docs/user-guide/project_tools/project-blender.md similarity index 97% rename from docs/user-guide/project_tools/running_blender.md rename to docs/user-guide/project_tools/project-blender.md index 6e57d32c..81149ad9 100644 --- a/docs/user-guide/project_tools/running_blender.md +++ b/docs/user-guide/project_tools/project-blender.md @@ -1,4 +1,4 @@ -# Running Blender +# Project Blender ## Create Blender Shortcut diff --git a/docs/user-guide/project_tools/quick_start.md b/docs/user-guide/project_tools/project-usage.md similarity index 100% rename from docs/user-guide/project_tools/quick_start.md rename to docs/user-guide/project_tools/project-usage.md -- 2.30.2 From 45781158dbeb4381e54e40bf0bd1babeb88179ae Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 18:19:09 -0400 Subject: [PATCH 33/59] Docs: Add Intro To Project Overview --- docs/user-guide/project_tools/project-overview.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/project_tools/project-overview.md b/docs/user-guide/project_tools/project-overview.md index d99b9f9c..ef168d04 100644 --- a/docs/user-guide/project_tools/project-overview.md +++ b/docs/user-guide/project_tools/project-overview.md @@ -1,12 +1,17 @@ # Project Overview -The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. +## Introduction +"Project Tools" is a collection of scripts included in the [Blender Studio Pipeline](https://projects.blender.org/studio/blender-studio-pipeline) repository, developed to assist you in running and managing one or more projects. These scripts automate and standardize many common operations involved in setting up a production pipeline. + +It all starts with the directory layout, which should be deployed by a Technical Director following the [Project Tools Setup Guide](/td-guide/project-tools-setup.md). This standard directory layout defines where things like .blend files and playblasts are stored. It enables project tools the ability to ensure all users are running the same Blender and have a similar experience with minimal setup required by the individual users. + -Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder. - ## Directory Layout +Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder. + The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project. + * `local` This is where the local copy of Blender and the add-ons will be installed. This directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`. * `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc) * `svn` This the versioned controlled folder where the .blend production files will live. @@ -20,5 +25,3 @@ The project folder contains all data related to a project including .blend files ``` To learn the layout of the above directories, see the [`shared`](/naming-conventions/shared-folder-structure.md) and [`svn`](/naming-conventions/svn-folder-structure.md) directory overviews. - -To learn more about setting up a production pipeline using the project tools see the [Project Tools Setup Guide](/td-guide/project-tools-setup.md) \ No newline at end of file -- 2.30.2 From c9d7acc084238113cbaa2958ca0c8ee8cf32f918 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 18:19:33 -0400 Subject: [PATCH 34/59] Docs: Add Intro to Project Usage --- docs/user-guide/project_tools/project-usage.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/user-guide/project_tools/project-usage.md b/docs/user-guide/project_tools/project-usage.md index ff632141..6dd67b94 100644 --- a/docs/user-guide/project_tools/project-usage.md +++ b/docs/user-guide/project_tools/project-usage.md @@ -1,5 +1,7 @@ # Project Usage +Once your project is set-up there are several things that users can do when using the pipeline, including creating new shots on Kitsu directly from Blender, automatically building shots based on Kitsu data and updating the frame range of existing shots within the project. + ::: warning Work in Progress 15 Oct. 2023 - The content of this page is currently being edited/updated. ::: -- 2.30.2 From a0283616874e834063db5e3e3b79529b72b08c49 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 18:23:11 -0400 Subject: [PATCH 35/59] Docs: Add Intro to Project Blender --- docs/user-guide/project_tools/project-blender.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/project_tools/project-blender.md b/docs/user-guide/project_tools/project-blender.md index 81149ad9..65cb4595 100644 --- a/docs/user-guide/project_tools/project-blender.md +++ b/docs/user-guide/project_tools/project-blender.md @@ -1,5 +1,7 @@ # Project Blender +Project Tools will store a version of Blender within the `shared` directory. This version of Blender is internal to that project. This allows for multiple Blenders to be installed on your system, each with their own preferences tailored specifically to that project. Project Tools also allows you to run a custom build of Blender with the Add-Ons and preferences set for your project. + ## Create Blender Shortcut Once your project has been setup using the "Project Tools" scripts Blender should be available inside your application's native application launcher. The run Blender script will take the correct blender version for your operating system from `{my_project}/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `{my_project}/shared/artifacts/addons` folder. Your Blender preferences are stored on a per project basis in `{directory-path}` @@ -14,7 +16,7 @@ To learn more about running the Blender if you are on a Gentoo system please see ::: #### Launch with Custom Build on Linux -You must run the Create Linux Shortcut step before running a custom build. This will launch blender using your custom binary, but with the Add-On and preferences of your project +You must run the Create Linux Shortcut step before running a custom build. This will launch blender using your custom binary, but with the Add-Ons and preferences of your project. 1. Navigate to your custom Blender binary 2. Right Click the binary -- 2.30.2 From bb67d2a9743192667ce9ebcc28641f1fbd3f0b0b Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 18:24:06 -0400 Subject: [PATCH 36/59] Docs: Clean up Project Tools Setup Intro --- docs/td-guide/project-tools-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 7976914f..668b0685 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -6,7 +6,7 @@ ## Introduction -In this guide, you will learn how to setup and use the Blender Studio Pipeline, the backbone of [Blender Open Movies](https://studio.blender.org/films/). This workflow relies on Blender, some Blender Add-Ons, and additional services like [Kitsu](https://www.cg-wire.com/kitsu) and [Flamenco](https://flamenco.blender.org/). Wether you are an individual with a single computer or a studio with a full network of workstations, this guide offers a straightforward approach to set up and use the pipeline, complete with easy-to-follow examples. +In this guide, you will learn how to setup the Blender Studio Pipeline, the backbone of [Blender Open Movies](https://studio.blender.org/films/). This workflow relies on Blender, some Blender Add-Ons, and additional services like [Kitsu](https://www.cg-wire.com/kitsu) and [Flamenco](https://flamenco.blender.org/). Wether you are an individual with a single computer or a studio with a full network of workstations, this guide offers a straightforward approach to set up the pipeline, complete with easy-to-follow examples. ::: info Python Requirement Running these scripts requires python 3.11+, please ensure python is installed on your system before running blender with the below instructions -- 2.30.2 From c384b454efc5ba4a3d6da8a1932bf59c8a5bab2e Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 18:24:51 -0400 Subject: [PATCH 37/59] Docs: Remove Running Blender from Usage Guide --- docs/user-guide/project_tools/project-usage.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docs/user-guide/project_tools/project-usage.md b/docs/user-guide/project_tools/project-usage.md index 6dd67b94..8feee966 100644 --- a/docs/user-guide/project_tools/project-usage.md +++ b/docs/user-guide/project_tools/project-usage.md @@ -5,20 +5,6 @@ Once your project is set-up there are several things that users can do when usin ::: warning Work in Progress 15 Oct. 2023 - The content of this page is currently being edited/updated. ::: -## Launching Blender -To launch Blender use the following command -```bash -cd {my_project}/{my_project}/svn/tools -./run_blender.py -``` - -If a desktop icon is preferred to launch blender - -```bash -cd {my_project}/{my_project}/svn/tools -./install_desktop_file.sh -``` - ## Sync your Edit with Kitsu Server Most productions begin with a previz or storyboard step, showing the overall direction and plan for the production. By inputting this as video strip(s) into a VSE file we can automatically create the corresponding shots on the Kitsu Server directly from the VSE. -- 2.30.2 From 839dd99ea36019733d45a4b9c49d7791a0aa4399 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 18 Oct 2023 18:31:05 -0400 Subject: [PATCH 38/59] Docs: Update Project Blender Intro --- docs/user-guide/project_tools/project-blender.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/project_tools/project-blender.md b/docs/user-guide/project_tools/project-blender.md index 65cb4595..c6c73489 100644 --- a/docs/user-guide/project_tools/project-blender.md +++ b/docs/user-guide/project_tools/project-blender.md @@ -1,6 +1,6 @@ # Project Blender -Project Tools will store a version of Blender within the `shared` directory. This version of Blender is internal to that project. This allows for multiple Blenders to be installed on your system, each with their own preferences tailored specifically to that project. Project Tools also allows you to run a custom build of Blender with the Add-Ons and preferences set for your project. +Project Tools will store a version of Blender within the `shared` directory. This version of Blender is internal to that project. This allows for multiple Blenders to be installed on your system, each with their own preferences tailored specifically to that project. The main advantage to running/managing Blender using the Project Tools scripts is that it will synchronize the Blender version and Shared Add-Ons across for all users contributing the the project. Project Tools also allows you to run a custom build of Blender with the Add-Ons and preferences set for your project. ## Create Blender Shortcut -- 2.30.2 From 51f0ee6b04fa909deaf846e7e923135e50f7328f Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 13:32:23 -0400 Subject: [PATCH 39/59] Docs: Add New Shared Folder Structure to Naming Conventions --- .../shared-folder-structure.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/naming-conventions/shared-folder-structure.md b/docs/naming-conventions/shared-folder-structure.md index f317a431..1a036d9a 100644 --- a/docs/naming-conventions/shared-folder-structure.md +++ b/docs/naming-conventions/shared-folder-structure.md @@ -4,3 +4,42 @@ October 17th 2023 - The content of this page is currently being edited/updated. ::: + + +```bash +shared +└── editorial + ├── audio # Audio + ├── deliver # Delivery for script + ├── export # Renders coming out of edit + │ ├── _archive + │ │ └── gold-edit-v001_storyboard.mp4 + │ ├── gold-edit-v001_previs.mp4 + └── footage + ├── sequences # Sequence Playblasts / Renders + │ ├── 010_intro + │ │ ├── 010_intro-beats + │ │ │ └── 010_intro-beats-v001.mp4 + │ │ └── 010_intro-storyboards + │ │ └── ... + │ └── 020_water + │ └── ... + ├── shots # Playblasts and Render Previews + │ ├── 010_intro + │ │ └── 010_0010 + │ │ ├── 010_0010-previs + │ │ │ └── 010_0010-previs-v001.mp4 + │ │ │ └── ... + │ │ └── 010_0010-animation + │ │ └── 010_0010-animation-v001.mp4 + │ │ └── ... + │ └── 020_water + │ └── ... + └── frames # Render Review Output + └── 010_intro + └── 010_0010 + + +``` \ No newline at end of file -- 2.30.2 From 0d4df815b6ab397f6f5640c7e3f86d92540cdaff Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 13:32:58 -0400 Subject: [PATCH 40/59] Docs: Add JSON to generate SVN Folder Structure --- .../project-tools/svn_forder_structure.json | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 scripts/project-tools/svn_forder_structure.json diff --git a/scripts/project-tools/svn_forder_structure.json b/scripts/project-tools/svn_forder_structure.json new file mode 100644 index 00000000..e083a075 --- /dev/null +++ b/scripts/project-tools/svn_forder_structure.json @@ -0,0 +1,30 @@ +{ + "": {}, + "dev": { + "concepts": {}, + "tests": {}, + "boards": {} + }, + "pro": { + "shots": {}, + "config": {}, + "assets": { + "chars": {}, + "fx": {}, + "scripts": {}, + "cam": {}, + "props": {}, + "poses": {}, + "maps": {}, + "nodes": {}, + "lgt": {}, + "sets": {}, + "lib": {} + } + }, + "pre": { + "shots": {}, + "assets": {} + }, + "tools": {} +} \ No newline at end of file -- 2.30.2 From 43499998870da3f3db51f32daa93286056191716 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 13:34:50 -0400 Subject: [PATCH 41/59] Docs: Add JSON to generate Shared Folder Structure --- .../project-tools/shared_forder_structure.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 scripts/project-tools/shared_forder_structure.json diff --git a/scripts/project-tools/shared_forder_structure.json b/scripts/project-tools/shared_forder_structure.json new file mode 100644 index 00000000..0721a073 --- /dev/null +++ b/scripts/project-tools/shared_forder_structure.json @@ -0,0 +1,15 @@ +{ + "": {}, + "editorial": { + "export": { + "_archive": {} + }, + "deliver": {}, + "footage": { + "frames": {}, + "shots": {}, + "sequences": {} + }, + "audio": {} + } +} \ No newline at end of file -- 2.30.2 From 1f3c1ea18fdf8341bc1e13febda0b9d5f4ef3686 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 13:37:07 -0400 Subject: [PATCH 42/59] Docs: Update Instructions to Generate Shared Folder Structure --- docs/td-guide/project-tools-setup.md | 30 ++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 668b0685..3f59cb97 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -59,14 +59,32 @@ This directory is used for the temporary storage of render files generated by Fl ### Populating `shared` This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure. -::: warning Work in Progress -15 Oct. 2023 - The following folder trees are out of data, and will soon be updated. -::: +#### Initial Directory Set-Up +1. Create your Shared Folder directly in the target directory or symlink it to`/{my_project}/svn`. +2. Use the following commands to generate the below folder structure. + ```bash + cd /data/blender-studio-pipeline/scripts/project-tools + ./init_folder_structure /data/{my_project}/shared shared_folder_structure.json + ``` + +#### Add Existing Directory to User Workstation +1. Clone your SVN Folder directly into the target directory `/{my_project}/svn`. - +# Shared Folder Structure +```bash +shared +└── editorial + ├── audio # Audio + ├── deliver # Delivery for script + ├── export # Renders coming out of edit + │ ├── _archive + └── footage + ├── sequences # Sequence Playblasts / Renders + ├── shots # Playblasts and Render Previews + └── frames # Render Review Output + +``` ### Populating `SVN` This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. -- 2.30.2 From 1bf46e8924956db8425e871a17b8e5440f72acac Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 13:42:14 -0400 Subject: [PATCH 43/59] Docs: Include Artifacts in Shared Directory --- docs/naming-conventions/shared-folder-structure.md | 1 + docs/td-guide/project-tools-setup.md | 1 + scripts/project-tools/shared_forder_structure.json | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/naming-conventions/shared-folder-structure.md b/docs/naming-conventions/shared-folder-structure.md index 1a036d9a..283c8e6e 100644 --- a/docs/naming-conventions/shared-folder-structure.md +++ b/docs/naming-conventions/shared-folder-structure.md @@ -10,6 +10,7 @@ TODO Add logic & Introduction ```bash shared +├── artifacts # Where Global Blender & Add-Ons are stored └── editorial ├── audio # Audio ├── deliver # Delivery for script diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 3f59cb97..747a10b2 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -74,6 +74,7 @@ This is the folder that should be shared over the network. (By using Syncthing, # Shared Folder Structure ```bash shared +├── artifacts # Where Global Blender & Add-Ons are stored └── editorial ├── audio # Audio ├── deliver # Delivery for script diff --git a/scripts/project-tools/shared_forder_structure.json b/scripts/project-tools/shared_forder_structure.json index 0721a073..46054248 100644 --- a/scripts/project-tools/shared_forder_structure.json +++ b/scripts/project-tools/shared_forder_structure.json @@ -1,5 +1,6 @@ { "": {}, + "artifacts": {}, "editorial": { "export": { "_archive": {} -- 2.30.2 From 98b317be58d0cabe3c2e767fb8f015939fae2e4f Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 13:46:15 -0400 Subject: [PATCH 44/59] Docs: Include Edit in SVN Directory --- docs/naming-conventions/svn-folder-structure.md | 2 ++ docs/td-guide/project-tools-setup.md | 1 + scripts/project-tools/svn_forder_structure.json | 1 + 3 files changed, 4 insertions(+) diff --git a/docs/naming-conventions/svn-folder-structure.md b/docs/naming-conventions/svn-folder-structure.md index d870c7a9..78e311e1 100644 --- a/docs/naming-conventions/svn-folder-structure.md +++ b/docs/naming-conventions/svn-folder-structure.md @@ -61,6 +61,8 @@ dev # Anything related to early development or tests ├── boards ├── tests └── ... +edit # Where the editorial .blend file lives +└── my_project_edit_v001.blend .blender_project promo tools diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 747a10b2..f91a81c2 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -112,6 +112,7 @@ This is the folder that should contain a version controlled file system to be sh ├── pre/ # For pre-production │ ├── assets │ └── shots + ├── edit # Where the editorial .blend file lives ├── pro/ # All files from the production │ ├── assets/ # All assets from the production │ │ ├── cam # Camera rig & setup diff --git a/scripts/project-tools/svn_forder_structure.json b/scripts/project-tools/svn_forder_structure.json index e083a075..b8f5fb0e 100644 --- a/scripts/project-tools/svn_forder_structure.json +++ b/scripts/project-tools/svn_forder_structure.json @@ -5,6 +5,7 @@ "tests": {}, "boards": {} }, + "edit": {}, "pro": { "shots": {}, "config": {}, -- 2.30.2 From c7a6542c0b4137d56a8883dfd8ca49da2997de9d Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Mon, 16 Oct 2023 17:11:43 -0400 Subject: [PATCH 45/59] Blender Kitsu: Fix Bug "3d_start" missing on new shots --- scripts-blender/addons/blender_kitsu/sqe/push.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/scripts-blender/addons/blender_kitsu/sqe/push.py b/scripts-blender/addons/blender_kitsu/sqe/push.py index 254f8641..8ed002ba 100644 --- a/scripts-blender/addons/blender_kitsu/sqe/push.py +++ b/scripts-blender/addons/blender_kitsu/sqe/push.py @@ -37,8 +37,7 @@ def shot_meta(strip: bpy.types.Sequence, shot: Shot) -> None: try: kitsu_3d_start = shot.data["3d_start"] except: - kitsu_3d_start = 101 # TODO REPLACE WITH BAKED GLOBAL VALUE - + kitsu_3d_start = bkglobals.FRAME_START shot.name = strip.kitsu.shot_name shot.description = strip.kitsu.shot_description shot.data["frame_in"] = strip.frame_final_start @@ -70,9 +69,7 @@ def new_shot( nb_frames=strip.frame_final_duration, frame_in=frame_range[0], frame_out=frame_range[1], - data={ - "fps": bkglobals.FPS, - }, + data={"fps": bkglobals.FPS, "3d_start": bkglobals.FRAME_START}, ) if add_tasks: -- 2.30.2 From 683b55a8aee73e36727c64862c9e998cf598068d Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 13:58:31 -0400 Subject: [PATCH 46/59] Docs: Add Editorial Export to Kitsu Setup --- docs/td-guide/project-tools-setup.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index f91a81c2..43e977b2 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -189,6 +189,8 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W - Project Root Directory: `/data/{my_project}/svn` - Animation Tools - Playblast directory: `/data/{my_project}/shared/shot_previews/` + - Editorial Export Directory + - `/data/{my_project}/shared/editorial/export/` ![Blender Kitsu Preferences](/media/pipeline-overview/quick-start/kitsu_pref.png) -- 2.30.2 From 6b7afb8a22b40a32ce4b1cffe63626e0805ca64e Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 14:01:01 -0400 Subject: [PATCH 47/59] Docs: Update Playblast Directory --- docs/td-guide/project-tools-setup.md | 4 ++-- docs/user-guide/project_tools/project-usage.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 43e977b2..bfa64880 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -188,7 +188,7 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W - Select Production: Choose the current Production - Project Root Directory: `/data/{my_project}/svn` - Animation Tools - - Playblast directory: `/data/{my_project}/shared/shot_previews/` + - Playblast directory: `/data/{my_project}/shared/editorial/footage/shots/` - Editorial Export Directory - `/data/{my_project}/shared/editorial/export/` @@ -201,7 +201,7 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W - Ensure `Enable Blender Kitsu` is Enabled - Render Farm: `/data/{my_project}/render/` - Shot Frames: `/data/{my_project}/shared/shot_frames/` - - Shot Previews: `/data/{my_project}/shared/shot_previews/` + - Shot Previews: `/data/{my_project}/shared/editorial/footage/shots/` ![Render Review Preferences](/media/pipeline-overview/quick-start/render_review_pref.png) diff --git a/docs/user-guide/project_tools/project-usage.md b/docs/user-guide/project_tools/project-usage.md index 8feee966..1ff5bb8f 100644 --- a/docs/user-guide/project_tools/project-usage.md +++ b/docs/user-guide/project_tools/project-usage.md @@ -59,7 +59,7 @@ Returning to your edit .blend file, we can now load the playblast from the anima 1. Open your edit .blend file inside the directory `{my_project}/{my_project}/shared/edit` 2. From the Sequencer Header select `Add>Movie` -3. Navigate to the directory of the playblast for your shot's .blend file `{my_project}/{my_project}/shared/shot_previews/{sequence_name}/{shot_name}/{file_name}` and select the `.mp4` file +3. Navigate to the directory of the playblast for your shot's .blend file `{my_project}/shared/footage/shots/{sequence_name}/{shot_name}/{file_name}` and select the `.mp4` file 4. Place the new shot at the same timing as the corresponding metastrip ## Adjusting a Shot's Frame Range -- 2.30.2 From 1a14586968cab69ab6010e10e7dd80b75fdcc2e5 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 14:01:22 -0400 Subject: [PATCH 48/59] Docs: Update edit directory --- docs/user-guide/project_tools/project-usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/project_tools/project-usage.md b/docs/user-guide/project_tools/project-usage.md index 1ff5bb8f..5cd91032 100644 --- a/docs/user-guide/project_tools/project-usage.md +++ b/docs/user-guide/project_tools/project-usage.md @@ -57,7 +57,7 @@ For each new task type, Anim/Layout etc needs to be added manually, then it can Returning to your edit .blend file, we can now load the playblast from the animation file into the edit. -1. Open your edit .blend file inside the directory `{my_project}/{my_project}/shared/edit` +1. Open your edit .blend file inside the directory `/{my_project}/svn/edit` 2. From the Sequencer Header select `Add>Movie` 3. Navigate to the directory of the playblast for your shot's .blend file `{my_project}/shared/footage/shots/{sequence_name}/{shot_name}/{file_name}` and select the `.mp4` file 4. Place the new shot at the same timing as the corresponding metastrip -- 2.30.2 From b0bfb35e423e72693f3394494b5c01dec843621c Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:12:26 -0400 Subject: [PATCH 49/59] Docs: Update Render Frames Directory in Pipeline Setup --- docs/td-guide/project-tools-setup.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index bfa64880..40b43056 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -189,9 +189,12 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W - Project Root Directory: `/data/{my_project}/svn` - Animation Tools - Playblast directory: `/data/{my_project}/shared/editorial/footage/shots/` - - Editorial Export Directory + - Frames Directory `/data/{my_project}/shared/editorial/footage/frames/` + - Editorial Export Directory (Optional) - `/data/{my_project}/shared/editorial/export/` - + ![Blender Kitsu Preferences](/media/pipeline-overview/quick-start/kitsu_pref.png) ## Render Review Add-On Preferences @@ -200,11 +203,13 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W 3. Set the following settings in the add-on preferences - Ensure `Enable Blender Kitsu` is Enabled - Render Farm: `/data/{my_project}/render/` - - Shot Frames: `/data/{my_project}/shared/shot_frames/` + - Shot Frames: `/data/{my_project}/shared/editorial/footage/frames/` - Shot Previews: `/data/{my_project}/shared/editorial/footage/shots/` ![Render Review Preferences](/media/pipeline-overview/quick-start/render_review_pref.png) - + ## Flamenco Setup 1. Create Flamenco shared storage directory -- 2.30.2 From 34769cb49e430e78cbbb040d52cb34cab3e3a2d1 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:12:47 -0400 Subject: [PATCH 50/59] Docs: Add Optional to Render Directory Create in Pipeline Setup --- docs/td-guide/project-tools-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 40b43056..886d0fec 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -48,7 +48,7 @@ This will create the bones of your production's directories. - `svn` This the versioned controlled folder where the `.blend` production files will live. -3. Create render directory +3. Create render directory (Optional) ```bash mkdir /data/{my_project}/render/ ``` -- 2.30.2 From e708f93a40d0e8f8b7cb975cf3e06840a377f44a Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:16:58 -0400 Subject: [PATCH 51/59] Docs: Fix Shared Set-Up Instructions --- docs/td-guide/project-tools-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 886d0fec..68d4e1c1 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -60,7 +60,7 @@ This directory is used for the temporary storage of render files generated by Fl This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure. #### Initial Directory Set-Up -1. Create your Shared Folder directly in the target directory or symlink it to`/{my_project}/svn`. +1. Create your Shared Folder directly in the target directory or symlink it to`/data/{my_project}/shared`. 2. Use the following commands to generate the below folder structure. ```bash cd /data/blender-studio-pipeline/scripts/project-tools @@ -68,7 +68,7 @@ This is the folder that should be shared over the network. (By using Syncthing, ``` #### Add Existing Directory to User Workstation -1. Clone your SVN Folder directly into the target directory `/{my_project}/svn`. +1. Clone your SVN Folder directly into the target directory `/data/{my_project}/shared`. # Shared Folder Structure -- 2.30.2 From 98c2e1d0ff462b056c0ad0cd9428bee4a6ffb3a5 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:17:23 -0400 Subject: [PATCH 52/59] Docs: Fix SVN Set-Up Instructions --- docs/td-guide/project-tools-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 68d4e1c1..3a63782f 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -91,7 +91,7 @@ shared This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. #### Initial Directory Set-Up -1. Create your SVN Folder directly in the target directory `/{my_project}/svn`. +1. Create your SVN Folder directly in the target directory `/data/{my_project}/svn`. 2. Use the following commands to generate the below folder structure. ```bash cd /data/blender-studio-pipeline/scripts/project-tools @@ -99,7 +99,7 @@ This is the folder that should contain a version controlled file system to be sh ``` #### Add Existing Directory to User Workstation -1. Clone your SVN Folder directly into the target directory `/{my_project}/svn`. +1. Clone your SVN Folder directly into the target directory `/data/{my_project}/svn`. ```bash -- 2.30.2 From 1313106deb3f1b23a0b1870293463658615d698f Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:25:02 -0400 Subject: [PATCH 53/59] Docs: Update Paths in Usage Section --- .../user-guide/project_tools/project-usage.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/user-guide/project_tools/project-usage.md b/docs/user-guide/project_tools/project-usage.md index 5cd91032..2d114939 100644 --- a/docs/user-guide/project_tools/project-usage.md +++ b/docs/user-guide/project_tools/project-usage.md @@ -10,7 +10,7 @@ Once your project is set-up there are several things that users can do when usin Most productions begin with a previz or storyboard step, showing the overall direction and plan for the production. By inputting this as video strip(s) into a VSE file we can automatically create the corresponding shots on the Kitsu Server directly from the VSE. 1. If not already ensure your project settings are setup [Blender Kitsu Add-On Preferences](https://studio.blender.org/pipeline/addons/blender_kitsu#how-to-get-started) -2. At the directory `{my_project}/{my_project}/shared/edit` create a new "Video Editing" File. +2. At the directory `{my_project}/svn/edit` create a new "Video Editing" File. 3. Populate your new edit file with your previz video strips 4. With your first strip selected, in the Blender Kitsu side panel of the VSE select "Create Metastrip Active Shot” to create a new metastrip. 5. Next select “Init Active Shot”, and enter the Shot and Sequence names you would like to submit to Kitsu. @@ -26,7 +26,7 @@ The next step is to create an asset and store that information into the Kitsu Se 1. Launch Blender via [Launching Software] Guide 2. Under `Edit>Preferences>Add-Ons` ensure `Asset Pipeline` is enabled 3. Follow the[ asset pipeline guide](https://studio.blender.org/pipeline/addons/asset_pipeline#how-to-get-started) to create a new asset (optional) -4. Save the above asset within the directory `{my_project}/{my_project}/svn/pro/lib/char` +4. Save the above asset within the directory `{my_project}/svn/pro/assets/char` 5. Create a matching entry in Kitsu for the above asset via the [Create Assets guide](https://kitsu.cg-wire.com/first_production/#create-assets) 6. Follow the [casting guide](https://forum.cg-wire.com/t/breakdown-casting-widget-for-kitsu/31) in the breakdown section to assign assets to shots. @@ -35,12 +35,12 @@ The next step is to create an asset and store that information into the Kitsu Se Inside your production’s directory the Shot Builder configuration files need to be created using the [examples](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs/examples) included in the Add-On directory. See the Shot Builder Config [Directory Layout](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs#directory-layout) for details. The only configuration file that requires production specific edits is `assets.py`. This configuration file links the Kitsu Asset entries to their corresponding files in the production directory. -1. Copy Configuration Files from [examples](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs/examples) to `{my_project}/{my_project}/svn/pro/shot-builder/` -2. Update `assets.py` file with each asset you have in your `lib` folder see the [Shot Builder API](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs#api) -3. Ensure your camera rig is present at the path `{my_project}/{my_project}/svn/pro/lib/cam/camera_rig.blend` +1. Copy Configuration Files from [examples](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs/examples) to `{my_project}/svn/pro/shot-builder/` +2. Update `assets.py` file with each asset you have in your `assets` folder see the [Shot Builder API](https://projects.blender.org/studio/blender-studio-pipeline/src/branch/main/scripts-blender/addons/blender_kitsu/shot_builder/docs#api) +3. Ensure your camera rig is present at the path `{my_project}/svn/pro/assets/cam/camera_rig.blend` 4. Open a new Blender File, select `File>New>Shot File` 5. Select the desired Sequence/Shot from Kitsu and select OK to start Building -6. New file will be saved to `{my_project}/{my_project}/svn/pro/shots/{sequence}/{shot}/{shot}.blend +6. New file will be saved to `{my_project}/svn/pro/shots/{sequence}/{shot}/{shot}.blend ## Playblast your First Shot Once your first shot is animated you are ready to render a playblast of this shot, which will be later imported into your edit .blend file. @@ -65,11 +65,11 @@ Returning to your edit .blend file, we can now load the playblast from the anima ## Adjusting a Shot's Frame Range During production in some cases the frame range of a shot will change, either adjusting a shot's length or adjusting it's position in the edit. Once adjusted, we can update the shot .blend file's frame range so new playblasts will match this updated frame range. Once a new playblast is available the shot can automatically be updated in the VSE via the Blender Kitsu Add-On -1. Open your edit .blend file inside the directory `{my_project}/{my_project}/shared/edit +1. Open your edit .blend file inside the directory `{my_project}/svn/edit` 2. Select a shot and it's metastrip, adjust the timing of both strips so they remain in sync. 3. Select your metastrip, in the Kitsu Sidebar of the VSE Under Push select `Metadata 1 Shot` to push your shot's new frame range to the Kitsu Server 4. Open your shot .blend file inside the directory - `{my_project}/{my_project}/svn/pro/shots/{sequence_name}/{shot_name}/ + `{my_project}/svn/pro/shots/{sequence_name}/{shot_name}/ 5. Inside the Kitsu Sidebar, under Playblast tools, if your frame range on Kitsu has changed you will see a red `Pull Frame Range` button. Select it to update the file's Frame Range 6. Adjust the shot's animation to accommodate the new frame range, then under Playblast use the `+` button to create a new version, then select `Create Playblast` to render a new playblast 7. Open your edit .blend file, and select the movie strip for the shot you would like to update. @@ -84,7 +84,7 @@ Once your shots are all ready to go, you can now render a final EXR from each of 3. In the properties panel navigate under Flamenco 1. Select `Fetch Job Types` 2. From the Dropdown select `Simple Blender Render` - 3. Set Render Output Directory to `{my_project}/{my_project}/render/` + 3. Set Render Output Directory to `{my_project}/render/` 4. Set Add Path Components to `3` 5. Finally Select `Submit to Flamenco` @@ -96,8 +96,8 @@ Once your shot(s) have been rendered by Flamenco, you are ready to review your r 3. From the dialogue box select a Sequence Name you would like to Review 4. Select the video strip for the render you are reviewing 5. Select `Push to Edit & Approve Render` - - Push to Edit will take the mp4 of your flamenco render and add it to the `shot_previews` directory - - Approve Render will copy the Image Sequence of your flamenco render to the `shot_frames` directory + - Push to Edit will take the mp4 of your flamenco render and add it to the `shots` directory + - Approve Render will copy the Image Sequence of your flamenco render to the `frames` directory ## Import Approved Renders into VSE Renders approved by the render review Add-On can be automatically imported into your edit using the same function used to update the playblast of shots in the edit. @@ -111,16 +111,16 @@ Once the approved image sequences have been loaded into the main edit you are re 1. Open your Edit .blend file 2. Render Video as PNG Sequence - 1. Under `Properties>Output` Set the output directory to `{my_project}/{my_project}/shared/edit/delivery/frames/` + 1. Under `Properties>Output` Set the output directory to `{my_project}/shared/editorial/delivery/frames/` 2. Set the File Format to `PNG` 3. Select `Render>Render Animation` 3. Render Audio 1. Select `Render>Render Audio` 2. In the Side Panel select Container `.wav` - 3. Set the output directory to `{my_project}/{my_project}/shared/edit/delivery/audio/` + 3. Set the output directory to `{my_project}/shared/editorial/delivery/audio/` 4. Run Deliver script - 1. Copy the `delivery.py` from `{my_project}/blender-studio-pipeline/film-delivery/` to the directory `/{my_project}/shared/edit/delivery/` - 2. Enter delivery directory `cd /{my_project}/shared/edit/delivery/ + 1. Copy the `delivery.py` from `{my_project}/blender-studio-pipeline/film-delivery/` to the directory `/{my_project}/shared/editorial/delivery/` + 2. Enter delivery directory `cd /{my_project}/shared/editorial/delivery/ 3. Encode audio with `./deliver.py --encode_audio audio/{name_of_audio}.wav` 4. Encode video with `.deliver.py --encode_video frames/` 5. Finally `.delivery.py --mux` -- 2.30.2 From 88d1b70568e64fb695a89af1675c9ad59ecdf5d9 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:26:27 -0400 Subject: [PATCH 54/59] Docs: Remove Typo --- docs/td-guide/project-tools-setup.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 3a63782f..d9695282 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -70,8 +70,6 @@ This is the folder that should be shared over the network. (By using Syncthing, #### Add Existing Directory to User Workstation 1. Clone your SVN Folder directly into the target directory `/data/{my_project}/shared`. - -# Shared Folder Structure ```bash shared ├── artifacts # Where Global Blender & Add-Ons are stored -- 2.30.2 From 66ceb1393ceb98e9997b1374dd30e514766c5efc Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:33:07 -0400 Subject: [PATCH 55/59] Fix Typo in deliver folder name --- docs/user-guide/project_tools/project-usage.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/project_tools/project-usage.md b/docs/user-guide/project_tools/project-usage.md index 2d114939..8be97807 100644 --- a/docs/user-guide/project_tools/project-usage.md +++ b/docs/user-guide/project_tools/project-usage.md @@ -111,16 +111,16 @@ Once the approved image sequences have been loaded into the main edit you are re 1. Open your Edit .blend file 2. Render Video as PNG Sequence - 1. Under `Properties>Output` Set the output directory to `{my_project}/shared/editorial/delivery/frames/` + 1. Under `Properties>Output` Set the output directory to `{my_project}/shared/editorial/deliver/frames/` 2. Set the File Format to `PNG` 3. Select `Render>Render Animation` 3. Render Audio 1. Select `Render>Render Audio` 2. In the Side Panel select Container `.wav` - 3. Set the output directory to `{my_project}/shared/editorial/delivery/audio/` + 3. Set the output directory to `{my_project}/shared/editorial/deliver/audio/` 4. Run Deliver script - 1. Copy the `delivery.py` from `{my_project}/blender-studio-pipeline/film-delivery/` to the directory `/{my_project}/shared/editorial/delivery/` - 2. Enter delivery directory `cd /{my_project}/shared/editorial/delivery/ + 1. Copy the `delivery.py` from `{my_project}/blender-studio-pipeline/film-delivery/` to the directory `/{my_project}/shared/editorial/deliver/` + 2. Enter delivery directory `cd /{my_project}/shared/editorial/deliver/ 3. Encode audio with `./deliver.py --encode_audio audio/{name_of_audio}.wav` 4. Encode video with `.deliver.py --encode_video frames/` 5. Finally `.delivery.py --mux` -- 2.30.2 From dc3748fc570198a0415bba1943ce7f3d63849958 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 15:48:35 -0400 Subject: [PATCH 56/59] Docs: Update Project Setup Images --- docs/media/pipeline-overview/quick-start/kitsu_pref.png | 3 --- .../pipeline-overview/quick-start/render_review_pref.png | 3 --- docs/media/td-guide/kitsu_pref.png | 3 +++ docs/media/td-guide/render_review_pref.png | 3 +++ docs/td-guide/project-tools-setup.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) delete mode 100644 docs/media/pipeline-overview/quick-start/kitsu_pref.png delete mode 100644 docs/media/pipeline-overview/quick-start/render_review_pref.png create mode 100644 docs/media/td-guide/kitsu_pref.png create mode 100644 docs/media/td-guide/render_review_pref.png diff --git a/docs/media/pipeline-overview/quick-start/kitsu_pref.png b/docs/media/pipeline-overview/quick-start/kitsu_pref.png deleted file mode 100644 index 02fca970..00000000 --- a/docs/media/pipeline-overview/quick-start/kitsu_pref.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2ba94582363efe21a00fcf908ddec4f4c223bdcc1f7739c1f3270ef1aaf31d57 -size 77624 diff --git a/docs/media/pipeline-overview/quick-start/render_review_pref.png b/docs/media/pipeline-overview/quick-start/render_review_pref.png deleted file mode 100644 index 812893e9..00000000 --- a/docs/media/pipeline-overview/quick-start/render_review_pref.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:001371987e59d7c28de27ee2b85e4f46051e9876f408a560cd944ebe872e5238 -size 57835 diff --git a/docs/media/td-guide/kitsu_pref.png b/docs/media/td-guide/kitsu_pref.png new file mode 100644 index 00000000..c6216313 --- /dev/null +++ b/docs/media/td-guide/kitsu_pref.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e07ba2456747a6eb4a705146f4666f60d294f8d978a3dad3649d746050e63786 +size 52671 diff --git a/docs/media/td-guide/render_review_pref.png b/docs/media/td-guide/render_review_pref.png new file mode 100644 index 00000000..aee35512 --- /dev/null +++ b/docs/media/td-guide/render_review_pref.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d1e01d723276c6b4f3d06694bf87fcb0d74119b80e984ffb7b82e09b07222b3a +size 34790 diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index d9695282..81c029ea 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -193,7 +193,7 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W -![Blender Kitsu Preferences](/media/pipeline-overview/quick-start/kitsu_pref.png) +![Blender Kitsu Preferences](/media/td-guide/kitsu_pref.png) ## Render Review Add-On Preferences 1. Open Blender and Select `Edit>Preferences>Add-Ons` @@ -204,7 +204,7 @@ TODO Replace Image - Shot Frames: `/data/{my_project}/shared/editorial/footage/frames/` - Shot Previews: `/data/{my_project}/shared/editorial/footage/shots/` -![Render Review Preferences](/media/pipeline-overview/quick-start/render_review_pref.png) +![Render Review Preferences](/media/td-guide/render_review_pref.png) -- 2.30.2 From feed7805de51f3be4caefdd3f7a32a7ca1ce9c9f Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Thu, 19 Oct 2023 16:02:24 -0400 Subject: [PATCH 57/59] Docs: Clean Up Typos --- docs/td-guide/project-tools-setup.md | 4 ++-- docs/user-guide/project_tools/project-usage.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/td-guide/project-tools-setup.md b/docs/td-guide/project-tools-setup.md index 81c029ea..7933ff68 100644 --- a/docs/td-guide/project-tools-setup.md +++ b/docs/td-guide/project-tools-setup.md @@ -86,7 +86,7 @@ shared ``` ### Populating `SVN` -This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure. +This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc). Connect this folder to your version control software of choice and create the following folder structure. #### Initial Directory Set-Up 1. Create your SVN Folder directly in the target directory `/data/{my_project}/svn`. @@ -187,7 +187,7 @@ October 19th 2023 -This feature is only available on linux at this time. Mac & W - Project Root Directory: `/data/{my_project}/svn` - Animation Tools - Playblast directory: `/data/{my_project}/shared/editorial/footage/shots/` - - Frames Directory `/data/{my_project}/shared/editorial/footage/frames/` + - Frames Directory: `/data/{my_project}/shared/editorial/footage/frames/` - Editorial Export Directory (Optional) - `/data/{my_project}/shared/editorial/export/`