BlockBuilder

BlockBuilder is an open-source Python application to build, edit and visualize user-created sets of blocks (or voxels). The software is lightweight and highly configurable and there is a particular emphasis on robustness and performance. The user interface is built to be modern, minimalist and intuitive.

Installation

To install the latest stable version of BlockBuilder, you can use pip in a terminal:

pip install -U blockbuilder

To create an environment with BlockBuilder installed, you can use conda in a terminal:

conda env create -f environment.yml

This should create a new environment called blockbuilder.

Although both PyQt5 and PySide2 are supported, BlockBuilder does not install Python bindings for Qt by default. At least one of these two packages should be installed but this choice is made by the user. Take a look at the dependencies section to see the tested versions.

Get the latest code

The latest changes are available here.

To install the latest version of the code using pip, open a terminal and type:

pip install -U https://github.com/GuillaumeFavelier/blockbuilder/archive/master.zip

To get the latest code using git, open a terminal and type:

git clone git://github.com/GuillaumeFavelier/blockbuilder.git

Usage

To launch BlockBuilder once it is installed, it is as easy as using:

blockbuilder

Or from the source code using the standard starting script:

script/blockbuilder

More details about the features are available in the Wiki.

Dependencies

The minimum required dependencies to run BlockBuilder are:

• numpy>=1.18.5
• vtk>=8.1.2
• qtpy>=1.9.0
• PyQt5>=5.14.2 or PySide2>=5.14.2

Resources

Many of the icons used in this project come from material.io

Licensing

BlockBuilder is BSD-licenced (3 clause):

BSD 3-Clause License

Copyright (c) 2020, Guillaume Favelier
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.