A Substance Painter plugin 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.
- Click on Use this template
- Give a name to your project (e.g.
my_awesome_project
, use all lowercase and underscores separation - Wait until the first run of CI finishes
- For codecov Reports & Automatic Release to PyPI
go tosettings->secrets
add yourPYPI_API_TOKEN
andCODECOV_TOKEN
- Read the file CONTRIBUTING.md
⚠️ WAIT until first CI run on github actions before cloning your new project.
- Then clone your new project and happy coding!
- delete all text above this, and complete the README template below for your project
- This template is in the public domain. Choose a LICENSE for your repo
project_description
- 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"
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"
- enable the plugin in Substance from the Menu
Python/project_name
Read the CONTRIBUTING.md file.