Update READMEs for 1.1.0

This commit is contained in:
Francesco Bellini 2024-09-13 22:51:46 +02:00
parent 95e94a7457
commit 93b6b61811
2 changed files with 70 additions and 48 deletions

View File

@ -8,30 +8,42 @@
Basically, you can decide which workspace you want to link to each scene. Basically, you can decide which workspace you want to link to each scene.
> This is possible thanks to a custom property at scene level (which is saved with your .blend file). > Scene Workspaces is based on simple custom properties at scene level.
> *This property simply list names of the linked workspaces, in the correct order.*
--- Scene Workspaces can be particularly useful in projects with multiple scenes with different needs/purpose.
### Make yourself comfortable
You can customize Scene Workspaces from add-on preferences: You can customize Scene Workspaces from add-on preferences:
- **Show Switch** - **Show only with multiple scenes** *(default: off)*
*When active, shows a checkbox to switch between Scene Workspaces and the default topbar.* Show the topbar (and eventually the checkbox) only when the project has multiple scenes.
Basically, Scene Workspaces disappear as long as you have one scene only.*
- **Auto initialize Scene Workspaces** *(default: on)*
*Automatically add all available workspaces to the current scene, if empty.
If available workspaces match one of the 5 default templates, they will be automatically ordered on intialization. Otherwise, workspaces will be ordered alphabetically.*
> This limitation is due to the fact that Scene Workspace can't access the global workspaces order.
> Use the panel `Properties > Scene > Scene Workspaces`, or the workspace menu to reorder your workspaces.
- **Show Checkbox** *(default: on)*
*When active, shows a checkbox to switch between Scene Workspaces and the default topbar.*
![Switch](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Switch.png) ![Switch](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Switch.png)
*This checkbox will directly affect the next preference.* *This checkbox will directly affect the next preference.*
- **Use Scene Workspaces topbar** - **Use Scene Workspaces topbar** *(default: on)*
*Scene Workspaces topbar.* *Scene Workspaces topbar.*
![Custom Topbar](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Custom.png) ![Custom Topbar](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Custom.png)
*Default workspaces topbar.* *Default workspaces topbar.*
![Original Topbar](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Original.png) ![Original Topbar](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Original.png)
- **Use Compact Mode** *(default ON)* - **Use Compact Mode** *(default: on)*
*Compact Mode ON* *Also avaliable from the workspace menu.*
*Compact Mode ON*
![Compact Mode On](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20On.png) ![Compact Mode On](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20On.png)
*Compact Mode OFF* *Compact Mode OFF*
![Compact Mode Off](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20Off.png) ![Compact Mode Off](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20Off.png)
--- ---
### Topbar menus
What you can usually to do by right-clicking on a workspace (and more) it's avaliable by clicking the near options button. What you can usually to do by right-clicking on a workspace (and more) it's avaliable by clicking the near options button.
![Compact Mode OFF](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Workspace%20Menu.png) ![Compact Mode OFF](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Workspace%20Menu.png)
@ -48,14 +60,14 @@ The first options are the ones from Scene Workspaces:
- **Previous workspace** *(using scene order) `Shift + Ctrl + Page Up`* - **Previous workspace** *(using scene order) `Shift + Ctrl + Page Up`*
- **Next Workspace** *(using scene order) `Shift + Ctrl + Page Down`* - **Next Workspace** *(using scene order) `Shift + Ctrl + Page Down`*
And then, starting from `Duplicate`, you'll find the default workspace options. And then you'll find the default workspace options.
> **Note** > **Note**
> Default options like `Reorder to Front`, `Reorder to Back` will only affect the global workspaces, and not the Scene Workspaces topbar. > Default options like `Reorder to Front`, `Reorder to Back` will only affect the global workspaces, and not the Scene Workspaces topbar.
*Instead, use the ones marked with `(scene only)`.* *Instead, use the ones marked with `(scene only)` or use the panel instead.*
> >
> Also, default options `Previous Workspace` and `Next Workspace` functions will follow the global workspaces order, and not the scene order. > Also, default options `Previous Workspace` and `Next Workspace` functions will follow the global workspaces order, and not the scene order.
*Instead, use the ones marked with `(scene)`.* *Instead, use the ones marked with `(scene)` or the relative shortcuts (default ones + Shift).*
--- ---
@ -71,16 +83,17 @@ You can also copy the linked workspaces from another scene, using the menu with
![Copy from scene](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Copy%20from%20other%20scene.png) ![Copy from scene](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Copy%20from%20other%20scene.png)
You can reorder, rename, link and unlink the Scene Workspaces, using the panel `Properties > Scene > Scene Workspaces`.
![Scene Workspaces Panel](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/commit/74f7f1ab5f12666998737d1b4be5ff233fa03394/assets/Properties%20-%20Scene.png)
--- ---
If you don't want to setup from scratch your Scene Workspaces on every new project, you can use the add-on [Custom Templates](https://extensions.blender.org/add-ons/custom-templates/), ### Panel Management
and prepare templates with your Scene Workspaces already prepared.
--- You can always reorder, rename, link and unlink the Scene Workspaces, using the panel `Properties > Scene > Scene Workspaces`.
![Scene Workspaces Panel](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Properties%20-%20Scene.png)
### Templates
You can use the add-on [Custom Templates](https://extensions.blender.org/add-ons/custom-templates/) to prepare templates with your Scene Workspaces already configured.
## Why this add-on? ## Why this add-on?
@ -90,7 +103,7 @@ At the same time, you may need different workspaces in different scenes, dependi
*For example, you may want a scene with workspaces optimized for modelling and another Scene optimized for Video Editing, in the same project.* *For example, you may want a scene with workspaces optimized for modelling and another Scene optimized for Video Editing, in the same project.*
**Scene Workspaces** make this possibile with the custom topbar and a custom property for each scene. **Scene Workspaces** make this possible with the custom topbar and a custom property for each scene.
## Changelog ## Changelog

View File

@ -1,31 +1,41 @@
**Scene Workspaces** creates an alternative workspaces topbar, allowing you to filter and reorder workspaces, scene by scene. **Scene Workspaces** creates an alternative workspaces topbar, allowing you to filter and reorder workspaces, scene by scene.
Basically, you can decide which workspace you want to link to each scene. Basically, you can decide which workspace you want to link to each scene.
> This is possible thanks to a custom property at scene level (which is saved with your .blend file). > Scene Workspaces is based on simple custom properties at scene level.
> *This property simply list names of the linked workspaces, in the correct order.*
--- Scene Workspaces can be particularly useful in projects with multiple scenes with different needs/purpose.
### Make yourself comfortable
You can customize Scene Workspaces from add-on preferences: You can customize Scene Workspaces from add-on preferences:
- **Show Switch** - **Show only with multiple scenes** *(default: off)*
*When active, shows a checkbox to switch between Scene Workspaces and the default topbar.* *Show the topbar (and eventually the checkbox) only when the project has multiple scenes.
*This checkbox will directly affect the next preference.* Basically, Scene Workspaces disappear as long as you have one scene only.*
- **Use Scene Workspaces topbar** - **Auto initialize Scene Workspaces** *(default: on)*
*Switch between Scene Workspaces topbar and the default topbar* *Automatically add all available workspaces to the current scene, if empty.
- **Use Compact Mode** *(default ON)* If available workspaces match one of the 5 default templates, they will be automatically ordered on initialization. Otherwise, workspaces will be ordered alphabetically.*
> *Compact Mode ON* - **Show Checkbox** *(default: on)*
> ![Compact Mode On](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20On.png) *When active, shows a checkbox to switch between Scene Workspaces and the default topbar.*
> *Compact Mode OFF* *This checkbox will directly affect the next preference.*
> ![Compact Mode Off](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20Off.png) - **Use Scene Workspaces topbar** *(default: on)*
*Switch between Scene Workspaces topbar and the default topbar*
- **Use Compact Mode** *(default: on)*
*Also avaliable from the workspace menu.*
*Compact Mode ON*
![Compact Mode On](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20On.png)
*Compact Mode OFF*
![Compact Mode Off](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Compact%20Off.png)
--- ---
### Topbar menus
What you can usually to do by right-clicking on a workspace (and more) it's avaliable by clicking the near options button. What you can usually to do by right-clicking on a workspace (and more) it's avaliable by clicking the near options button.
![Compact Mode OFF](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Workspace%20Menu.png)
The first options are the ones from Scene Workspaces: The first options are the ones from Scene Workspaces:
- **Toggle Compact Mode** *(preference)* - **Toggle Compact Mode** *(preference)*
@ -38,14 +48,12 @@ The first options are the ones from Scene Workspaces:
- **Previous workspace** *(using scene order) `Shift + Ctrl + Page Up`* - **Previous workspace** *(using scene order) `Shift + Ctrl + Page Up`*
- **Next Workspace** *(using scene order) `Shift + Ctrl + Page Down`* - **Next Workspace** *(using scene order) `Shift + Ctrl + Page Down`*
And then, starting from `Duplicate`, you'll find the default workspace options.
> **Note** > **Note**
> Default options like `Reorder to Front`, `Reorder to Back` will only affect the global workspaces, and not the Scene Workspaces topbar. > Default options like `Reorder to Front`, `Reorder to Back` will only affect the global workspaces, and not the Scene Workspaces topbar.
> *Instead, use the ones marked with `(scene only)`.* *Instead, use the ones marked with `(scene only)` or use the panel instead.*
> >
> Also, default options `Previous Workspace` and `Next Workspace` functions will follow the global workspaces order, and not the scene order. > Also, default options `Previous Workspace` and `Next Workspace` functions will follow the global workspaces order, and not the scene order.
> *Instead, use the ones marked with `(scene)`.* *Instead, use the ones marked with `(scene)` or the relative shortcuts (default ones + Shift).*
--- ---
@ -61,18 +69,19 @@ You can also copy the linked workspaces from another scene, using the menu with
![Copy from scene](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Copy%20from%20other%20scene.png) ![Copy from scene](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Topbar%20-%20Copy%20from%20other%20scene.png)
You can reorder, rename, link and unlink the Scene Workspaces, using the panel `Properties > Scene > Scene Workspaces`.
![Scene Workspaces Panel](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/commit/74f7f1ab5f12666998737d1b4be5ff233fa03394/assets/Properties%20-%20Scene.png)
--- ---
If you don't want to setup from scratch your Scene Workspaces on every new project, you can use the add-on [Custom Templates](https://extensions.blender.org/add-ons/custom-templates/), ### Panel Management
and prepare templates with your Scene Workspaces already prepared.
--- You can always reorder, rename, link and unlink the Scene Workspaces, using the panel `Properties > Scene > Scene Workspaces`.
## Why Scene Workspaces? ![Scene Workspaces Panel](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/raw/branch/main/assets/Properties%20-%20Scene.png)
### Templates
You can use the add-on [Custom Templates](https://extensions.blender.org/add-ons/custom-templates/) to prepare templates with your Scene Workspaces already configured.
## Why this add-on?
In Blender, workspaces are common across scenes. In Blender, workspaces are common across scenes.
@ -80,8 +89,8 @@ At the same time, you may need different workspaces in different scenes, dependi
*For example, you may want a scene with workspaces optimized for modelling and another Scene optimized for Video Editing, in the same project.* *For example, you may want a scene with workspaces optimized for modelling and another Scene optimized for Video Editing, in the same project.*
**Scene Workspaces** make this possibile with the custom topbar and a custom property for each scene. **Scene Workspaces** make this possible with the custom topbar and a custom property for each scene.
--- ---
For more info, checkout the project's [README](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/src/branch/main/README.md). For more info, checkout the project's [README](https://projects.blender.org/Francesco-Bellini/scene_workspaces_addon/src/branch/main/README.md).