Comment créer le plugin Python de Substance Painter (Introduction)

À partir de Substance Painter 2020.1 (6.1.0), l'API Python a été ajoutée en plus de l'API JavaScript traditionnelle.

[Note de publication de Substance Painter Version 2020 \ .1 \ (6 \ .1 \ .0 ) - Born Digital Support](https://support.borndigital.co.jp/hc/ja/articles/900000700626-Substance-Painter -Version-2020-1-6-1-0-% E3% 83% AA% E3% 83% AA% E3% 83% BC% E3% 82% B9% E3% 83% 8E% E3% 83% BC% E3% 83% 88)

Cependant, la documentation officielle n'a pas encore mentionné l'existence de l'API Python. Il était difficile de savoir par où commencer, alors ne notez que l'entrée.

À partir du SP 2020.2, la version de l'API Python est 0.0.2. Veuillez noter que le contenu de cet article est susceptible de devenir bientôt obsolète.

Emplacement de la référence de l'API Python

• Cliquez sur Aide> Documentation> API Python dans la barre de menu de l'application pour ouvrir un fichier HTML local
• Pour Windows, le chemin réel est C: \ Program Files \ Allegorithmic \ Substance Painter \ resources \ python-doc \ index.html
• Pour une raison quelconque, il n'est pas publié en ligne
• Similaire à l'API JavaScript
• J'ai des ennuis parce que je ne peux pas google ...

Emplacement du script

• _ "Python> Plugin Folder" _ ouvre le dossier dans lequel le plugin est enregistré
• Pour Windows, C: \ Users \ <NOM D'UTILISATEUR> \ Documents \ Allegorithmic \ Substance Painter \ python \ plugins
• Placez les fichiers .py directement sous les plugins /
• Non chargé même s'il est placé dans un sous-dossier

Console Python

• _ "Windows> Vues> Console Python" _ pour afficher la fenêtre de la console
• Par exemple, vous pouvez voir la référence avec la commande suivante
• Les caractères sont plutôt petits, vous devriez donc regarder la référence HTML

#Module de charge
import substance_painter

#Afficher la description du module
help(substance_painter)

#Afficher la description du module de projet
help(substance_painter.project)

Tutoriel pour créer un plug-in simple

Créez plugins / hello_plugin.py avec le contenu suivant.

"""The hello world of python scripting in Substance Painter
"""

from PySide2 import QtWidgets
import substance_painter.ui

plugin_widgets = []
"""Keep track of added ui elements for cleanup"""

def start_plugin():
    """This method is called when the plugin is started."""
    # Create a simple text widget
    hello_widget = QtWidgets.QTextEdit()
    hello_widget.setText("Hello from python scripting!")
    hello_widget.setReadOnly(True)
    hello_widget.setWindowTitle("Hello Plugin")
    # Add this widget as a dock to the interface
    substance_painter.ui.add_dock_widget(hello_widget)
    # Store added widget for proper cleanup when stopping the plugin
    plugin_widgets.append(hello_widget)

def close_plugin():
    """This method is called when the plugin is stopped."""
    # We need to remove all added widgets from the UI.
    for widget in plugin_widgets:
        substance_painter.ui.delete_ui_element(widget)
    plugin_widgets.clear()

if __name__ == "__main__":
    start_plugin()

Analysez à nouveau les dossiers avec _ "Python> Reload Plugin Folders" _.

Il y a un élément appelé _ "Python> bonjour \ _plugin" _, alors cliquez dessus.

Si un widget (volet) appelé "HELLO PLUGIN" est créé à l'écran, il réussit.

Autres suppléments

• Depuis le 30 juillet 2020, les plug-ins Python ne sont pas partagés sur le site officiel de partage de plug-ins.
  • Substance Share « The Free Exchange Platform »
• Il y a peu de JavaScripts en premier lieu, et la plupart d'entre eux sont anciens
• Le plug-in Painter n'est-il pas du tout populaire?
• La motivation pour écrire un plug-in était que c'était très ennuyeux de recharger depuis _ "Edition> Configuration du projet ..." _ chaque fois que je changeais le maillage, mais apparemment il y a une API à recharger. Je ne semble pas. Pourquoi ne pas y arriver! : rage:
• Les requêtes sont également rassemblées → Bouton de rechargement du maillage . - Commentaires