DokumentationSubstance 3DSubstance 3D Designer

Plug-ins verpacken

Letzte Aktualisierung: 26. August 2026

Inhalt des Plug-In-Pakets

Pakete sind eine einzelne Datei, intern ein Zip-Archiv, die eine Datei pluginInfo.json mit Metadaten zum Plug-in enthält.

den Plug-in-Code und alle anderen Dateien oder Ressourcen, die das Plug-in benötigt, um zu funktionieren.

PluginInfo.json-Einträge:

Eintrag
Beschreibung
Standardwert
Anmerkungen
metadata_format_version
Das Format der Metadatendatei.
1
Erforderlich. Derzeit muss auf 1 gesetzt werden.
Name
Der Name des Plug-ins.
Erforderlich. Der Name des Python-Moduls, das den Plug-In-Code enthält, muss übereinstimmen.
Version
Die Plug-in-Version.
Optional.
Autorin
Der Autor des Plug-ins.
Optional.
email
Die E-Mail des Plug-in-Autors.
Optional.
min_designer_version
Die Mindestversion der Anwendung, die für das Plug-in erforderlich ist, um zu funktionieren.
2019.2
Optional.
Plattform
Plattform, auf der das Plug-in ausgeführt wird.
alle
Optional. Bei Plug-ins, die kompilierten Code enthalten, kann dieser Eintrag verwendet werden, um das Plug-in auf nicht unterstützten Plattformen zu deaktivieren.Mögliche Werte: win, linux, osx, any.

Erstellen eines neuen Plug-in-Paketprojekts

Wir stellen ein Cookiecutter-Vorlagenprojekt bereit, um die Erstellung von Plug-In-Paketprojekten zu vereinfachen.

Sie können sie direkt verwenden oder an Ihre eigenen Anforderungen anpassen.

Die Vorlage befindet sich im Anwendungsverzeichnis unter plugins/tools/pkgplugintemplate.

  1. Installieren Sie Python, wenn es nicht bereits auf Ihrem System installiert ist

    Cookiecutter ist sowohl mit Python 2 als auch mit Python 3 kompatibel

  2. Cookiecutter installieren, wenn Sie es noch nicht haben

    Normalerweise kann dies mit pip erfolgen:

    code language-none 
    pip install cookiecutter

    Für alternative Möglichkeiten zur Installation von Cookiecutter oder für weitere Informationen über Cookiecutter können Sie die Dokumentation unter https://cookiecutter.readthedocs.io/en/latest/installation.html überprüfen.

  3. Neues Plug-In-Paketprojekt erstellen

    Führen Sie in einem Terminalfenster Folgendes aus:

    code language-none 
    cookiecutter path/to/pkgplugintemplate -o path/to/new/project

    Füllen Sie die erforderlichen Informationen aus. Das neue Projekt wird im angegebenen Verzeichnis erstellt.

  4. Nach Abschluss der Entwicklung das Plug-in verpacken

    Führen Sie in einem Terminalfenster Folgendes aus:

    code language-none 
    python makepackage.py

  5. Das Plug-in-Paket wird im Buildverzeichnis generiert.

recommendation-more-help
substance-3d-designer-help-guide