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

12
docs/user-guide/project-overview.md
View File

@ -1,15 +1,15 @@
# Project Overview # Project Overview
The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. 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. The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems.
Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This means that absolute paths between operating systems will be the same. This is how the Blender Studio lays out their directories. External studios can use a different root folder for their projects (for example a user's home folder) but the studio TDs will be responsible for ensuring all paths are valid when syncing between operating systems. 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 ## Directory Layout
### Project Layout ### Project Layout
The project folder contains all data about the current project, this directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`. 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. * `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) * `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. * `svn` This the versioned controlled folder where the .blend production files will live.
@ -27,7 +27,9 @@ The project folder contains all data about the current project, this directory i
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. 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.
<!--- TODO Replace with new folder structure ---> <!--- TODO Replace with new folder structure --->
::: warning Work in Progress
15 Oct. 2023 - The following folder trees are out of data, and will soon be updated.
:::
```bash ```bash
. .
├── bts # Behind the scenes ├── bts # Behind the scenes