Skip to content

Create a Blender project

The Blender Project generator creates a Python project with Blender-specific metadata, dependencies, and source files.

  1. Open PyCharm’s New Project wizard and select Blender Project.
  2. Choose an add-on or extension project.
  3. Select the Python environment using PyCharm’s native environment controls.
  4. Enter the author, version, Blender target, license, and description.
  5. For an extension, review the add-on ID, compatibility range, tags, website, and permission reasons under Advanced Settings.
  6. Choose whether to install Blender API stubs and include example code.
  7. Create the project.

The add-on ID must be a valid Python module name. Website fields require an https:// URL, and the maximum Blender version cannot be lower than the minimum.

Every project receives a src source root, src/__init__.py, pyproject.toml, and GPL LICENSE. When Git is initialized, the generator also creates .gitignore and README.md.

Extension projects additionally receive blender_manifest.toml with the metadata and permissions entered in the wizard.

The optional stub installer adds the version-matched fake-bpy-module package to the selected interpreter and records it in the dev dependency group in pyproject.toml.

Blender target Stub requirement
4.2 fake-bpy-module-4.2
4.5 fake-bpy-module-4.5
5.2 fake-bpy-module-latest

When you change the target Blender version in Project Blender Manager, use Update Blender API Stubs to replace the previous package and update pyproject.toml.