mesh2brick 0.1.0

Convert a 3D object into a brick structure.

mesh2brick

mesh2brick is a utility package for converting an input mesh file into a brick structure in JSON, text, or LDraw format.

Usage

Standalone project

To use as a standalone project, first install the package manager uv. Then, clone the repository:

git clone https://github.com/K1ngHungry/mesh2brick.git
cd mesh2brick

Finally, run the mesh2brick script with the following command. uv automatically installs all dependencies upon running.

uv run mesh2brick [INPUT_MESH_FILE] [OUTPUT_BRICK_FILE]

The [INPUT_MESH_FILE] can be any mesh format (.obj, .glb, etc.).

The [OUTPUT_BRICK_FILE] should end in .json, .txt, or .ldr to specify one of the following three output formats:

• JSON. The output JSON maps a 1-based sequence number to each brick. Each brick has the following keys:
  • brick_id: A number indicating the brick type. See brick_library.json for a list of brick types.
  • x, y, z: The coordinates of the brick in 3D space.
  • type: 0 for a regular brick/plate, 1 for a slope brick.
  • rotation: 0–3, indicating the orientation of the brick (90° increments).
• Text. The output text file is a list of bricks, one per line, with the following format: T{type} {l}x{w}x{h} R{rotation} (x,y,z), where type is the brick type (0=brick/plate, 1=slope), l, w, h are the brick dimensions along the x-, y-, and z-axes, rotation is the orientation (0–3), and (x,y,z) are the coordinates of the brick in 3D space.
• LDraw. The output LDraw file can be used directly with LDraw-compatible software to visualize the brick structure.

Run uv run mesh2brick --help to see all available options.

Python package

To install mesh2brick as a package in an existing project, run:

pip install mesh2brick

if using pip, or

uv add mesh2brick

if using uv.

Then, you can use the mesh2brick module in your Python code:

from mesh2brick import Mesh2Brick

input_file = "path/to/your/input_mesh.obj"
mesh2brick = Mesh2Brick()
output_bricks = mesh2brick(input_file)