studio/blender-studio-tools
13
32
Fork 19
Code Issues 21 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 +15 -15
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 1313106deb - Show all commits

30
docs/user-guide/project_tools/project-usage.md
View File

@ -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. 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 `{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 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.
@ -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 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 `{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) 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.
@ -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. 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/` 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 `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 `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}/{my_project}/svn/pro/lib/cam/camera_rig.blend` 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` 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 `{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 ## 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.
@ -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 ## 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 `{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. 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
`{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 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.
@ -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 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 `{my_project}/{my_project}/render/` 3. Set Render Output Directory to `{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`
@ -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 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 4. Select the video strip for the render you are reviewing
5. Select `Push to Edit & Approve Render` 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 - 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 `shot_frames` directory - Approve Render will copy the Image Sequence of your flamenco render to the `frames` directory
## Import Approved Renders into VSE ## 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. 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 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 `{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` 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 `{my_project}/{my_project}/shared/edit/delivery/audio/` 3. Set the output directory to `{my_project}/shared/editorial/delivery/audio/`
4. Run Deliver script 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/` 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/edit/delivery/ 2. Enter delivery directory `cd /{my_project}/shared/editorial/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`