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. Enter the author, version, Blender target, license, and description.
  4. Select the Python environment you wish to use (UV is recommended as future plugin integration will be focused on UV)
  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, initiate Git Repository, and include example code.
  7. Create the project.

Notes:

  • The add-on ID must be a valid Python module name, meaning no special characters and _ instead of spaces and -. The Plugin will automatically generate a valid ID from the name and warn of invalid IDs.
  • 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

The selected target is used during project creation; it is not stored as a Project Blender Manager setting.