b0o / blender-addon-template

Blender Add-on Starter Template

Blender Add-on Template

This is a template for creating Blender add-ons. It uses Hatch 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 hatch and run hatch shell to create and activate the virtual environment:

pip install hatch
hatch shell

4. Open your editor and start developing your add-on. (Preferably, start your editor from inside of the virtualenv shell)

• For Neovim, the blender.nvim plugin is recommended.
• For VSCode, the blender_vscode extension is recommended.

5. Build the add-on by running the following command:

./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