Development¶

Requirements¶

Linux or Windows x64
Python >=3.9, <3.11

Note

All actions should be performed under repository root folder i.e. /Blender-Launcher-V2!

Preparing the virtual environment¶

Create the virtual environment

python -m pip install virtualenv
python -m virtualenv --clear --download .venv

Windows (Powershell)Windows (Cmd)Linux

.\.venv\Scripts\activate.ps1

.\.venv\Scripts\activate

source .venv/bin/activate

Install dependencies
Minimum set of packages for building executableAll packages including development tools
pip install -e .
pip install -e ".[docs,ruff]"

Running Blender Launcher¶

Info

As of (c90f33d), cached Blender-Launcher-V2 files (such as resources_rc.py and global.qss) are no longer included in the source due to them artificially inflating git diffs. In order to generate them, run the build_style.py script located in the root project directory. running Blender Launcher without these being built will result in an error.

python source/main.py

Building Blender Launcher.exe¶

Warning

Executables made in Pyinstaller must be built inside the target platform! You cannot build for a different platform other than your own.

WindowsLinux

Run batch file
```
.\scripts\build_win.bat
```
Look for bundled app under the Blender-Launcher-V2\dist\release folder

Run shell script file
```
sh scripts/build_linux.sh
```
Look for bundled app under the Blender-Launcher-V2/dist/release folder

Documentation¶

Preview the Documentation¶

WindowsLinux

Run the batch file
```
.\scripts\mkdocs_serve.bat
```
Open the Documentation in a web browser.

Run the shell script file
```
sh ./scripts/mkdocs_serve.sh
```
Open the Documentation in a web browser.

Update the Documentation¶

Note

You should never edit the documentation in the gh-pages branch; this branch is used to publish the documentation.

Make the desired modifications in the .md files.

Publish the Documentation¶

Warning

These scripts will only work if you have write access to the Blender-Launcher-V2 repo.

Run the script

WindowsLinux

.\scripts\mkdocs_publish.bat

sh ./script/mkdocs_publish.sh