hannesdelbeke / substance-painter-plugin-template

a template for Substance Painter Python plugins

Substance Painter plugin template

A Substance Painter plugin template.

• e.g. used for https://github.com/plugget/plugget-substance-painter-plugin

What is included on this template?

• a dockable Substance Painter widget
• 📦 A pyproject.toml so you can pip install this plugin.
• 🤖 A Makefile with the most useful commands to install, test, lint, format and release your project.
• 📃 Documentation structure using mkdocs
• 🔄 Continuous integration using Github Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.
  • 💬 Auto generation of change log using gitchangelog to keep a HISTORY.md file automatically based on your commit history on every release.
  • 🧪 Testing structure using pytest
  • ✅ Code linting using flake8
  • 📊 Code coverage reports using codecov
  • 🛳️ Automatic release to PyPI

HOW TO USE THIS TEMPLATE

1. Click on Use this template
2. Give a name to your project (e.g. my_awesome_project, use all lowercase and underscores separation
3. Wait until the first run of CI finishes
4. For codecov Reports & Automatic Release to PyPI
   go to settings->secrets add your PYPI_API_TOKEN and CODECOV_TOKEN
5. Read the file CONTRIBUTING.md

⚠️ WAIT until first CI run on github actions before cloning your new project.

5. Then clone your new project and happy coding!
6. delete all text above this, and complete the README template below for your project
7. This template is in the public domain. Choose a LICENSE for your repo

---

project_name

project_description

Install

install plugin

• Manually copy project_name.py to your plugin folder,
  e.g. C:\Users\USER\OneDrive\Documents\Adobe\Adobe Substance 3D Painter\python\plugins
• or pip install from this repo

pip install --no-dependencies https://github.com/author_name/project_urlname/archive/refs/heads/main.zip --target "C:\Users\USER\OneDrive\Documents\Adobe\Adobe Substance 3D Painter\python\plugins"

install dependencies

download the repo, browse to the folder with the requirements.txt

pip install -r requirements.txt --target "C:\Users\USER\OneDrive\Documents\Adobe\Adobe Substance 3D Painter\python\modules"

Usage

1. enable the plugin in Substance from the Menu Python/project_name

Development

Read the CONTRIBUTING.md file.