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 +8 -5
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 45781158db - Show all commits

11
docs/user-guide/project_tools/project-overview.md
View File

@ -1,12 +1,17 @@
# Project Overview
The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems.
## Introduction
"Project Tools" is a collection of scripts included in the [Blender Studio Pipeline](https://projects.blender.org/studio/blender-studio-pipeline) repository, developed to assist you in running and managing one or more projects. These scripts automate and standardize many common operations involved in setting up a production pipeline.
It all starts with the directory layout, which should be deployed by a Technical Director following the [Project Tools Setup Guide](/td-guide/project-tools-setup.md). This standard directory layout defines where things like .blend files and playblasts are stored. It enables project tools the ability to ensure all users are running the same Blender and have a similar experience with minimal setup required by the individual users.
Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder.
## Directory Layout
Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This is for consistency between computers at the Blender Studio. External studios can use a different root folder for their projects for example a user's home folder.
The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project.
* `local` This is where the local copy of Blender and the add-ons will be installed. This directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`.
* `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc)
* `svn` This the versioned controlled folder where the .blend production files will live.
@ -20,5 +25,3 @@ The project folder contains all data related to a project including .blend files
```
To learn the layout of the above directories, see the [`shared`](/naming-conventions/shared-folder-structure.md) and [`svn`](/naming-conventions/svn-folder-structure.md) directory overviews.
To learn more about setting up a production pipeline using the project tools see the [Project Tools Setup Guide](/td-guide/project-tools-setup.md)