[plugin] Draft: Develop Blender plugin by n-jay · Pull Request #1309 · AcademySoftwareFoundation/OpenCue

n-jay · 2023-07-30T18:55:09Z

Link the Issue(s) this Pull Request is related to.
#312

Summarize your change.
A standalone Blender addon for submitting OpenCue jobs.

Include initial UI and organization metadata

…/OpenCue into blender-addon-dev

Checks if dependencies were installed during first install of addon

For copying OpenCue dependencies for local Git repo

To avoid ModuleNotFoundException in first install

…/OpenCue into blender-addon-dev

Resolve error when extracting data from 'cmd' dictionary inside layerData

…/OpenCue into blender-addon-dev

Deletes opencue module when unregistering addon

In addon settings section

Will be addressed as system environment variable

…/OpenCue into blender-addon-dev

Remove extra lines, comments and unused imports

…/OpenCue into blender-addon-dev

Associated with ci/fix_compiled_proto.py

…/OpenCue into fix-integration-test-script

Render without using .blend file

…/OpenCue into blender-addon-dev

DiegoTavares · 2025-03-12T18:34:54Z


    log INFO "Building Cuebot image..."
-    docker build -t opencue/cuebot -f cuebot/Dockerfile . &>"${TEST_LOGS}/docker-build-cuebot.log"
+#    docker build -t opencue/cuebot -f cuebot/Dockerfile . &>"${TEST_LOGS}/docker-build-cuebot.log"


Is this an accidental change?

Yup, sorry about that.
Fixed with latest merge.

DiegoTavares · 2025-03-12T18:36:47Z

+    log INFO "Starting RQD Blender..."
+    docker run -td --name blender \
+    --env CUEBOT_HOSTNAME=cuebot \
+    --volume "/tmp/rqd/shots:/tmp/rqd/shots" \
+    --volume "/tmp/rqd/logs:/tmp/rqd/logs" \
+    -p 8441:8441 \
+    --network opencue_default \
+    opencue/blender
+
+    docker exec blender sh -c 'echo "RQD_USE_IP_AS_HOSTNAME=False" >> /etc/opencue/rqd.conf'
+    log INFO "Restarting RQD Blender..."
+    docker restart blender
+    sleep 3
+
+    add_RQD_tag
+
+    log INFO "Testing Blender job..."
+    run_blender_job


This PR ends up polluting the integration test script with several blender specific steps. I feel the changes are impactful enough that it makes sense to isolate blender in its own integration test.

I suggest creating ci/run_blender_integration_test.sh to maintain the general integration test script simple.

@DiegoTavares I separated the test in 1b285ed.

I was under the impression that this new script should be added to the packaging_pipeline.yaml, ideally somewhere here:
https://github.com/AcademySoftwareFoundation/OpenCue/pull/1309/changes#diff-f7ff6bba1497d8cf2c231a66ff51ef7dceb715b8a237b102973d7e4ef9417e45R160
But it doesn't seem to execute with the build.

DiegoTavares · 2025-03-12T18:38:47Z

+def isWindows():
+    """Checks if host OS is Windows"""
+    return os.name == 'nt'
+
+
+def isMacOS():
+    """Checks if host OS is macOS"""
+    return os.name == 'posix' and platform.system() == "Darwin"
+
+
+def isLinux():
+    """Checks if host OS is Linux"""
+    return os.name == 'posix' and platform.system() == "Linux"


Please use platform.system() to get the correct OS similar to the way rqmachine.py does it.

DiegoTavares · 2025-03-12T18:48:13Z

Binary files are problematic on the repo due to security risks. We should find a way to test without keeping the binary on the repo.

@DiegoTavares is there a recommended way to download a temporary binary (in this case the .blend file) during a build from something like an isolated AWS storage?
There are sample .blend files on the Blender official site, but they are quite large and complex for a simple CI pipeline. This is why I opted to go with a .blend if our own and also so that the build wouldn't break if the URL changes.

