Tips & Tricks for OpenPype

openpype_utils.md

How to make a publish plug-in manageable in Studio Settings?

1. Edit the related schema. For example: openpype\settings\entities\schemas\projects_schema\schemas\schema_maya_publish.json
2. Run run_settings script
3. Save the defaults.
4. Re-run tray.

For example this could be added to make it possible to disable the ExtractModel plug-in

        {
            "type": "schema_template",
            "name": "template_publish_plugin",
            "template_data": [
                {
                    "key": "ExtractModel",
                    "label": "Extract Model (.mayaAscii)"
                }
            ]
        }

How to add custom actions in the Launcher?

What's the recommended way to register them and where should I put those?

Jakub Trllo (Pype.Club):

Currently there are 2 options:

1. add them to zips into defaults actions folder
2. create OpenPype addon which can return path to actions in collect_plugin_paths

I would say that addon is better. But there is not currently way how to automatically deploy addons with zip so all workstations must have access to the addons path.

addons path can be set in system settings modules/addon_paths

Note:

• openpype/modules is not dynamically loaded but using explicit loading
• openpype/modules/default_modules is currently dynamically loaded but that should change when we move all modules out of there. Other way how to load addons dynamically is with setting path to directory where addons are in system settings modules/addon_paths

Deadline Rendering with OpenPype

Basic instructions: https://openpype.io/docs/module_deadline

---

• OPENPYPE_MONGO must be defined for the Deadline Workers to know which Mongo database URL should be used from the Workers.
  For now we patched it to get a default fallback value from GlobalJobPreLoad.py.

• Note that you need to set OpenPype Executable paths for BOTH the OpenPype Event Plugin and the Render Plugin individiually.