DOCUMENTATION

Setup Instructions

Blender Pixels Extensions
Created by Luke Stilson 2022

GETTING STARTED

Prerequisites

This suite of extensions scripts, assets, and templates for use in Blender. BPx has been designed to function correctly on Blender 3.1.0 and later. Blender 3.4.1 is the latest release that is confirmed to be stable with all functions.

Download Blender Here

Access and Source Control

Branch the GitHub repository for best results and continuous updates and improvements. This is also available as a .zip download if you do not have a GitHub account, or would like a local, unchanging copy of the files.

Directory Setup

Before proceeding, make sure files are located in a secure, isolated location (not a Desktop or Downloads folder) Altering, renaming or adding to the contents of anything within the folder structure under the master folder may cause unexpected errors within some tools

Blender Setup

1. Open Blender and verify the version number currently being used via the splash screen.
2. Click Edit > Preferences from the upper toolbar
3. Navigate to File Paths in the preferences window
4. Under Asset Libraries click the + (add asset library)
5. Name this library whatever you’d like and click the folder icon to choose a directory
• This directory must be set to your install location of the Library folder within the bpx folder, this will always end in ‘\Library\’
• If you are using other personal asset libraries, this is fine and should not cause conflicts when adding this library

Now when an asset library window is open, you can use the Library dropdown (by default set to ‘Current File’), and set this to the name of the new library to access included assets.

PYTHON ADDON QUICKSTART

Python files in this file collection are placed in bpx > Library > Resources. Do not move, rename, alter or delete these files or any files in the bpx > Library > Resources > Extensions folder.

Make Modules Accessible By Default

Note: If you currently have a custom startup file, follow instructions below for adding ToolManager to an existing project, then execute step 4 from this list.

1. Find and open startup.blend in the Templates folder
2. Check the checkbox and click Always Allow when prompted upon opening the file
3. In the 3D View Properties Panel UI (keyboard shortcut ‘n’ with mouse in 3D view window), there will be a new tab called ‘tools manager’ - do not make any changes inside the tools manager at this time
4. Select File > Defaults > Save Startup File
5. Close Blender, then reopen and check that the Tools Manager panel is available on a default startup

Add Modules To Existing Projects

If you would like to make scripts accessible to a project you created previously, follow these instructions:

1. In the .blend file you would like to add tools to, set your workspace to ‘Scripting’ via the workspace tabs at the top of the screen
2. Click Text > Open (Alt+O) and navigate in your files to bpx/Library/Resources
3. Select ‘ToolManager’ and click ‘Open’
4. Run the script by pressing Alt+P or clicking the play button next to the name of the script
5. Select Text > Register
6. Change the workspace back to whatever you like
7. Save the file (Ctrl+S)

Note: Registering the text will make this script accessible every time the file is opened.