Skip to content

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
mkdir ~/data/your_project_name # Linux/Mac
bash
mkdir %HOMEPATH%\data\your_project_name # Windows
mkdir %HOMEPATH%\data\your_project_name # Windows
  1. Navigate to the project-tools folder
bash
cd ~/data/blender-studio-pipeline/scripts/project-tools # Linux/Mac
cd ~/data/blender-studio-pipeline/scripts/project-tools # Linux/Mac
bash
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\project-tools # Windows
cd %HOMEPATH%\data\blender-studio-pipeline\scripts\project-tools # Windows
  1. 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
./init_project_folder_structure.py ~/data/your_project_name # Linux/Mac
bash
python init_project_folder_structure.py %HOMEPATH%\data/your_project_name # Windows
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.
  1. Create render directory (Optional)
bash
mkdir ~/data/your_project_name/render # Linux/Mac
mkdir ~/data/your_project_name/render # Linux/Mac
bash
mkdir %HOMEPATH%\data\your_project_name\render # Windows
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.