keeeal/openscad-build

A hierarchical OpenSCAD build system in a docker container

OpenSCAD Build

A hierarchical OpenSCAD build system in a docker container.

What openscad-build is:

• A way of structuring a project consisting of multiple OpenSCAD files into subassemblies based on folder structure, with the goal of simplifying large OpenSCAD projects.
• A tool to generate a main.scad file for the project, allowing each part and subassembly to be easily viewed in OpenSCAD.
• A way of specifying which parts to render into STL files, with per-part settings like render quality.

What openscad-build is not:

• A build system which considers each OpenSCAD module to be a part. OpenSCAD Build treats each file as a part. Files may have more than one module.
• A batch exporter for generating multiple STL files per OpenSCAD file with different settings (See OSBS).
• An tool for running OpenSCAD builds in parallel (See OpenSCAD-Parallel-Build).
• An autoplater for 3D printing (See scad-build).
• A download page generator for rendered STL files (See openscad-makefile)
• An OpenSCAD wrapper for Python (See SolidPython) or any other language.

openscad-build's Issues

Add $fn as CLI arg to write-main

Improve nesting in customizer drop-down

Make it look more like https://ascii-tree-generator.com/

Parallelize rendering

Indicate nesting level in customizer drop-down

Something like https://ascii-tree-generator.com/ but in the dropdown menu

The dev container does not need the app installed in it

Dockerfile should look more like

FROM whatever as base
FROM base as app
...
FROM base as dev
...

Generate render logs

Add tags to modules

• renderable (for auto generating render.yaml + warning if not renderable)
• render quality
• preview quality?
• others?

Install as a pip package with a CLI

Rather than copying .py file to /usr/bin and making it executable

Lock requirements

Add pyproject.toml + requirements.txt + requirements-dev.txt

Add type checking

Use mypy

Add arg to render specific part(s)

Improve readme

1. Simplify description of what repo is
2. Getting started

• using docker image
• print help

3. Features

• subassemblies
• generating a main file
• rendering parts

Rendering fails when `main.scad` is not in the subpath of the root dir

Absolute path in `main.scad` broken in docker container

Using an absolute path in a docker container makes no sense when generating a main.scad file on the host.

Add requirements.txt + requirements-dev.txt

Print something to indicate a part is rendering

Add customizer + CLI arg to show/hide details (threads, cogs, etc)

Add docstrings to `openscad-build.py`

Add "this file was generated" warning to main.scad