studio/blender-studio-tools
13
32
Fork 19
Code Issues 20 Pull Requests 4 Projects Releases 1 Activity

Docs: Project Tools Update #156

Merged
Nick Alberelli merged 59 commits from :docs/project-tools-update into main 2023-10-19 22:21:50 +02:00
Conversation 0 Commits 59 Files Changed 27 +35 -35
3 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 4d32755283 - Show all commits

30
docs/td-guide/project-tools-setup.md
View File

@ -27,7 +27,7 @@ The first step in deploying the Blender Studio Pipeline is to create the correct
1. Create project root directory 1. Create project root directory
```bash ```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 3. Create base folder structure using
```bash ```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 3. Create render directory
```bash ```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. 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. 2. Use the following commands to generate the below folder structure.
```bash ```bash
cd /data/blender-studio-pipeline/scripts/project-tools 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 #### 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 1. Download the latest Blender
```bash ```bash
cd /data/my_project/svn/tools cd /data/{my_project}/svn/tools
./update_blender.py ./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 ::: 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. 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 ### Install Blender Add-Ons
2. Download required Add-Ons 2. Download required Add-Ons
```bash ```bash
mkdir /data/my_project/shared/artifacts/addons mkdir /data/{my_project}/shared/artifacts/addons
cd /data/blender-studio-pipeline/scripts/pipeline-release 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 ### Install Blender Icon
If a desktop icon is preferred to launch blender If a desktop icon is preferred to launch blender
```bash ```bash
cd /data/my_project/svn/tools cd /data/{my_project}/svn/tools
./install_desktop_file.sh ./install_desktop_file.sh
``` ```
::: warning Linux only feature ::: 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}` - Password: `{user_password}`
- Project Settings - Project Settings
- Select Production: Choose the current Production - Select Production: Choose the current Production
- Project Root Directory: `/data/my_project/svn` - Project Root Directory: `/data/{my_project}/svn`
- Animation Tools - 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) ![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 2. Search the 'Render Review' and use the checkbox to Enable the Add-On
3. Set the following settings in the add-on preferences 3. Set the following settings in the add-on preferences
- Ensure `Enable Blender Kitsu` is Enabled - Ensure `Enable Blender Kitsu` is Enabled
- Render Farm: `/data/my_project/render/` - Render Farm: `/data/{my_project}/render/`
- Shot Frames: `/data/my_project/shared/shot_frames/` - Shot Frames: `/data/{my_project}/shared/shot_frames/`
- Shot Previews: `/data/my_project/shared/shot_previews/` - Shot Previews: `/data/{my_project}/shared/shot_previews/`
![Render Review Preferences](/media/pipeline-overview/quick-start/render_review_pref.png) ![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 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 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

32
docs/user-guide/project_tools/quick_start.md
View File

@ -6,14 +6,14 @@
## Launching Blender ## Launching Blender
To launch Blender use the following command To launch Blender use the following command
```bash ```bash
cd /data/my_project/svn/tools cd {my_project}/{my_project}/svn/tools
./run_blender.py ./run_blender.py
``` ```
If a desktop icon is preferred to launch blender If a desktop icon is preferred to launch blender
```bash ```bash
cd /data/my_project/svn/tools cd {my_project}/{my_project}/svn/tools
./install_desktop_file.sh ./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. 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) 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 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. 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. 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 1. Launch Blender via [Launching Software] Guide
2. Under `Edit>Preferences>Add-Ons` ensure `Asset Pipeline` is enabled 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) 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) 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. 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. 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) 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` 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 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 ## 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. 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. 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` 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 4. Place the new shot at the same timing as the corresponding metastrip
## Adjusting a Shot's Frame Range ## 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 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. 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 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 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 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 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. 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 3. In the properties panel navigate under Flamenco
1. Select `Fetch Job Types` 1. Select `Fetch Job Types`
2. From the Dropdown select `Simple Blender Render` 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` 4. Set Add Path Components to `3`
5. Finally Select `Submit to Flamenco` 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 1. Open your Edit .blend file
2. Render Video as PNG Sequence 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` 2. Set the File Format to `PNG`
3. Select `Render>Render Animation` 3. Select `Render>Render Animation`
3. Render Audio 3. Render Audio
1. Select `Render>Render Audio` 1. Select `Render>Render Audio`
2. In the Side Panel select Container `.wav` 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 4. Run Deliver script
1. Copy the `delivery.py` from `/data/blender-studio-pipeline/film-delivery/` to the directory `/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_production/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` 3. Encode audio with `./deliver.py --encode_audio audio/{name_of_audio}.wav`
4. Encode video with `.deliver.py --encode_video frames/` 4. Encode video with `.deliver.py --encode_video frames/`
5. Finally `.delivery.py --mux` 5. Finally `.delivery.py --mux`

8
docs/user-guide/project_tools/running_blender.md
View File

@ -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. To launch Blender from the terminal, open the tools directory within your project folder, and from the terminal use the run Blender script.
```bash ```bash
cd /data/my_project/svn/tools cd /{my_project}/svn/tools
./run_blender.py ./run_blender.py
``` ```
@ -61,7 +61,7 @@ Internally to the Blender Studio only, the blender inside your project is automa
::: :::
```bash ```bash
cd /data/my_project/svn/tools cd /{my_project}/svn/tools
./update_blender.py ./update_blender.py
``` ```
## Rollback Blender ## 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. 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 ```bash
cd /data/my_project/svn/tools cd /{my_project}/svn/tools
./rollback_blender.py ./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. In some cases user may want to roll their machine's local blender to a previous version without affecting other users.
```bash ```bash
cd /data/my_project/svn/tools cd /{my_project}/svn/tools
./rollback_blender_local.py ./rollback_blender_local.py
``` ```