Merge pull request #191 from ynput/motionbuilder/AY-5371_Feature-docu…

…mentation

Update Motion Builder Documentation

website/docs/addon_motionbuilder_admin.md

@@ -0,0 +1,15 @@
+---
+id: addon_motionbuilder_admin
+title: Motionbuilder Admin Docs
+sidebar_label: Motionbuilder
+---
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.MotionBuilder_Badge}
+</ReactMarkdown>
+
+:::note Work in progress
+This part of documentation is still work in progress.
+:::

website/docs/addon_motionbuilder_artist.md

@@ -0,0 +1,87 @@
+---
+id: addon_motionbuilder_artist
+title: Motionbuilder Docs
+sidebar_label: Motionbuilder
+---
+
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.MotionBuilder_Badge}
+</ReactMarkdown>
+
+:::note Work in progress
+This part of documentation is still work in progress.
+:::
+## First Steps With AYON
+With AYON plugins in Motionbuilder, you can save/load project in workfile tools, load your rig/character/animation into the scene, and publish your scene and animation.
+
+Locate **AYON Icon** in the OS tray (if hidden dive in the tray toolbar).
+
+> If you cannot locate the AYON icon ...it is not probably running so check [Getting Started](artist_getting_started.md) first.
+
+By clicking the icon  ```AYON Menu``` rolls out.
+
+![Menu AYON](assets/3dsmax_tray_OP.png)
+
+Choose ```AYON Menu > Launcher``` to open the ```Launcher``` window.
+
+When opened you can **choose** the **project** to work in from the list. Then choose the particular **asset** you want to work on then choose **task**
+and finally **run Motionbuilder by its icon** in the tools.
+
+![AYON Launcher](assets/motionbuilder_ayon_launcher.png)
+
+:::note Launcher Content
+The list of available projects, assets, tasks and tools will differ according to your Studio and need to be set in advance by supervisor/admin.
+:::
+
+## Running in the Motionbuilder
+
+If Motionbuilder has been launched via OP Launcher there should be **AYON Menu** visible in Motionbuilder **top header** after start.
+This is the core functional area for you as a user. Most of your actions will take place here.
+
+![AYON Launcher](assets/motionbuilder_ayon_menu.png)
+
+:::note AYON Menu
+User should use this menu exclusively for **Opening/Saving** when dealing with work files not standard ```File Menu``` even though user still being able perform file operations via this menu but preferably just performing quick saves during work session not saving actual workfile versions.
+:::
+
+## Creating and Publishing Instances
+
+:::warning Important
+Before proceeding further please check [Glossary](artist_concepts.md) and [What Is Publishing?](artist_publish.md) So you have clear idea about terminology.
+:::
+
+### Intro
+
+Current MotionBuilder Integration supports ```Workfile```and ```Animation``` product types for publishing while ```Animation```, ```Camera```,
+```Model```and ```Rig``` for loading.
+
+Both **Animation** and **Workfile** product type are outputting the animation in FBX format. **Workfile** product type generally outputs all objects from the scene. **Animation** product type allow users to choose export by model selections and their FBX export options before publishing.
+
+## Publish Animation
+Select the objects in the scene you want to export and go **AYON -> Create** and select **Animation**.
+There are several FBX options available being user customizable in AYON: *Embed Media*, *Save Selected Models Only*, *Keep Transform Hierarchy*
+
+*Embed Media*: When enabled, it is possible to embed all media into FBX file. If the FBX being in ASCII format then it is impossible to embed any media in.
+
+*Save Selected Models Only*: Only selected models will be saved.
+
+*Keep Transform Hierarchy*: Indicate if transform hierarchy is kept when SaveSelectedModelsOnly is true. Default value is false to ensure consistent behavior with SaveSelected operation via file menu.
+
+
+![AYON Creator](assets/motionbuilder_creator.png)
+
+If you turn on *Save Selected Models Only*, and select your model in the scene, the model is added to the created set. AYON would solely publish the animated model under the set.
+
+
+## Loading Products
+The pointcache loader only imports the asset in FBX format which is published from ```Animation```, ```Camera```, ```Model```and ```Rig```.
+
+The loader will create the set which includes the loaded assets. All these assets are with the namespace, which is useful for updating assets.
+
+## Removing Products
+If the users remove the assets by going to **AYON -> Manage**, right-click and **Remove items**. The assets would be removed along with its namespace.
+
+![Motionbuilder Scene Inventory](assets/motionbuilder_scene_inventory.png)

