Home

Belfry OpenSCAD Library v2

Documentation Indices

• Index by File (Table of Contents)
• Index by Function/Module Name
• Index by Topic
• Usage Cheat Sheet
• List of Tutorials

Terminology

For purposes of these library files, the following terms apply:

• Left: Towards X–

• Right: Towards X+

• Front/Forward: Towards Y–

• Back/Behind: Towards Y+

• Bottom/Down/Below: Towards Z–

• Top/Up/Above: Towards Z+

• Vector: A list of finite numbers.

• Coordinate / Vertex: A 2 or 3 element vector representing a point in 2D or 3D space.

• Path: A list of connected coordinates, either all 2D or all 3D.

• Polygon: A closed Path whose last segment is between the last point and the first point.

• Region: A list of non-crossing 2D polygons which describes a set of perimeters with possible holes.

• VNF: A 2-item list of Vertices 'N' Faces, which provides an easier way to construct a polyhedron() in parts.

Installation

1. Download the .zip or .tar.gz release file for this library. Currently you should be able to find this at https://github.com/BelfrySCAD/BOSL2/archive/refs/heads/master.zip
2. Unpack it. Make sure that you unpack the whole file structure. Some zipfile unpackers call this option "Use folder names". It should create either a BOSL-v2.0 or BOSL2-master directory with the library files within it. You should see "examples", "scripts", "tests", and other subdirectories.
3. Rename the unpacked main directory to BOSL2.
4. Move the BOSL2 directory into the apropriate OpenSCAD library directory. The library directory may be on the list below, but for SNAP or other prepackaged installations, it is probably somewhere else. To find it, run OpenSCAD and select Help→Library Info, and look for the entry that says "User Library Path". This is your default library directory. You may choose to change it to something more convenient by setting the environment variable OPENSCADPATH. Using this variable also means that all versions of OpenSCAD you install will look for libraries in the same location.
   • Windows: My Documents\OpenSCAD\libraries\
   • Linux: $HOME/.local/share/OpenSCAD/libraries/
   • Mac OS X: $HOME/Documents/OpenSCAD/libraries/
5. Restart OpenSCAD.

Other Libraries that Synergize with BOSL2

• Pathbuilder – SVG path string parsing.
• Attachable Text3d - FontMetrics aware attachable text for BOSL2.
• JL_SCAD - A Library to make enclosures for electronics projects, with BOSL2.