https://github.com/b0o/blender-addon-template
Blender Add-on Starter Template
https://github.com/b0o/blender-addon-template
blender blender-addon blender-python
Last synced: 4 months ago
JSON representation
Blender Add-on Starter Template
- Host: GitHub
- URL: https://github.com/b0o/blender-addon-template
- Owner: b0o
- License: gpl-2.0
- Created: 2024-04-05T10:31:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-12T10:08:57.000Z (7 months ago)
- Last Synced: 2024-10-29T11:13:23.290Z (6 months ago)
- Topics: blender, blender-addon, blender-python
- Language: Python
- Homepage:
- Size: 22.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blender Add-on Template
This is a template for creating Blender add-ons. It uses [uv](https://github.com/astral-sh/uv) to manage dependencies and virtual environments.
## Instructions
1. Change names and info in the following files (don't forget the copyright hearders):
- `pyproject.toml` (including the path in the `[tool.hatch.version]` section)
- `my_addon/__init__.py`
- `my_addon/auto_load.py` (copyright header only)
- `my_addon/panel_mypanel.py`
2. Rename the `my_addon` directory to the name of your add-on. It should match the name in `pyproject.toml`
3. Install [uv](https://github.com/astral-sh/uv) and run `uv sync` to initialize the virtual environment and install the dependencies:
```bash
uv sync
```
4. Activate the virtual environment:
```bash
source .venv/bin/activate
```
5. Open your editor and start developing your add-on. (Preferably, start your editor from inside of the virtualenv shell)
- For Neovim, the [`blender.nvim`](https://github.com/b0o/blender.nvim) plugin is recommended.
- For VSCode, the [`blender_vscode`](https://github.com/JacquesLucke/blender_vscode) extension is recommended.
6. Build the add-on by running the following command:
```bash
./scripts/build.sh
```
This will create a zip file in the `dist` directory.
## License
Blender Add-on Template © 2024 Maddison Hellstrom
GNU General Public License v2.0 or later