Development¶

Requirements¶

Linux or Windows x64
Python 3.9
pdm

Warning

To use different Python version, run pdm use to select the correct python interpreter

Using Pdm¶

Note

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

Preparing virtual environment¶

Install pdm package
```
pip install pdm
```

Create the virtual environment

python -m pip install virtualenv
python -m virtualenv --clear --download .venv
python -m ensurepip
python -m pip install --upgrade pdm
# Enter the virtual Environment
pdm venv activate
# ^ Execute the command this returns with!

Install dependencies
Minimum set of packages for building executable
```
pip install -e .
```
All set of packages including development tools
```
pdm install
```

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.

Windows

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

Linux

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

Documentation¶

Preview the Documentation¶

Windows

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

Linux

Run the shell script file
```
sh .\script\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¶

Windows

Run the batch file
```
.\script\mkdocs_publish.bat
```

Linux

Run the shell script file
```
sh .\script\mkdocs_publish.sh
```