Skip to content

load_plugins

BackdropLoaderPluginModel

Bases: BaseSettingsModel

Shared model for backdrop-based loaders.

Source code in server/settings/load_plugins.py
16
17
18
19
class BackdropLoaderPluginModel(BaseSettingsModel):
    """Shared model for backdrop-based loaders."""

    enabled: bool = SettingsField(True, title="Enabled")

HarmonyLoadPlugins

Bases: BaseSettingsModel

Harmony loader plugins settings.

Source code in server/settings/load_plugins.py
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class HarmonyLoadPlugins(BaseSettingsModel):
    """Harmony loader plugins settings."""

    override_name: str = SettingsField(
        "",
        title="Override container name",
        description=(
            "Optional container name to override the default name for "
            "backdrop loaders (templates, PSD layers).\n"
            "Keys are available in the context of the loader plugin.\n"
            "Example keys: project[name], folder[name], product[name]...\n"
            "Example value: {folder[name]}-{product[name]}"
        ),
    )
    parent_backdrop_matching: bool = SettingsField(
        False,
        title="Parent Backdrop Matching",
        description=(
            "Match loaded content's folder hierarchy to existing scene "
            "backdrops (case-insensitive) and place inside the matching "
            "parent. If no match is found, a new parent backdrop is created "
            "using the most direct folder name."
        ),
    )
    ImageSequenceLoader: ImageSequenceLoaderPluginModel = SettingsField(
        title="Image or Sequence Loader",
        default_factory=ImageSequenceLoaderPluginModel,
    )
    TemplateLoader: BackdropLoaderPluginModel = SettingsField(
        default_factory=BackdropLoaderPluginModel,
        title="Template Loader",
    )
    PsdLoader: BackdropLoaderPluginModel = SettingsField(
        default_factory=BackdropLoaderPluginModel,
        title="Load Photoshop Layers",
    )