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 +278 -278
12 changed files with 278 additions and 278 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit d906489a43 - Show all commits

39
docs/.vitepress/config.ts
View File

@ -171,10 +171,41 @@ export default defineConfig({
text: 'TD Guide', text: 'TD Guide',
collapsed: true, collapsed: true,
items: [ items: [
{text: 'Project Tools Setup', link: '/td-guide/project-tools-setup'}, {text: 'Introduction', link: '/td-guide/project-tools-setup'},
{text: 'SVN Setup', link: '/td-guide/svn-setup'}, {text: 'Repository', link: '/td-guide/repository'},
{text: 'Syncthing Setup', link: '/td-guide/syncthing-setup'}, {text: 'Python', link: '/td-guide/python'},
{text: 'Python Setup', link: '/td-guide/python'}
{text: 'Folder Structure', link: '/td-guide/project_folder_structure'},
{
text: 'Shared',
collapsed: true,
items: [
{text: 'Syncthing Setup', link: '/td-guide/syncthing-setup'},
{text: 'Populating Shared', link: '/td-guide/populating_shared'},
],
},
{
text: 'SVN',
collapsed: true,
items: [
{text: 'SVN Setup', link: '/td-guide/svn-setup'},
{text: 'Populating SVN', link: '/td-guide/populating_svn'},
],
},
{text: 'Kitsu', link: '/td-guide/kitsu_server'},
{
text: 'Blender',
collapsed: true,
items: [
{text: 'Blender Setup', link: '/td-guide/blender_setup'},
{text: 'Add-Ons Setup', link: '/td-guide/addon_setup'},
],
},
] ]
}, },
{ {

BIN
docs/media/td-guide/share_folder_server.jpg (Stored with Git LFS) Normal file
View File

Binary file not shown.

50
docs/td-guide/addon_setup.md Normal file
View File

@ -0,0 +1,50 @@
# Setup Blender Add-Ons
## Blender Kitsu Add-On Preferences
1. Open Blender and Select `Edit>Preferences>Add-Ons`
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/kitsu_server)*
- Username: `{username@studio.org}`
- Password: `{user_password}`
- Project Settings
- Select Production: Choose the current Production
- 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/`
- Editorial Export Directory (Optional)
- `data/your_project_name/shared/editorial/export/`
<!--
TODO Replace Image
-->
![Blender Kitsu Preferences](/media/td-guide/kitsu_pref.jpg)
## Render Review Add-On Preferences
1. Open Blender and Select `Edit>Preferences>Add-Ons`
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 Review Preferences](/media/td-guide/render_review_pref.jpg)
<!--
TODO Replace Image
-->
## Flamenco Setup
1. Create Flamenco shared storage directory
```bash
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

1
docs/td-guide/blender_setup.md Normal file
View File

@ -0,0 +1 @@
<!--@include: ../user-guide/project_tools/project-blender.md-->

5
docs/td-guide/kitsu_server.md Normal file
View File

@ -0,0 +1,5 @@
# 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.
1. Follow the Official [setup instructions](https://kitsu.cg-wire.com/installation/) for Kitsu Server
2. Upon entering the Kitsu web interface follow the [first production](https://kitsu.cg-wire.com/first_production/) guide

34
docs/td-guide/populating_shared.md Normal file
View File

@ -0,0 +1,34 @@
# 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. 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`.
2. Use the following commands to generate the below folder structure.
```bash
# 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`.
```bash
shared
├── artifacts # Where Global Blender & Add-Ons are stored
└── editorial
├── audio # Audio
├── deliver # Delivery for script
├── export # Renders coming out of edit
│ ├── _archive
└── footage
├── dev # Early Development
├── pre # Pre-Production steps like previs
├── pro # Playblast from Production
└── post # Image Sequences/Final Renders
```

49
docs/td-guide/populating_svn.md Normal file
View File

@ -0,0 +1,49 @@
# 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. More details about shared folder structure can be found [here](/naming-conventions/svn-folder-structure.md)
## Initial Directory Set-Up
1. Follow the [SVN-Setup guide](/td-guide/svn-setup.md) to create your SVN repository **before** populating the directory with folders. *(optional)*
2. Use the following commands to generate the below folder structure.
```bash
# 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`.
```bash
.
└── svn /
├── dev / # Anything related to early development or tests
│ ├── boards
│ ├── concepts
│ └── tests
├── 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
│ │ ├── 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
```

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

@ -1,9 +1,5 @@
# Project Tools Setup # Project Tools Setup
::: warning Linux & Mac Only
The terminal commands on this page are designed to be run on a linux/mac systems. Commands require modifications to file paths to run on Windows.
:::
## Introduction ## Introduction
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. 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.
@ -21,249 +17,3 @@ mkdir ~/data # Linux/Mac
```bash ```bash
mkdir %HOMEPATH%\data # Windows 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 following commands should be executed from the `data` folder
1. Create project root directory
```bash
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 # Linux/Mac
```
```bash
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\project-tools # Windows
```
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 # Linux/Mac
```
```bash
python init_project_folder_structure.py %HOMEPATH%\data/your_project_name # Windows
```
This will create the bones of your production's directories.
- `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.
- `svn` This the versioned controlled folder where the `.blend` production files will live.
3. Create render directory (Optional)
```bash
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.
### 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. 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`.
2. Use the following commands to generate the below folder structure.
```bash
# 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`.
```bash
shared
├── artifacts # Where Global Blender & Add-Ons are stored
└── editorial
├── audio # Audio
├── deliver # Delivery for script
├── export # Renders coming out of edit
│ ├── _archive
└── footage
├── dev # Early Development
├── pre # Pre-Production steps like previs
├── pro # Playblast from Production
└── post # Image Sequences/Final Renders
```
### 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. More details about shared folder structure can be found [here](/naming-conventions/svn-folder-structure.md)
#### Initial Directory Set-Up
1. Follow the [SVN-Setup guide](/td-guide/svn-setup.md) to create your SVN repository **before** populating the directory with folders. *(optional)*
2. Use the following commands to generate the below folder structure.
```bash
# 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`.
```bash
.
└── svn /
├── dev / # Anything related to early development or tests
│ ├── boards
│ ├── concepts
│ └── tests
├── 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
│ │ ├── 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.
1. Follow the Official [setup instructions](https://kitsu.cg-wire.com/installation/) for Kitsu Server
2. Upon entering the Kitsu web interface follow the [first production](https://kitsu.cg-wire.com/first_production/) guide
## Blender Setup
The next step is to deploy the required software onto each of the studio's workstations.
1. Download the latest Blender
```bash
# 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`
::: 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
# 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
# Linux Only
cd ~/data/your_project_name/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
3. Follow the below instructions to correctly set the preferences of each Add-On
## Blender Kitsu Add-On Preferences
1. Open Blender and Select `Edit>Preferences>Add-Ons`
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/project-tools-setup.md#kitsu-server-setup)*
- Username: `{username@studio.org}`
- Password: `{user_password}`
- Project Settings
- Select Production: Choose the current Production
- 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/`
- Editorial Export Directory (Optional)
- `data/your_project_name/shared/editorial/export/`
<!--
TODO Replace Image
-->
![Blender Kitsu Preferences](/media/td-guide/kitsu_pref.jpg)
## Render Review Add-On Preferences
1. Open Blender and Select `Edit>Preferences>Add-Ons`
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 Review Preferences](/media/td-guide/render_review_pref.jpg)
<!--
TODO Replace Image
-->
## Flamenco Setup
1. Create Flamenco shared storage directory
```bash
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

46
docs/td-guide/project_folder_structure.md Normal file
View File

@ -0,0 +1,46 @@
# Project Folder Setup
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 # 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 # Linux/Mac
```
```bash
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\project-tools # Windows
```
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 # Linux/Mac
```
```bash
python init_project_folder_structure.py %HOMEPATH%\data/your_project_name # Windows
```
This will create the bones of your production's directories.
- `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.
- `svn` This the versioned controlled folder where the `.blend` production files will live.
3. Create render directory (Optional)
```bash
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.

9
docs/td-guide/repository.md Normal file
View File

@ -0,0 +1,9 @@
# 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
```

12
docs/td-guide/syncthing-setup.md
View File

@ -11,7 +11,7 @@ Install the latest Syncthing Packages via the official [Syncthing Repository](ht
Get the [latest release](https://github.com/syncthing/syncthing/releases/tag/v1.27.2) for your distribution. Get the [latest release](https://github.com/syncthing/syncthing/releases/tag/v1.27.2) for your distribution.
### Windows ### Windows
Syncthing can be installed on windows with the official [Syncthing Installer](127.0.0.1:8384) by following [this video](https://www.youtube.com/watch?v=2QcO8ikxzxA&ab_channel=UsefulVid) but it is recommended for novice users to use the Community Contributed package [SyncTrayzor](https://github.com/canton7/SyncTrayzor) Syncthing can be installed on windows with the official [Syncthing Installer](https://github.com/Bill-Stewart/SyncthingWindowsSetup/) by following [this video](https://www.youtube.com/watch?v=2QcO8ikxzxA&ab_channel=UsefulVid) but it is recommended for novice users to use the Community Contributed package [SyncTrayzor](https://github.com/canton7/SyncTrayzor)
Download and Install the latest version of [SyncTrazor](https://github.com/canton7/SyncTrayzor#installation) Download and Install the latest version of [SyncTrazor](https://github.com/canton7/SyncTrayzor#installation)
@ -26,11 +26,13 @@ Download and Install the latest version of [SyncTrazor](https://github.com/canto
2. Select `+ Add Remote Device` and enter the Device ID of the Syncthing Server 2. Select `+ Add Remote Device` and enter the Device ID of the Syncthing Server
![Add Remote Device](/media/td-guide/syncthing_new_device.jpg) ![Add Remote Device](/media/td-guide/syncthing_new_device.jpg)
3. On the Server's Syncthing Web GUI, select `+ Add Device` from the "New Device" pop-up 3. On the Server's Web GUI, select `+ Add Device` from the "New Device" pop-up.
![Add Device to Server](/media/td-guide/syncthing_new_device_server.jpg) ![Add Device to Server](/media/td-guide/syncthing_new_device_server.jpg)
4. Return to the Client's Syncthing Web GUI, select `Add` from the "New Folder" pop-up 4. In the "Add Device" pop-up under "Sharing" select the folder(s) to share.
![Share Folder from Server](/media/td-guide/share_folder_server.jpg)
5. Return to the Client's Web GUI, select `Add` from the "New Folder" pop-up
![Add New Folder from Server](/media/td-guide/add_new_folder.jpg) ![Add New Folder from Server](/media/td-guide/add_new_folder.jpg)
5. Enter the following path under **Folder Path** `~/data/your_project_name/shared`. 6. Enter the following path under **Folder Path** `~/data/your_project_name/shared`.
![New Folder Settings](/media/td-guide/new_folder_settings.jpg) ![New Folder Settings](/media/td-guide/new_folder_settings.jpg)
*The tilde "~" will be replaced with the home path for your operating system* *The tilde "~" will be replaced with the home path for your operating system*
6. Select save to being syncing your "Shared" Folder 7. Select save to being syncing your "Shared" Folder

56
docs/user-guide/project_tools/project-blender.md
View File

@ -2,13 +2,33 @@
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. 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 ## Blender Setup
The next step is to deploy the required software onto each of the studio's workstations.
1. Download the latest Blender
```bash
# 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`
::: 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.
:::
## Create 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 `your_project_name/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `your_project_name/shared/artifacts/addons` folder. Your Blender preferences are stored on a per project basis in `{directory-path}` 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 `your_project_name/shared/artifacts/blender` and extract it to the local directory. Along with any add-ons in the `your_project_name/shared/artifacts/addons` folder. Your Blender preferences are stored on a per project basis in `{directory-path}`
### Create Linux Shortcut ### Create Linux Shortcut
```bash ```bash
cd your_project_name/svn/tools cd ~/data/your_project_name/svn/tools
./install_desktop_file.sh ./install_desktop_file.sh
``` ```
::: info Available on Gentoo ::: info Available on Gentoo
@ -32,27 +52,27 @@ TODO Replace Image with Project-Tools version
### Create Windows Shortcut ### Create Windows Shortcut
1. Open the directory `your_project_name/svn/tools` 1. Open the directory `%HOMEPATH%\data\your_project_name\svn\tools`
2. Create a shortcut to `launch_blender_win.bat` on your desktop 2. Create a shortcut to `launch_blender_win.bat` on your desktop
### Create Mac Shortcut ### Create Mac Shortcut
1. Open the directory `your_project_name/svn/tools` 1. Open the directory `~/data/your_project_name/svn/tools`
2. In finder, select the `launch_blender_mac.command` and press `ctrl+shift+command+t` to add it to the dock. 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 ## Launch via Terminal
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
# Linux/Mac # Linux/Mac
cd your_project_name/svn/tools cd ~/data/your_project_name/svn/tools
./run_blender.py ./run_blender.py
``` ```
```bash ```bash
# Windows # Windows
cd your_project_name\svn\tools cd %HOMEPATH%\data\your_project_name\svn\tools
python run_blender.py python run_blender.py
``` ```
@ -70,12 +90,12 @@ Internally to the Blender Studio only, the blender inside your project is automa
```bash ```bash
# Linux/Mac # Linux/Mac
cd your_project_name/svn/tools cd ~/data/your_project_name/svn/tools
./update_blender.py ./update_blender.py
``` ```
```bash ```bash
# Windows # Windows
cd your_project_name\svn\tools cd %HOMEPATH%\data\your_project_name\svn\tools
python update_blender.py python update_blender.py
``` ```
## Rollback Blender ## Rollback Blender
@ -84,12 +104,12 @@ Use `rollback_blender.py` to switch the "current" version hosted in `your_projec
```bash ```bash
# Linux/Mac # Linux/Mac
cd your_project_name/svn/tools cd ~/data/your_project_name/svn/tools
./rollback_blender.py ./rollback_blender.py
``` ```
```bash ```bash
# Windows # Windows
cd your_project_name\svn\tools cd %HOMEPATH%\data\your_project_name\svn\tools
python rollback_blender.py python rollback_blender.py
``` ```
@ -100,25 +120,25 @@ In some cases users may want to run a previous version of Blender on their machi
```bash ```bash
# Linux/Mac # Linux/Mac
cd your_project_name/svn/tools cd ~/data/your_project_name/svn/tools
./run_blender_previous.py ./run_blender_previous.py
``` ```
```bash ```bash
# Windows # Windows
cd your_project_name\svn\tools cd %HOMEPATH%\your_project_name\svn\tools
python rollback_blender_local.py python rollback_blender_local.py
``` ```
## Update Blender Add-Ons ## Install/Update Add-Ons
Blender Add-ons can be packaged directly from the [Blender Studio Pipeline](https://projects.blender.org/studio/blender-studio-pipeline) repository. Personal Add-Ons can be installed [normally](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html#installing-add-ons). Blender Add-ons can be packaged directly from the [Blender Studio Pipeline](https://projects.blender.org/studio/blender-studio-pipeline) repository. Personal Add-Ons can be installed [normally](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html#installing-add-ons).
1. Enter Directory 1. Enter Directory
```bash ```bash
cd blender-studio-pipeline/scripts/pipeline-release # Linux/Mac cd ~/data/blender-studio-pipeline/scripts/pipeline-release # Linux/Mac
``` ```
```bash ```bash
cd blender-studio-pipeline\scripts\pipeline-release # Windows cd %HOMEPATH%\data\blender-studio-pipeline\scripts\pipeline-release # Windows
``` ```
2. Update Git 2. Update Git
@ -131,10 +151,10 @@ git pull --rebase origin # Pull to update to latest commit
3. Run Package Local Script 3. Run Package Local Script
```bash ```bash
./package_local.py your_project_name/shared/artifacts/addons # Linux/Mac ./package_local.py ~/data/your_project_name/shared/artifacts/addons # Linux/Mac
``` ```
```bash ```bash
python package_local.py your_project_name\shared\artifacts\addons # Windows python package_local.py %HOMEPATH%\data\your_project_name\shared\artifacts\addons # Windows
``` ```