Fake Blender Python API module collection: fake-bpy-module
fake-bpy-module is the collections of the fake Blender Python API modules for
the code completion in commonly used IDEs.
Note: The similar project for Blender Game Engine (BGE) is available on
fake-bge-module which targets
UPBGE.
To realize the long support of this project, your support is helpful.
You can support the development of this project via
GitHub Sponsors.
See the contribution document for the detail of
the support.
Requirements
fake-bpy-module uses typing module and type hints which are available from
Python 3.8. Check your Python version is >= 3.8.
Install
fake-bpy-module can be installed via a pip package, or pre-generated modules.
You can also generate and install modules manually.
Install via pip package
fake-bpy-module is registered to PyPI.
You can install it as a pip package.
Install a latest package
If you install fake-bpy-module for Blender latest build (main branch daily
build powered by nutti/blender-daily-build),
run below command.
pip install fake-bpy-module
or, specify version "latest".
pip install fake-bpy-module-latest
Install a version specific package
If you want to install a version specific package, run below command.
pip install fake-bpy-module-<version>
If you install fake-bpy-module for Blender 2.93, run below command.
pip install fake-bpy-module-2.93
Note: For PyCharm users, change the value idea.max.intellisense.filesize
in
idea.properties
file to more than 2600 because some modules have the issue of
being too big for intelliSense to work.
Supported Blender Version
Install via pre-generated modules
Download Pre-generated modules from Release page.
The process of installation via pre-generated modules is different by IDE.
See the installation processes as follows for detail.
Generate Modules Manually
You can also generate modules manually.
See Generate Module for detail.
Change Log
See CHANGELOG.md
Bug report / Feature request / Disscussions
If you want to report bug, request features or discuss about this project, see
ISSUES.md.
fake-bpy-module channel is
available on the Discord server.
The timely discussion and release announcement about fake-bpy-module will be
made in this channel.
Contribution
If you want to contribute to this project, see CONTRIBUTING.md.
Project Authors
Owner
@nutti
Indie Game/Application Developer.
Especially, I spend most time to improve Blender and Unreal Game Engine via
providing the extensions.
Support via GitHub Sponsors
Contributors