…addon-dev

lithorus · 2025-09-22T15:50:05Z

~~This file needs to be removed. We don't use requirements files anymore, but have it in the pyptoject.toml file instead~~

Wait. is this used by blender to install packages needed? If so, then it just needs to depend on the relevant opencue packages.

Iirc these are the dependencies that were needed by the Blender addon to send a job to Cuebot. I believe I got these from Cuesubmit. I'll look into making this into toml format, but I need to verify the Python version that's running inside Blender. I think the latest LTS version includes 3.11 so it should be fine.

If so, then it just needs to depend on the relevant opencue packages.

As in use an existing Cuesubmit or related dependency file instead of creating a new file?

I think you just need to depend on opencue-outline instead.

One could also argue that the OpenCue-Blender addon and the cuesubmit plugin are 2 different things. They don't share any code and are 2 different ways of submitting things.

I think you just need to depend on opencue-outline instead.

It's been a while, I'm not sure which one it was but either considered cueoutline or cuesubmit and found the minimum required dependencies through the method of testing and elimination.

One could also argue that the OpenCue-Blender addon and the cuesubmit plugin are 2 different things

I think I made this design choice because the Blender addon is installed as a .zip, and the files within the OpenCue Blender subdirectory are the source files, which the CI pipeline will use to generate the zip. This makes the addon standalone, for the most part.

But the OpenCue-Blender addon does not need any of the files in the cuesubmit plugin folder and cuesubmit plugin does not need anything from the OpenCue-Blender addon, right?
IMO, we should have a seperate folder in the root of the repo for DCC plugins/addons.

lithorus · 2025-09-22T15:55:19Z

+The OpenCue Blender addon provides a standalone job submission interface 
+from within Blender. This directory consists of the following:
+
+- addon source code under the `OpenCue`


Don't you mean OpenCue-Blender?

Yes, my bad. Will fix naming references throughout.

lithorus · 2025-09-22T21:37:39Z

+def installOpencueModules():
+    """Installs OpenCue dependencies onto Blender python environment"""
+    print("----- Installing OpenCue Dependencies -----")
+    shutil.copytree(pyoutline_path, pyoutline_directory_path)
+    shutil.copytree(opencue_path, opencue_directory_path)
+    shutil.copytree(filesequence_path, filesequence_directory_path)
+    print("\n----- OpenCue Dependencies Installed Successfully -----")
+


I don't think this will work when it's packaged up as a zip file.
If you need to install the python modules, use the published packages instead.

lithorus · 2025-09-22T21:42:49Z

+copy_dependencies() {
+  DEPENDENCIES_PATH="${ADDON_PATH}/dependencies"
+  mkdir -p "${DEPENDENCIES_PATH}"
+  cp -r "${PYOUTLINE_PATH}" "${DEPENDENCIES_PATH}"
+  cp -r "${FILESEQUENCE_PATH}" "${DEPENDENCIES_PATH}"
+  cp -r "${OPENCUE_PATH}" "${DEPENDENCIES_PATH}"
+}


Not sure it's a good idea to copy the modules into the addon. You will want to be able to use the addon with a newer version of opencue, without having to update the addon.

n-jay · 2025-10-09T00:55:42Z

@DiegoTavares @lithorus I've linked the Blender addon doc in this PR thread a while back here: #1309 (comment).

If the content in the draft is ok, I could make a separate PR for this.

…/OpenCue into blender-addon-dev

…unctions

DiegoTavares · 2026-02-24T01:59:46Z

As discussed in the previous TSC meeting, this PR is getting moved to the new repo OpenCue_extensions

n-jay added 30 commits February 10, 2023 15:20

Add initial code

0628f08

Add preliminary version of dependency installer

ef55258

Add addon init file

cec3089

Include initial UI and organization metadata

Rename addon init file

2eb2927

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

77f9717

…/OpenCue into blender-addon-dev

