Merge pull request #245 from ynput/Add_3de_docs

Add docs for 3dequalizer

website/docs/addon_3dequalizer_admin.md

@@ -0,0 +1,47 @@
+---
+id: addon_3dequalizer_admin
+title: 3DEqualizer Admin Docs
+sidebar_label: 3DEqualizer
+description: AYON 3DEqualizer Addon's documentations for admins.
+toc_max_heading_level: 5
+---
+
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Equalizer_Badge}
+</ReactMarkdown>
+
+## Overview
+
+To get the 3DEqualizer (3DE) addon running, we need to install Qt Python bindings. We use a pre-launch hook that automatically installs `PySide2/6` into 3DE Python. You can set the location using the `TDE4_ROOT` environment variable, or it will be deduced from the 3DE executable path in AYON applications settings.
+
+:::caution Python Bindings and Protected Locations
+This automatic **PySide2/6** installation might fail if 3DE is used from a protected location (either a network drive or a user write-restricted location). If this happens, you need to install PySide there manually.
+:::
+
+:::info PYTHON_CUSTOM_SCRIPTS_3DE4
+AYON uses the `PYTHON_CUSTOM_SCRIPTS_3DE4` environment variable to install itself into the 3DE menu. It appends to this variable, but if you overwrite it using a startup script or rez, the AYON menu won’t be shown in 3DE.
+:::
+
+## Addon Settings
+### Heartbeat Interval
+> Setting Location: `ayon+settings://equalizer/heartbeat_interval`
+
+![](assets/equalizer/heartbeat_interval_setting.png)
+
+This setting controls how often Qt processes yield control back to 3DE. Adjusting this value can affect the stability and responsiveness of 3DE. The default value is 500.
+
+:::info
+AYON uses this value to set the `AYON_TDE4_HEARTBEAT_INTERVAL` environment variable when the application starts. The integration addon will then rely on this environment variable throughout the session.
+:::
+
+### Create Match Move data
+> Setting Location: `ayon+settings://equalizer/create/CreateMatchMove`
+
+![](assets/equalizer/default_variants_match_move.png)
+
+This setting includes `Match Move` creator settings.
+
+- **Default variants:** List of default variants for the `Match Move` product.

website/docs/addon_3dequalizer_artist.md

