studio/blender-studio-tools
13
32
Fork 19
Code Issues 20 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 +445 -219
21 changed files with 445 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/.vitepress/config.ts
View File

@ -171,7 +171,41 @@ export default defineConfig({
text: 'TD Guide',
collapsed: true,
items: [
{text: 'Project Tools Setup', link: '/td-guide/project-tools-setup'},
{text: 'Introduction', link: '/td-guide/project-tools-setup'},
{text: 'Repository', link: '/td-guide/repository'},
{text: 'Python', 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/Tortoise_SVN_Checkout.jpg (Stored with Git LFS) Normal file
View File

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

BIN
docs/media/td-guide/syncthing_tray_windows.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
```

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

@ -1,219 +1,19 @@
# 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
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
Running these scripts requires python 3.11+, please ensure [python & it's dependencies are installed](/td-guide/python.md) 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.
```bash
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.
1. Create project root directory
```bash
mkdir /data/your_project_name
```
2. Navigate to the project-tools folder
```bash
cd /data/blender-studio-pipeline/scripts/project-tools
```
3. Create base folder structure using
```bash
./init_project_folder_structure.py /data/your_project_name
```
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/
```
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
cd /data/blender-studio-pipeline/scripts/project-tools
init_project_folder_structure.py /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`.
## 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
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
mkdir ~/data # Linux/Mac
```
### 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. 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
```
#### 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
cd /data/your_project_name/svn/tools
./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
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
```
### Install Blender Icon
If a desktop icon is preferred to launch blender
```bash
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
```
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
mkdir %HOMEPATH%\data # Windows
```

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.

36
docs/td-guide/python.md Normal file
View File

@ -0,0 +1,36 @@
# Python Setup
## Install Python
The Blender Studio Pipeline requires `Python 3.11` or greater to be installed on your system.
## Windows & Mac
1. Navigate to https://www.python.org/downloads/windows/ to download & install the latest version of Python
2. On the first page of the installer, ensure the option labelled “Add Python to PATH” is enabled
3. After installation, open a command prompt/terminal window, enter `python --version`, if installation was successful the python version you installed should be printed in your command prompt/terminal window.
## Linux
Python is pre-installed on many distributions. Here is how to explicitly install python on some common distributions.
**Gentoo**
```bash
emerge --ask dev-lang/python:3
```
**Ubuntu/Debian**
```bash
apt-get install python3
apt install python-is-python3
```
**Arch Linux**
```bash
packman -S python
```
After installation, open a command prompt/terminal window, enter `python --version`, if installation was successful the python version you installed should be printed in your command prompt/terminal window.
## Install Dependencies
The Blender Studio Pipeline depends on scripts that require packages from the PIP package manager. The following is a guide to installing the required packages, on your system's python. To avoid module clutter consider setting up a virtual environment see the [official Python Documentation](https://docs.python.org/3/library/venv.html) for details.
1. Ensure PIP is installed `python -m ensurepip --upgrade`
2. Install required 'requests' package `python -m pip install requests`

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
```

39
docs/td-guide/svn-setup.md Normal file
View File

@ -0,0 +1,39 @@
# SVN Set-Up
## Install/Setup SVN
The Blender Studio Pipeline relies on SVN to version control all .blend files used in production. This guide will show you how to install an SVN on a workstation, assuming you already have an SVN server setup. To learn more about how to setup an SVN server visit the [SVN Documentation](https://subversion.apache.org/quick-start#setting-up-a-local-repo)
### Linux/Mac
1. Install SVN Client on your system via the [SVN Documentation](https://subversion.apache.org/packages.html)
2. Use the following command to checkout the current SVN repository into the SVN directory.
```bash
svn checkout http://your_svn.url ~/data/your_project_name/svn
```
### Windows
1. Download & Install the [TortoiseSVN Client](https://tortoisesvn.net/downloads.html)
2. Navigate to your project's root directory. Right-Click Select the `svn` folder and select `SVN Checkout`
3. Enter the URL to checkout under `URL of repository`
4. Select OK to begin checking out the repository
![Tortoise SVN Checkout Dialogue Box](/media/td-guide/Tortoise_SVN_Checkout.jpg)
## Committing Changes to Repository
### Linux/Mac
To commit changes to the SVN use the following command. For more details see the [SVN Documentation](https://subversion.apache.org/quick-start#committing-changes)
```bash
svn commit -m "My Descriptive Log Message"
```
### Windows
To commit changes from the TortoiseSVN client, follow the steps below. For more information see the [TortoiseSVN Documentation](https://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-commit.html)
1. Navigate to your project's root directory.
2. Right-Click Select the `svn` folder and select `SVN Commit`
3. Enter your commit's message in the box labelled `Message`
4. Review what files have changed in the box labelled `Changes made`
::: info Note
For more details on how to set-up an SVN repository please see the official [SVN Documentation](https://subversion.apache.org/quick-start) and the [TortoiseSVN Documentation](https://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-repository.html)
:::

38
docs/td-guide/syncthing-setup.md Normal file
View File

@ -0,0 +1,38 @@
# Syncthing Setup
## Install Syncthing
The Blender Studio Pipeline relies on [syncthing](https://syncthing.net/) to sync large files like Renders and Playblasts used in production. This guide will show you how to install an Syncthing on a workstation, assuming you already have an Syncthing server setup. To learn more about how to setup an SVN server visit the [Syncthing Documentation](https://docs.syncthing.net/intro/getting-started.html)
### Linux/Mac
**Debian/Ubuntu**
Install the latest Syncthing Packages via the official [Syncthing Repository](https://apt.syncthing.net/)
**Other Linux Distrubutions**
Get the [latest release](https://github.com/syncthing/syncthing/releases/tag/v1.27.2) for your distribution.
### Windows
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)
## Setup Syncthing
1. Launch Syncthing Web GUI
- Browser: The default address for web GUI `127.0.0.1:8384`
- Linux: Find "Syncthing Web UI" in Application Launcher
- Windows: Right Click SyncTrazor icon in the system tray and select `Open SyncTrazor`
![Launch syncthing GUI via tray (windows)](/media/td-guide/syncthing_tray_windows.jpg)
2. Select `+ Add Remote Device` and enter the Device ID of the Syncthing Server
![Add Remote Device](/media/td-guide/syncthing_new_device.jpg)
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)
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)
6. Enter the following path under **Folder Path** `~/data/your_project_name/shared`.
![New Folder Settings](/media/td-guide/new_folder_settings.jpg)
*The tilde "~" will be replaced with the home path for your operating system*
7. Select save to being syncing your "Shared" Folder

85
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.
## 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}`
### Create Linux Shortcut
```bash
cd your_project_name/svn/tools
cd ~/data/your_project_name/svn/tools
./install_desktop_file.sh
```
::: info Available on Gentoo
@ -32,23 +52,29 @@ TODO Replace Image with Project-Tools version
### 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
### 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.
## 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.
```bash
cd your_project_name/svn/tools
# Linux/Mac
cd ~/data/your_project_name/svn/tools
./run_blender.py
```
```bash
# Windows
cd %HOMEPATH%\data\your_project_name\svn\tools
python run_blender.py
```
::: warning Command Line Arguments
Note: Command Line Arguments also known as Flags are not supported by the `run_blender.py` script.
@ -63,17 +89,29 @@ Internally to the Blender Studio only, the blender inside your project is automa
:::
```bash
cd 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
```
## Rollback Blender
Use `rollback_blender.py` to switch the "current" version hosted in `your_project_name/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 your_project_name/svn/tools
# Linux/Mac
cd ~/data/your_project_name/svn/tools
./rollback_blender.py
```
```bash
# Windows
cd %HOMEPATH%\data\your_project_name\svn\tools
python rollback_blender.py
```
### Run a previous version of Blender Locally
@ -81,19 +119,42 @@ cd your_project_name/svn/tools
In some cases users may want to run a previous version of Blender on their machine without affecting other users.
```bash
cd your_project_name/svn/tools
# Linux/Mac
cd ~/data/your_project_name/svn/tools
./run_blender_previous.py
```
```bash
# Windows
cd %HOMEPATH%\your_project_name\svn\tools
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).
1. Enter Directory
```bash
cd blender-studio-pipeline/scripts/pipeline-release
cd ~/data/blender-studio-pipeline/scripts/pipeline-release # Linux/Mac
```
```bash
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\pipeline-release # Windows
```
2. Update Git
```bash
# Windows & Linux/Mac
git checkout main # Checkout main branch
git reset --hard # Remove any changes stored in your branch
git pull --rebase origin # Pull to update to latest commit
./package_local.py your_project_name/shared/artifacts/addons
```
3. Run Package Local Script
```bash
./package_local.py ~/data/your_project_name/shared/artifacts/addons # Linux/Mac
```
```bash
python package_local.py %HOMEPATH%\data\your_project_name\shared\artifacts\addons # Windows
```