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

Add Windows Commands to TD Guide #189

Merged
Nick Alberelli merged 10 commits from TinyNick/blender-studio-pipeline:feature/add-windows-td-guide into main 2024-01-17 15:44:06 +01:00
Conversation 1 Commits 10 Files Changed 21 +82 -32
1 changed files with 82 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 62e1ef2710 - Show all commits

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

@ -12,33 +12,53 @@ In this guide, you will learn how to setup the Blender Studio Pipeline, the back
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.
## Creating Root Folder
To make this guide simple, we will assume we are working within the system's **homefolder**. To create a new directory in your homefolder please follow the below steps.
```bash
cd /data # This directory is the root storage that will contain all projects
mkdir ~/data # Linux/Mac
```
```bash
mkdir %HOMEPATH%\data # Windows
```
## 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. To begin open a terminal/command prompt in your homefolder.
```bash
# Windows & Linux/Mac
cd data # This directory is the root storage that will contain all projects
git lfs install # Ensure git-lfs is installed
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.
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. The following commands should be executed from the `data` folder
1. Create project root directory
```bash
mkdir /data/your_project_name
mkdir ~/data/your_project_name # Linux/Mac
```
```bash
mkdir %HOMEPATH%\data\your_project_name # Windows
```
2. Navigate to the project-tools folder
```bash
cd /data/blender-studio-pipeline/scripts/project-tools
cd ~/data/blender-studio-pipeline/scripts/project-tools # Linux/Mac
```
```bash
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\project-tools # Windows
```
3. Create base folder structure using
3. Create base folder structure using the `init_project_folder_structure` tool, followed by the path to your new project.
```bash
./init_project_folder_structure.py /data/your_project_name
./init_project_folder_structure.py ~/data/your_project_name # Linux/Mac
```
```bash
python init_project_folder_structure.py %HOMEPATH%\data/your_project_name # Windows
```
@ -50,7 +70,10 @@ This will create the bones of your production's directories.
3. Create render directory (Optional)
```bash
mkdir /data/your_project_name/render/
mkdir ~/data/your_project_name/render # Linux/Mac
```
```bash
mkdir %HOMEPATH%\data\your_project_name\render # Windows
```
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.
@ -60,15 +83,21 @@ 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. More details about shared folder structure can be found [here](/naming-conventions/shared-folder-structure.md)
#### Initial Directory Set-Up
1. Create your Shared Folder directly in the target directory or symlink it to`/data/your_project_name/shared`.
1. Create your Shared Folder directly in the target directory or symlink it to`data/your_project_name/shared`.
2. Use the following commands to generate the below folder structure.
```bash
cd /data/blender-studio-pipeline/scripts/project-tools
init_project_folder_structure.py /data/your_project_name/shared --json_file folder_structure_shared.json
# Linux/Mac
cd ~/data/blender-studio-pipeline/scripts/project-tools
init_project_folder_structure.py ~/data/your_project_name/shared --json_file folder_structure_shared.json
```
```bash
# Windows
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\project-tools
python init_project_folder_structure.py %HOMEPATH%\data\your_project_name\shared --json_file folder_structure_shared.json
```
#### Add Existing Directory to User Workstation
1. Clone your SVN Folder directly into the target directory `/data/your_project_name/shared`.
1. Clone your SVN Folder directly into the target directory `data/your_project_name/shared`.
```bash
shared
@ -89,15 +118,21 @@ 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. More details about shared folder structure can be found [here](/naming-conventions/svn-folder-structure.md)
#### Initial Directory Set-Up
1. Create your SVN Folder directly in the target directory `/data/your_project_name/svn`.
1. Create your SVN Folder directly in the target directory `data/your_project_name/svn`.
2. Use the following commands to generate the below folder structure.
```bash
cd /data/blender-studio-pipeline/scripts/project-tools
init_project_folder_structure.py /data/your_project_name/svn --json_file folder_structure_svn.json
# Linux/Mac
cd ~/data/blender-studio-pipeline/scripts/project-tools
init_project_folder_structure.py ~/data/your_project_name/svn --json_file folder_structure_svn.json
```
```bash
# Windows
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\project-tools
python init_project_folder_structure.py %HOMEPATH%\data\your_project_name\svn --json_file folder_structure_svn.json
```
#### Add Existing Directory to User Workstation
1. Clone your SVN Folder directly into the target directory `/data/your_project_name/svn`.
1. Clone your SVN Folder directly into the target directory `data/your_project_name/svn`.
```bash
@ -139,11 +174,17 @@ The next step is to deploy the required software onto each of the studio's works
1. Download the latest Blender
```bash
cd /data/your_project_name/svn/tools
# Linux/Mac
cd ~/data/your_project_name/svn/tools
./update_blender.py
```
```bash
# Windows
cd %HOMEPATH%\data\your_project_name\svn\tools
python update_blender.py
```
This will download the latest blender to `/data/your_project_name/local/blender`
This will download the latest blender to `data/your_project_name/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.
@ -152,16 +193,22 @@ 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/your_project_name/shared/artifacts/addons
cd /data/blender-studio-pipeline/scripts/pipeline-release
./package_local.py /data/your_project_name/shared/artifacts/addons
# Linux/Mac
cd ~/data/blender-studio-pipeline/scripts/pipeline-release
./package_local.py ~/data/your_project_name/shared/artifacts/addons
```
```bash
# Windows
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\pipeline-release
python package_local.py %HOMEPATH%\data\your_project_name\shared\artifacts\addons
```
### Install Blender Icon
If a desktop icon is preferred to launch blender
```bash
cd /data/your_project_name/svn/tools
# Linux Only
cd ~/data/your_project_name/svn/tools
./install_desktop_file.sh
```
::: warning Linux only feature
@ -184,12 +231,12 @@ 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/your_project_name/svn`
- Project Root Directory: `data/your_project_name/svn`
- Animation Tools
- Playblast directory: `/data/your_project_name/shared/editorial/footage/pro/`
- Frames Directory: `/data/your_project_name/shared/editorial/footage/post/`
- Playblast directory: `data/your_project_name/shared/editorial/footage/pro/`
- Frames Directory: `data/your_project_name/shared/editorial/footage/post/`
- Editorial Export Directory (Optional)
- `/data/your_project_name/shared/editorial/export/`
- `data/your_project_name/shared/editorial/export/`
<!--
TODO Replace Image
-->
@ -200,9 +247,9 @@ TODO Replace Image
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/your_project_name/render/`
- Shot Frames: `/data/your_project_name/shared/editorial/footage/post/`
- Shot Previews: `/data/your_project_name/shared/editorial/footage/pro/`
- Render Farm: `data/your_project_name/render/`
- Shot Frames: `data/your_project_name/shared/editorial/footage/post/`
- Shot Previews: `data/your_project_name/shared/editorial/footage/pro/`
![Render Review Preferences](/media/td-guide/render_review_pref.jpg)
<!--
@ -212,8 +259,11 @@ TODO Replace Image
## Flamenco Setup
1. Create Flamenco shared storage directory
```bash
mkdir /data/flamenco_storage
mkdir ~/data/flamenco_storage # Linux/Mac
```
```bash
mkdir %HOMEPATH%\data\flamenco_storage # Windows
```
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/your_project_name/local/blender/{os}/blender` as the Blender Executable Path
2. During Flamenco Manager Setup use `data/flamenco_storage` as the shared storage directory
3. During Flamenco Manager Setup use `data/your_project_name/local/blender/{os}/blender` as the Blender Executable Path