website/docs/assets/json/Ayon_addons_version.json

@@ -19,6 +19,7 @@
     "Max_Badge" : "[![3Ds Max Addon - 0.1.2](https://img.shields.io/badge/3Ds_Max_Addon-0.1.2-3190b2)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/max)",
     "Maya_Badge" : "[![Maya addon - 0.1.6](https://img.shields.io/badge/Maya_Addon-0.1.6-3190b2)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/maya)",
     "Muster_Badge" : "[![Muster Addon - 0.1.1](https://img.shields.io/badge/Muster_Addon-0.1.1-1589b8)](https://github.com/ynput/OpenPype/tree/develop/openpype/modules/muster)",
+    "MotionBuilder_Badge" : "[![Motionbuilder Addon - 0.1.0](https://img.shields.io/badge/MotionBuilder_Addon-0.1.0-f279b1)](https://github.com/ynput/ayon-motionbuilder)",
     "Nuke_Badge" : "[![Nuke Addon - 0.1.5](https://img.shields.io/badge/Nuke_Addon-0.1.5-fab41a?logo=nuke&logoColor=fab41a)](https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/nuke)",
     "OpenPype_Badge" : "[![OpenPype Addon - 3.7.17](https://img.shields.io/badge/OpenPype_Addon-3.7.17-00d6a1)](https://github.com/ynput/OpenPype)",
     "OpenRV_Badge" : "[![OpenRV Addon - 1.0.0](https://img.shields.io/badge/OpenRV_Addon-1.0.0-36a4cb)](https://github.com/ynput/ayon-openrv)",

website/sidebars.js

@@ -66,6 +66,7 @@ module.exports = {
                         "addon_maya_redshift_artist",
                     ],
                 },
+                "addon_motionbuilder_artist",
                 "addon_nuke_artist",
                 "addon_photoshop_artist",
                 "addon_substancepainter_artist",
@@ -133,6 +134,7 @@ module.exports = {
                 "addon_houdini_admin",
                 "addon_keycloak_admin",
                 "addon_maya_admin",
+                "addon_motionbuilder_admin",
                 "addon_nuke_admin",
                 "addon_photoshop_admin",
                 "addon_site_sync_admin",

website/src/data/addons/addons.ts

@@ -39,6 +39,7 @@ export const officialAddons = [
     "hiero",
     "houdini",
     "maya",
+    "motionbuilder",
     "nuke",
     "photoshop",
     "royalRender",

website/src/data/addons/data/motionbuilder.ts

@@ -0,0 +1,31 @@
+import { type Addon } from "../types";
+import versions from "@site/docs/assets/json/Ayon_addons_version.json";
+
+const addon: Addon = {
+    title: "Motion Builder",
+    description:
+        "MotionBuilder is a 3D character animation software which users can do virtual cinematography, motion capture and traditional keyframe animation.",
+    icon: "motionbuilder-icon.png",
+    badge: versions.MotionBuilder_Badge,
+    features: [
+        "workfiles",
+        "loader",
+        "publisher",
+        "sceneManager",
+        "libraryLoader",
+    ],
+    products: [
+        "animation",
+        "model",
+        "camera",
+        "workfile",
+        "rig"
+    ],
+    docs: {
+        user: "addon_motionbuilder_artist",
+        admin: "addon_motionbuilder_admin",
+    },
+    github: "https://github.com/ynput/ayon-motionbuilder",
+};
+
+export default addon;