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.
fake-bpy-module uses typing module and type hints which are available from Python 3.7. Check your Python version is >= 3.7.
fake-bpy-module can be installed via a pip package, or pre-generated modules. You can also generate and install modules manually.
fake-bpy-module is registered to PyPI.
You can install it as a pip package.
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
If you install fake-bpy-module for Blender latest build (master branch daily build powered by nutti/blender-daily-build), run below command.
pip install fake-bpy-module-latest
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.
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.
You can also generate modules manually. See Generate Module for detail.
See CHANGELOG.md
If you want to report bug, request features or discuss about this add-on, see ISSUES.md.
fake-bpy-module channel is available on blender.chat.
The timely discussion and release announcement about fake-bpy-module will be made in this channel.
Note: Registration of blender.chat is required for accessing fake-bpy-module channel.
If you want to contribute to this project, see CONTRIBUTING.md.
Indie Game/Application Developer.
Especially, I spend most time to improve Blender and Unreal Game Engine via providing the extensions.
Support via GitHub Sponsors
- CONTACTS: Twitter
- WEBSITE: Japanese Only