Creazione di pacchetti di plug-in

Contenuto del pacchetto del plug-in

I pacchetti sono un singolo file, internamente un archivio zip, contenente un file pluginInfo.json con metadati sul plug-in.

il codice del plug-in e tutti gli altri file o risorse necessari al funzionamento del plug-in.

Voci PluginInfo.json:

Ingresso
Descrizione
Valore predefinito
Note
metadata_format_version
Formato del file di metadati.
1
Obbligatorio.Attualmente deve essere impostato su 1.
nome
Il nome del plug-in.
Obbligatorio.Deve corrispondere al nome del modulo Python contenente il codice del plug-in
versione
La versione del plug-in.
Facoltativo.
autore
Autore del plug-in.
Facoltativo.
email
E-mail dell’autore del plug-in.
Facoltativo.
min_designer_version
Versione minima dell’applicazione richiesta dal plug-in per funzionare.
2019.2
Facoltativo.
piattaforma
Piattaforma su cui viene eseguito il plug-in.
qualsiasi
Facoltativo.Per i plug-in contenenti codice compilato, questa voce può essere utilizzata per disabilitare il plug-in in piattaforme non supportate.Valori possibili: win, linux, osx, any.

Creazione di un nuovo progetto di pacchetto di plug-in

Forniamo un progetto modello Cookiecutter per semplificare la creazione di progetti pacchetto di plug-in.

Potete usarlo direttamente o modificarlo per le vostre esigenze.

Il modello si trova nella directory dell’applicazione, in plugin/tools/pkgplugintemplate.

  1. Installare Python, se non è già installato nel sistema

    Cookiecutter è compatibile sia con Python 2 che Python 3

  2. Installa Cookecutter se non ne sei già provvisto

    Di solito questo può essere fatto usando pip:

    code language-none
    pip install cookiecutter
    

    Per ulteriori informazioni sui metodi alternativi di installazione di Cookiecutter o per ulteriori informazioni su Cookiecutter, consultare la documentazione all’indirizzo https://cookiecutter.readthedocs.io/en/latest/installation.html

  3. Crea un nuovo progetto di pacchetto di plug-in

    In un’esecuzione della finestra del terminale:

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

    Compilate le informazioni richieste. Il nuovo progetto verrà creato nella directory specificata.

  4. Creare un pacchetto del plug-in una volta completato lo sviluppo

    In un’esecuzione della finestra del terminale:

    code language-none
    python makepackage.py
    
  5. Il pacchetto del plug-in verrà generato nella directory di compilazione

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