Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hannesdelbeke/substance-painter-plugin-template
a template for Substance Painter Python plugins
https://github.com/hannesdelbeke/substance-painter-plugin-template
painter pipeline plugin python substance techart template tool
Last synced: 2 days ago
JSON representation
a template for Substance Painter Python plugins
- Host: GitHub
- URL: https://github.com/hannesdelbeke/substance-painter-plugin-template
- Owner: hannesdelbeke
- Created: 2023-10-24T10:46:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-18T10:44:28.000Z (3 months ago)
- Last Synced: 2025-02-02T00:31:41.263Z (14 days ago)
- Topics: painter, pipeline, plugin, python, substance, techart, template, tool
- Language: Makefile
- Homepage:
- Size: 61.5 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# 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](pyproject.toml) so you can pip install this plugin.
- 🤖 A [Makefile](Makefile) with the most useful commands to install, test, lint, format and release your project.
- 📃 Documentation structure using [mkdocs](http://www.mkdocs.org)
- 🔄 Continuous integration using [Github Actions](.github/workflows/) 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](https://docs.pytest.org/en/latest/)
- ✅ Code linting using [flake8](https://flake8.pycqa.org/en/latest/)
- 📊 Code coverage reports using [codecov](https://about.codecov.io/sign-up/)
- 🛳️ Automatic release to [PyPI](https://pypi.org)
### HOW TO USE THIS TEMPLATE
1. Click on **[Use this template](https://github.com/hannesdelbeke/substance-painter-plugin-template/generate)**
3. 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](https://about.codecov.io/sign-up/) Reports & Automatic Release to [PyPI](https://pypi.org)
go to `settings->secrets` add your `PYPI_API_TOKEN` and `CODECOV_TOKEN`
4. Read the file [CONTRIBUTING.md](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
[](https://codecov.io/gh/author_name/project_urlname)
[](https://github.com/author_name/project_urlname/actions/workflows/main.yml)
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
```bash
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`
```bash
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](CONTRIBUTING.md) file.