SETUP.md

Setup

Instructions for setting up the dev environment

Read Original

Pre-reqs:

• VS Code
• Blender

If you are not using Docker

• Python 3.10¹
• Python extension for VS Code (ms-python.python)¹
• Pylance extension for VS Code (ms-python.vscode-pylance)¹

If you are using docker

• Docker²
• Remote Containers extension for VS Code (ms-vscode-remote.vscode-remote-extensionpack)²

Steps

1. Clone the repo

   git clone --recursive https://github.com/bombsquad02420/blender-addon.git
   
   cd blender-addon

2. Install modules for development¹

   pip install -r requirements.txt

3. Install additional modules (for Blender to use)¹

   pip install --target=modules -r requirements.blender.txt

4. Add the repo's root folder (from STEP 1) to Blender's script data path. Edit > Preferences > File Path

   

5. Search for debugger in Add-ons panel and enable the Debugger for VS Code extension. Under the extension's preferences the path (from STEP 3) to debugpy should be auto-detected.

   

6. Make sure the port is 5678 and timeout is set to a large enough value.

7. Search for debugger and start the debugger

   

8. Open repo in VS Code

9. Open in Container²

   Make sure the docker daemon is running and has proper priviledges (user must be added to the docker group. sudo must not be used)

   Click Open in Container in notification prompt

   

   Or use the Command Palette

   

10. In VSCode's Debug Panel (Ctrl + Shift + D), start the debugger (F5) with Python: Blender Attach configuration (or Docker: Blender Attach).

    

11. VSCode's Debug Console and Blender Console should show attached message

    

    

Other Stuff

1. Update submodules¹

   TODO

2. Auto-reload Blender scripts

   TODO

Footnotes

1. Only if not using Docker ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶

2. Only if uusing Docker ↩ ↩² ↩³