Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

General: Creator plugins from addons can be registered#3179

Merged
iLLiCiTiT merged 6 commits into
developfrom
feature/OP-3220_Creators-in-Addons-issues
May 17, 2022
Merged

General: Creator plugins from addons can be registered#3179
iLLiCiTiT merged 6 commits into
developfrom
feature/OP-3220_Creators-in-Addons-issues

Conversation

@iLLiCiTiT
Copy link
Copy Markdown
Member

@iLLiCiTiT iLLiCiTiT commented May 13, 2022

Brief description

Addons can register creator plugin paths and Creators can have host name filter.

Description

Creator plugins have host name filtering so e.g. tray publisher creators won't appear in other hosts. Addon can implement new method which return creator plugin paths for specific host name. Default implementation is using get_plugin_paths for backwards compatibility. Installation of openpype plugins will also register creators from modules. Creator plugin has also ability to define host name filter.

Additional information

We wanted to have filtering ability of creator plugins on both addon and creator side so creator plugin has host_name attribute which can define on which host is working. This is for backwards compatibility not abstract. But it is a question if it should be required? In most of cases it is only matter of addon implementation where this filter is "required" (It probably won't happen that host on it's own will register plugins for different host). Also at this time are new creators used only in 3 hosts so it could be easy to change it.

Testing notes:

  1. Create addon and add it to addons path
  2. Make sure the addon inherit from IPluginPaths
  3. Create some creator plugin for TrayPublisher inside the addon
  4. Make sure addon implement get_creator_plugin_paths which returns path to the creator dir
  5. Run tray publisher
  6. The creator should be visible there

Resolves #3165

@ynbot
Copy link
Copy Markdown
Contributor

ynbot commented May 13, 2022

Task linked: OP-3220 Creators in Addons issues

@iLLiCiTiT iLLiCiTiT self-assigned this May 13, 2022
@iLLiCiTiT iLLiCiTiT added the type: feature Larger, user affecting changes and completely new things label May 13, 2022
@iLLiCiTiT iLLiCiTiT requested review from 64qam and kalisp May 13, 2022 10:07
@iLLiCiTiT iLLiCiTiT requested review from antirotor May 16, 2022 16:27
Copy link
Copy Markdown
Member

@kalisp kalisp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Working for creator in add on.

@iLLiCiTiT iLLiCiTiT merged commit d0c66d2 into develop May 17, 2022
@iLLiCiTiT iLLiCiTiT deleted the feature/OP-3220_Creators-in-Addons-issues branch May 17, 2022 15:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

type: feature Larger, user affecting changes and completely new things

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Creators in Addons issues

3 participants