@@ -0,0 +1,71 @@
+---
+id: addon_3dequalizer_artist
+title: 3DEqualizer Artist Docs
+sidebar_label: 3DEqualizer
+description: AYON 3DEqualizer Addon's documentations for artists.
+toc_max_heading_level: 5
+---
+
+import ReactMarkdown from "react-markdown";
+import versions from '@site/docs/assets/json/Ayon_addons_version.json'
+
+<ReactMarkdown>
+{versions.Equalizer_Badge}
+</ReactMarkdown>
+
+## Overview
+
+The 3DEqualizer (3DE) Addon lets you manage your 3DE projects, load plates as cameras, and publish scripts for Nuke and Maya with a Lens Distortion node for Nuke.
+
+## AYON global tools
+
+- [Work Files](artist_tools_workfiles.md)
+- [Create](artist_tools_creator.md)
+- [Load](artist_tools_loader.md)
+- [Manage (Inventory)](artist_tools_inventory.md)
+- [Publish](artist_tools_publisher.md)
+- [Library Loader](artist_tools_library_loader.md)
+
+## Addon Features
+
+### Loading Plates
+
+You can load image data into 3DE by using the [Loader](artist_tools_loaderزةي) tool. Go to the `AYON` menu in 3DE, select `Load`, and pick the image sequence you want to use. This will create a new sequence camera, set the path for the image sequence, and set the correct frame range. From that moment, the loaded sequence is version tracked. You can follow the used versions in the [Manage tool](artist_tools_inventory.md).
+
+:::note
+AYON uses **Project Notes** to store some of its information for version tracking. If you want to use them, please do not modify the content of the `AYON_CONTEXT:: ... ::AYON_CONTEXT` block, as it will probably break the version management of loaded image sequences.
+:::
+
+### Publishing Matchmove Scripts
+
+Once you track your camera in 3DE, you can export and publish it as a version for Maya and/or Nuke. Go to the `AYON` menu in 3DE and click on [Publish](artist_tools_publisher). You can create a `Match Move` publishing instance and set various settings:
+
+- **Camera(s) to Publish**: Select which camera mode to publish. Options include *All Cameras*, *Current Camera* (active), *Reference Cameras* (for all reference cameras), and *Sequence Cameras*.
+- **Model Export**: Choose to export *All 3D Models* or no models.
+- **Script Type**: Decide if you want to publish the script for Maya, Nuke, or both.
+
+Additional options (availability may vary depending on your 3DE version):
+
+- **Hide Reference Frame**
+- **Export UV Textures**
+- **Overscan Width Percent**
+- **Overscan Height Percent**
+- **Units** (options: "mm", "cm", "m", "in", "ft", "yd")
+- **Export Point Sets**
+- **Export 2.5D Points**
+
+For more details, refer to the options in the 3DE export scripts.
+
+:::info
+AYON uses built-in export scripts in 3DE for exporting, mostly with default options. In 3DE v7, scripts for Maya will be exported as **MEL**, and in v8 as **Python**.
+:::
+
+### Publishing Lens Distortion for Nuke
+
+Similar to Matchmove scripts, you can export and publish a Lens Distortion node for Nuke using [LDPK](https://www.3dequalizer.com/?site=tech_docs&id=110216_01).
+
+:::info
+Lens Distortion data will be published for the current (active) camera.
+:::
+
+You can also select the FOV mode, including the new one available in 3DE v8.

website/docs/assets/json/Ayon_addons_version.json

@@ -8,6 +8,7 @@
     "Clockify_Badge" : "[![Clockify Addon - 0.1.1](https://img.shields.io/badge/Clockify_Addon-0.1.1-0ca5eb)](https://github.com/ynput/OpenPype/tree/develop/openpype/modules/clockify)",
     "Core_Badge" : "[![Core Addon - 0.1.3](https://img.shields.io/badge/Core_Addon-0.1.3-00d5a1)](https://github.com/ynput/OpenPype)",
     "Deadline_Badge" : "[![Deadline Addon - 0.1.4](https://img.shields.io/badge/Deadline_Addon-0.1.4-f7981d)](https://github.com/ynput/OpenPype/tree/develop/openpype/modules/deadline)",
+    "Equalizer_Badge": "[![3DEqualizer Addon](https://img.shields.io/badge/3DEqualizer_Addon-0.1.0-black)](https://github.com/ynput/ayon-equalizer)",
     "Flame_Badge" : "[![Flame Addon - 0.2.4](https://img.shields.io/badge/Flame_Addon-0.2.4-3190b2)](https://github.com/ynput/ayon-flame)",
     "Ftrack_Badge" : "[![Ftrack Addon - 0.2.4](https://img.shields.io/badge/Ftrack_Addon-0.2.4-bf9ac9)](https://github.com/ynput/ayon-ftrack/tree/develop)",
     "SyncSketch_Badge" : "[![SyncSketch Addon - 0.1.1](https://img.shields.io/badge/SyncSketch_Addon-0.1.1-bf9ac9)](https://github.com/ynput/ayon-syncsketch/tree/develop)",

website/sidebars.js

@@ -37,6 +37,7 @@ module.exports = {
             label: "Integrations",
             items: [
                 "addon_3dsmax_artist",
+                "addon_3dequalizer_artist",
                 "addon_aftereffects_artist",
                 "addon_blender_artist",
                 "addon_resolve_artist",
@@ -153,6 +154,7 @@ module.exports = {
             label: "Integrations",
             items: [
                 "addon_3dsmax_admin",
+                "addon_3dequalizer_admin",
                 "addon_aftereffects_admin",
                 "addon_blender_admin",
                 "addon_resolve_admin",

website/src/data/addons/addons.ts

@@ -26,6 +26,7 @@ import { AddonType } from ".";
 export const officialAddons = [
     "core",
     "3dsmax",
+    "3dequalizer",
     "afterEffects",
     "blender",
     "celaction",

website/src/data/addons/data/3dequalizer.ts

@@ -0,0 +1,28 @@
+import { type Addon } from "../types";
+import versions from "@site/docs/assets/json/Ayon_addons_version.json";
+
+const addon: Addon = {
+    title: "3DEqualizer",
+    description:
+        "3DEqualizer stands as the premier 3D tracking solution in the VFX industry, seamlessly merging live-action footage with digital visual effects at the highest quality. It is a cornerstone of modern post-production, trusted by virtually all major players globally.",
+    icon: "3de4.png",
+    badge: versions.Equalizer_Badge,
+    features: [
+        "workfiles",
+        "loader",
+        "publisher",
+        "sceneManager",
+        "libraryLoader",
+    ],
+    products: [
+        "camera",
+        "workfile",
+    ],
+    docs: {
+        user: "addon_3dequalizer_artist",
+        admin: "addon_3dequalizer_admin",
+    },
+    github: "https://github.com/ynput/ayon-equalizer",
+};
+
+export default addon;