Merge branch '210-2-1-pre-release-2' into 'main'

Resolve "2.1 pre release 2" Closes #210 See merge request blender/public-projects/shotmanager-addon!118
ubisoft · Oct 12, 2022 · f0afb18 · f0afb18
2 parents 791faba + 98a4cb9
commit f0afb18
Show file tree

Hide file tree

Showing 57 changed files with 733 additions and 81 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,20 @@
+-----
+## 2.1.27 (2022-10-12)
+**Beta Release**
+- Merge for beta release
+
+-----
+## 2.1.26 (2022-10-12)
+- Bug fix for invalid Playblast output image format [Issue #46](https://github.com/ubisoft/shotmanager/issues/46)
+- Bug fix on Mac: the Explorer couldn't be opened
+
+-----
+## 2.1.25 (2022-10-11)
+- Improvements on the Continuous Draw Mode
+
 -----
 ## 2.1.24 (2022-10-11)
+**Beta Release**
 - Added a function applyVideoSettings() in the rendering process to change the rendering file
   format in a cleanest way (to be continued)
 - Fixed a bug when plablast video appeared all black when called without Project Settings

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@
   <img src="doc/images/Documentation.png" width="160" />
   </a>
   &nbsp;&nbsp;&nbsp;
-  <a href="https://github.com/ubisoft/shotmanager/releases/latest" title="Download latest version">
+  <a href="https://github.com/ubisoft/shotmanager/releases/latest" title="Download the latest release. For betas and experimental builds see the link below in the page">
   <img src="doc/images/Download.png" width="160" />
   </a>
   &nbsp;&nbsp;&nbsp;
@@ -88,23 +88,37 @@ It is currently used on several projects inside Ubisoft as well as on production
 
 
 ## Pre-releases
-Pre-releases and available beta versions are listed here: [Pre-releases and Experimental](https://ubisoft-shotmanager.readthedocs.io/en/latest/experimental/experimental.html#experimental) 
+Pre-releases and available beta versions appear in the [list of the release versions](https://github.com/ubisoft/shotmanager/tags) with a "beta" in their tag.
 
+For major releases some aditional information about their content is provided here: [Pre-releases and Experimental](https://ubisoft-shotmanager.readthedocs.io/en/latest/experimental/experimental.html#experimental) 
 
-## Dev notes
-Follow the development and the date of the upcoming releases on [the wiki](https://github.com/ubisoft/shotmanager/wiki).
 
-Various development notes related to the add-on itself, to the Git project or to the installation are available here: [Dev Notes](./doc/devnotes.md)
+## License and copyright
+The original code is Copyright (C) 2022 Ubisoft.
+
+All the code included in this depot and in the Ubisoft Shot Mmanager package is under the [GPLv3 license](https://www.gnu.org/licenses/gpl-3.0.html).
 
-# Support
+## Support
 The active support repository is on the [Shot Manager Github repository](https://github.com/ubisoft/shotmanager) which is part of the [Ubisoft open source](https://github.com/ubisoft) projects group.
 
 
-# License and copyright
-The original code is Copyright (C) 2022 Ubisoft.
+# Development, project and code
+
+## API
+If, as a script developer, you want to write some code that it not part of Shot Manager but that communicates with it, the [Shot Manager API](.api/doc/shot_manager_api.md) is made for you!
+
+## Dev notes
+Follow the development and the date of the upcoming releases on [the wiki](https://github.com/ubisoft/shotmanager/wiki).
+
+
+  - [Shot Manager dev notes](./doc/devnotes_addon.md): Notes about the add-on itself, its architecture, dependencies
+
+  - [Development Environment](./doc/development.md): Python venv, CI CD
+  - [Releases](./doc/release.md): How to make a release
+  - [Documentation](./doc/devdoc.md): How to update and generate the documentation with Sphinx and ReadTheDoc
 
-All code of the `shotmanager` package is under the GPLv3 license.
 
 
-# Contributions
-The contribution process will be defined soon. At the moment and since we are in the beta process of version 2.0 prefer opening an issue than submit a direct contribution.
+## Contributions
+The contribution process will be defined soon. At the moment and since we are still quite often refactoring a few things please
+prefer opening an issue and discuss your need and expectations rather than submit a direct contribution.
diff --git a/doc/devnotes_addon.md b/doc/devnotes_addon.md
@@ -1,14 +1,20 @@
 # Dev Notes for Shot Manager
 
 - [Installation](#installation)
-- [dependencies](#dependencies)
+- [Dependencies](#dependencies)
+- [Widgets and components](#widgets-and-components)
 - [Important points in Shot Manager](#important-points-in-shot-manager)
 
 
+</br>
+
 ## Installation
 The addon must be installed in Administrator mode so that the OpenTimelineIO Python library can
 be downloaded and deployed correctly. Also be sure that your firewall doesn't block the download (or use OpenVPN or equivalent).
 
+
+</br>
+
 ## Dependencies
 Shot Manager requires the following packages and add-ons to run at its best:
 
@@ -21,6 +27,17 @@ Shot Manager requires the following packages and add-ons to run at its best:
 
     It has to be installed manually, it can be downloaded here: [https://github.com/ubisoft/stampinfo](https://github.com/ubisoft/stampinfo)
 
+
+</br>
+
+## Widgets and components
+
+- [Interactive Shots Stack](../shotmanager/overlay_tools/interact_shots_stack/doc/interac_shots_stack.md)
+- [Doc GPU Library](../shotmanager/gpu/gpu_2d/doc_gpu_2d_components.md)
+
+
+</br>
+
 ## Important points in Shot Manager
 
 ### 3D:
@@ -50,12 +67,15 @@ supported.
 by the camera held by the shot.
 
 
+</br>
+
 ## Props, the main properties class
 Terminology:
     We distinguish the "selected shot", which is the one selected in the shots list, from the "current shot",
     which is the shot actualy displayed in the viewport and identified in the shots list with an orange icon
     in the first column.
 
+</br>
 
 ## Shot select, set current, set to Draw Mode
 

diff --git a/docs/experimental/experimental.rst b/docs/experimental/experimental.rst
@@ -3,7 +3,8 @@
 Pre-releases and experimental
 =============================
 
-All the pre-releases and previous versions are available here: `github.com/ubisoft/shotmanager/releases <https://github.com/ubisoft/shotmanager/releases>`__
+All the pre-releases and previous versions are available here: `github.com/ubisoft/shotmanager/tags <https://github.com/ubisoft/shotmanager/tags>`__
+They have the label **"beta"** in their tag name.
 
 
 Shot Manager 2.1 pre-releases
@@ -16,6 +17,9 @@ available as a beta pre-release.
 
 **Latest pre-release:**
 
+    - `v2.1.24_Beta <https://github.com/ubisoft/shotmanager/releases/tag/v2.1.24_Beta>`__
+
+..
     - No pre-releases at the moment
 
 See also:

diff --git a/docs/feature-toggles/camerabg.txt b/docs/feature-toggles/camerabg.txt
@@ -0,0 +1,8 @@
+.. _camera-backgrounds:
+
+
+
+Camera Backgrounds
+==================
+
+Doc to come...
diff --git a/docs/feature-toggles/feature-toggles-list.rst b/docs/feature-toggles/feature-toggles-list.rst
@@ -10,15 +10,17 @@ Toggling Features
    :caption: Feature Toggles List
 
    /feature-toggles/feature-toggles-panel
-   /feature-toggles/notes
-   /feature-toggles/camerabg
+   ..
+      /feature-toggles/notes
+      /feature-toggles/camerabg
    /feature-toggles/retimer
    /feature-toggles/markers-nav-bar
 
-The following features add their UI control components into the Take and the Shots panels:
+..
+   The following features add their UI control components into the Take and the Shots panels:
 
-- :ref:`Shot and take notes <shot-and-take-notes>`: Add notes on shots and takes to better manage your scene content.
-- :ref:`Camera backgrounds <camera-backgrounds>`: Use and toggle camera backgrounds.
+   - :ref:`Shot and take notes <shot-and-take-notes>`: Add notes on shots and takes to better manage your scene content.
+   - :ref:`Camera backgrounds <camera-backgrounds>`: Use and toggle camera backgrounds.
 
 
 Retimer is a tool on its own. When turned on a new panel named *Retimer* will appear below the Shots panel.

diff --git a/docs/feature-toggles/feature-toggles-panel.rst b/docs/feature-toggles/feature-toggles-panel.rst
@@ -1,5 +1,9 @@
 .. _feature-toggles-panel:
 
+.. |br| raw:: html
+
+  <br/>
+
 Feature Toggles panel
 =====================
 
@@ -26,6 +30,7 @@ There are 2 ways to open the Feature Toggles panel:
     :align: center
     :scale: 100%
 
+|br|
 - Or directly click on the *Feature Toggles* button.
 
     This button offers a quick access to the Features dialog box, which you may find convenient when you often toggle some features in order
@@ -35,12 +40,14 @@ There are 2 ways to open the Feature Toggles panel:
     :align: center
     :scale: 100%
 
+|br|
 The Feature Toggles panel gets opened. It allows the listed featuers to be toggled by a simple click on they associated button.
 
 ..  image:: /img/feature-toggles/SM_Features_DialogBox.png
     :align: center
     :scale: 100%
 
+|br|
 
 
 
diff --git a/docs/feature-toggles/markers-nav-bar.rst b/docs/feature-toggles/markers-nav-bar.rst
@@ -1,5 +1,9 @@
 .. _markers-nav-bar:
 
+.. |br| raw:: html
+
+  <br/>
+
 Markers Navigation Toolbar
 ==========================
 
@@ -13,3 +17,10 @@ The widget can be displayed from the :ref:`Features panel<feature-toggles-panel>
 the Timeline editor toolbar, the Dopesheet toolbar or on the Video Sequence Editor.
 
 
+..  image:: /img/toggles/SM_Toggles_MarkersNavBar.png
+    :align: center
+    :scale: 100%
+
+
+|br|
+As for the rest of Shot Manager, refer to the tooltips of the buttons for a description of their purpose.
diff --git a/docs/feature-toggles/notes.txt b/docs/feature-toggles/notes.txt
@@ -0,0 +1,8 @@
+.. _shot-and-take-notes:
+
+
+
+Shot and Take Notes
+===================
+
+Doc to come...
diff --git a/docs/feature-toggles/retimer.rst b/docs/feature-toggles/retimer.rst
@@ -1,6 +1,8 @@
 .. _retimer:
 
+.. |br| raw:: html
 
+  <br/>
 
 Retimer
 =======
@@ -21,12 +23,14 @@ To display the Retimer panel open the :ref:`Feature Toggles panel <feature-toggl
     :align: center
     :scale: 100%
 
+|br|
 The panel then appears below the Shot Manager main panel.
 
 ..  image:: /img/feature-toggles/SM_Retimer_Panel.png
     :align: center
     :scale: 80%
 
+|br|
 
 Insert, scale or delete time
 ----------------------------

diff --git a/docs/getting-started/install.rst b/docs/getting-started/install.rst
@@ -14,11 +14,15 @@ The currently supported Blender versions are 3.1, 3.0 and 2.93 LTS.
 Download
 --------
 
-Open the `latest release <https://github.com/ubisoft/shotmanager/releases/latest>`__  page from the Shot Manager Gihub `releases page <https://github.com/ubisoft/shotmanager/releases>`_.
-Download the zip file listed in **Assets** that has the package icon: |package-icon|.
+Open the `latest release <https://github.com/ubisoft/shotmanager/releases/latest>`__  page from the Shot Manager Gihub and
+download the zip file listed in **Assets** that has the package icon: |package-icon|.
 
 .. |package-icon| image:: /img/package-icon.png
 
+
+In very specific cases you may want to give a try to a pre-release or experimental build.
+Get more information about those versions here: :ref:`Pre-Releases and Experimental <experimental>`
+
 .. _installing:
 
 Install of Shot Manager

diff --git a/docs/how-to/features/how-to-usecamerabackgrounds.txt b/docs/how-to/features/how-to-usecamerabackgrounds.txt
@@ -0,0 +1,10 @@
+.. _how-to-usecamerabackgrounds:
+
+How to use camera backgrounds
+=============================
+
+wip
+
+Go to :ref:`Camera Backgrounds <camera-backgrounds>`.
+
+
diff --git a/docs/how-to/how-to-toggle-features.rst b/docs/how-to/how-to-toggle-features.rst
@@ -3,22 +3,23 @@
 How to toggle advanced features
 ===============================
 
-Manage cameras
---------------
+..
+    Manage cameras
+    --------------
 
-- :ref:`How to use camera backgrounds <camera-backgrounds>`
+    - :ref:`How to use camera backgrounds <camera-backgrounds>`
 
-.. toctree::
-    :maxdepth: 2
-    :hidden:
-
-    features/how-to-usecamerabackgrounds
+    .. toctree::
+        :maxdepth: 2
+        :hidden:
+        
+        features/how-to-usecamerabackgrounds
 
 
-Manage shots and takes
-----------------------
+    Manage shots and takes
+    ----------------------
 
-- :ref:`Shot and take notes <shot-and-take-notes>`
+    - :ref:`Shot and take notes <shot-and-take-notes>`
 
 
 Retime the scene content

diff --git a/docs/img/ShotManagerPanel_Main.png b/docs/img/ShotManagerPanel_Main.png
diff --git a/docs/img/feature-toggles/SM_Features_DialogBox.png b/docs/img/feature-toggles/SM_Features_DialogBox.png
diff --git a/docs/img/feature-toggles/SM_Features_Retimer.png b/docs/img/feature-toggles/SM_Features_Retimer.png
diff --git a/docs/img/keymaps_prefs.png b/docs/img/keymaps_prefs.png
diff --git a/docs/img/rendering/SI_Hand__0002_Handles-03.jpg b/docs/img/rendering/SI_Hand__0002_Handles-03.jpg
diff --git a/docs/img/rendering/SI_Hand__0005_Handles-Tips-03.jpg b/docs/img/rendering/SI_Hand__0005_Handles-Tips-03.jpg
diff --git a/docs/img/rendering/SI_Hand__0007_Handles-Tips-05.jpg b/docs/img/rendering/SI_Hand__0007_Handles-Tips-05.jpg
diff --git a/docs/img/rendering/SI_Range__0001_Conventions-02.jpg b/docs/img/rendering/SI_Range__0001_Conventions-02.jpg
diff --git a/docs/img/rendering/SI_Range__0004_Consequences-on-range-03.jpg b/docs/img/rendering/SI_Range__0004_Consequences-on-range-03.jpg
diff --git a/docs/img/rendering/SI_Range__0005_Consequences-on-duration.jpg b/docs/img/rendering/SI_Range__0005_Consequences-on-duration.jpg
diff --git a/docs/img/rendering/StampInfoModes_Outside.jpg b/docs/img/rendering/StampInfoModes_Outside.jpg
diff --git a/docs/img/rendering/StampInfoModes_Over.jpg b/docs/img/rendering/StampInfoModes_Over.jpg
diff --git a/docs/img/rendering/StampInfo_Screen.jpg b/docs/img/rendering/StampInfo_Screen.jpg
diff --git a/docs/img/stampinfo_logo.ico b/docs/img/stampinfo_logo.ico
diff --git a/docs/img/stampinfo_logo.png b/docs/img/stampinfo_logo.png
diff --git a/docs/img/toggles/SM_Toggles_MarkersNavBar.png b/docs/img/toggles/SM_Toggles_MarkersNavBar.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,7 @@ Ubisoft Shot Manager: Creative narration in Blender
 
 **Manage the cameras of your scenes inside** `Blender <https://www.blender.org/>`__. **and edit your sequence in real time and with great simplicity.**
 
-**Current version is 2.0. The currently supported Blender versions are 3.2, 3.1 and 2.93 LTS**
+**Current version is 2.0. The currently supported Blender versions are 3.3 LTS and 2.93 LTS**
 |br|. . .and the documentation is still in development :D
 |br|
 
@@ -136,6 +136,15 @@ Read this article to see how we used this tool on the TV production of Rabbids I
    /settings/keymap
 
 
+.. toctree::
+   :maxdepth: 4
+   :hidden:
+   :caption: Rendering
+
+   /rendering/rendering
+   /rendering/stampinfo/stampinfo
+
+
 .. toctree::
    :maxdepth: 2
    :hidden:

diff --git a/docs/overlay-tools/camera-hud.txt b/docs/overlay-tools/camera-hud.txt
@@ -0,0 +1,8 @@
+.. _camera-hud:
+
+Camera HUD
+==========
+
+To do
+
+
diff --git a/docs/overlay-tools/overlay-tools.rst b/docs/overlay-tools/overlay-tools.rst
@@ -9,7 +9,8 @@ There are 3 ovelay tools:
 
 - :ref:`Sequence Timeline <sequence-timeline>`: Add notes on shots and takes to better manage your scene content.
 - :ref:`Interactive Shots Stack <shots-stack>`: Use and toggle camera backgrounds.
-- :ref:`Camera HUDs <camera-hud>`: Use and toggle camera backgrounds.
+..
+    - :ref:`Camera HUDs <camera-hud>`: Use and toggle camera backgrounds.
 
 
 .. toctree::