Add test job data

444bbc8

Add dependencies list

8fa46dd

Add initial job submission file

134c3ce

Add dependency install check

b4a21ab

Checks if dependencies were installed during first install of addon

Install external dependencies from text file

2656031

Add cp module as dependency

6d12198

For copying OpenCue dependencies for local Git repo

Implement OpenCue dependency install

a58b3d8

Reorganize imports

9c3c0d0

To avoid ModuleNotFoundException in first install

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

4162226

…/OpenCue into blender-addon-dev

Add function to remove OpenCue dependencies when unregistering

a46f2bf

Remove external cp dependency

be6c6e5

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

f9b1ea7

…/OpenCue into blender-addon-dev

Resolve AttributeError

96c45b0

Resolve error when extracting data from 'cmd' dictionary inside layerData

Add new external dependencies

9f4a668

Add opencue dependency import

f06019c

Set install directory for external python dependencies

734c677

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

c1b7ea1

…/OpenCue into blender-addon-dev

Add opencue module deletion

9b69961

Deletes opencue module when unregistering addon

Add text field for OpenCue home path

2bdd58b

In addon settings section

Remove text field for OpenCue home path

7cbb52e

Will be addressed as system environment variable

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

370ff6c

…/OpenCue into blender-addon-dev

Remove unused imports and commented lines

fe2e08a

Add render engine option to command

96608df

Cleanup code

16e6c79

Remove extra lines, comments and unused imports

Add Blender API to retrieve file path

949cb2a

n-jay added 7 commits November 15, 2024 23:12

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

f9187f9

…/OpenCue into blender-addon-dev

Fix filepath

dc9d99b

Associated with ci/fix_compiled_proto.py

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

31c2f97

…/OpenCue into fix-integration-test-script

Amend Blender render command

d74905c

Render without using .blend file

Remove .blend file input in integration tests

1f8d35c

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

fb62c9e

…/OpenCue into blender-addon-dev

Merge branch 'fix-integration-test-script' into blender-addon-dev

e81ed48

n-jay changed the title ~~Draft: Develop Blender addon~~ [plugin] Draft: Develop Blender plugin Nov 18, 2024

Merge branch 'master' into blender-addon-dev

23a5114

DiegoTavares requested changes Mar 12, 2025

View reviewed changes

n-jay mentioned this pull request Sep 20, 2025

add Blender plugin #312

Closed

n-jay added 2 commits September 21, 2025 09:50

Merge upstream updates

2dda8c3

Merge remote-tracking branch 'origin/blender-addon-dev' into blender-…

afe441e

…addon-dev

lithorus reviewed Sep 22, 2025

View reviewed changes

n-jay added 10 commits January 3, 2026 12:36

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

c89a4c7

…/OpenCue into blender-addon-dev

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

80444ae

…/OpenCue into blender-addon-dev

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

aaf7f1f

…/OpenCue into blender-addon-dev

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

9d90f53

…/OpenCue into blender-addon-dev

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

1fb3ccd

…/OpenCue into blender-addon-dev

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

f84f74d

…/OpenCue into blender-addon-dev

Merge branch 'master' of https://github.com/AcademySoftwareFoundation…

ed980da

…/OpenCue into blender-addon-dev

Add integration test script for Blender addon

1b285ed

Refactor integration test script by removing deprecated Blender job f…

e028b3e

…unctions

Remove author information from bl_info in __init__.py

9c89829

DiegoTavares closed this Feb 24, 2026

Conversation

n-jay commented Jul 30, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lithorus Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

n-jay Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lithorus Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

n-jay Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

n-jay commented Oct 9, 2025

Uh oh!

DiegoTavares commented Feb 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

lithorus Sep 22, 2025 •

edited

Loading

n-jay Sep 22, 2025 •

edited

Loading

lithorus Sep 22, 2025 •

edited

Loading

n-jay Mar 29, 2026 •

edited

Loading