Setting Up the Build Environment

Last Built: Apr 27, 2021

Previous topic Next topic
Addon Development Setup Downloading the Source Code

Setting Up the Build Environment

Warning

The following instructions are currently a work in progress.

Create a Workspace

First, create a directory to be used as your coding directory.

  • C:\Users\<username>\workspace (Vista/Win 7/Win 10).

  • C:\Documents and Settings\<username>\workspace (XP).

  • /home/<username>/workspace (Linux).

Source Code

Once you have created the directories, time to grab the source code. See source code to setup source control and download the code repositories. You will also need to download buildenv, it used to manage dependencies, needs to be updated for Linux platforms. —————— Install Python 3.7 ——————

Windows

  1. Download Python 3.

  2. Pick the installer appropriate for your platform, and follow the instructions.

  3. Use the default install location. (recommended)

Fedora

sudo yum install python3.7

Ubuntu .. code-block:: shell

sudo apt-get install python3-minimal

Note

This is installed by default on verions 14.04 or later

Environment Variables

Windows

set BLENDER_ADDONS_DIR=<path_to_blender_addons>
set BLENDER_HOME=<path_to_blender_exe>

Linux

set -X BLENDER_ADDONS_DIR=<path_to_blender_addons>
BLENDER_HOME="<path_to_blender_executable>"

Mac

export BLENDER_ADDONS_DIR="/Users/<user>/Library/Application Support/Blender/2.82/scripts/addons"
export BLENDER_HOME="/Applications/Blender.app/Contents/MacOS"

Install Blender

See user docs. Alternatively, you can build Blender from source Building Blender from Source

Install Develop Dependencies

Using the provided script:

The script will install developer dependencies in the install directory. This enables debug support and nose documentation.

Windows (run in buildenv)

install_deps.bat

Linux

install_deps.sh

Using software management:

Ubuntu

Run the following in a Bash terminal:

sudo apt-get install python3-nose python3-sphinx

Fedora

Note

Use yum or dnf, whichever is appropriate for your release of Fedora

sudo [yum|dnf] install python3-nose python3-sphinx

Check Installation

To verify everything is installed correctly, start Blender, open the internal Python console, and type:

import sphinx
import nose

You should not get any import errors.