The Belfry OpenScad Library, v2.0. An OpenSCAD library of shapes, masks, and manipulators to make working with OpenSCAD easier. BETA
Find a file
Adrian Mariano 2494de9368 reordering and moving for improved docs
removed xxrot and xxflip
2021-09-11 18:48:23 -04:00
.github Added tabs code check. 2021-06-22 19:44:47 -07:00
examples Verified examples scadfiles. 2021-05-10 23:26:35 -07:00
images Added logo to README. 2020-12-30 15:44:17 -08:00
scripts Correct for GNU grep syntax. 2021-06-22 19:53:33 -07:00
tests reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
tutorials Tweak color cubes in Mutators tutorial. 2021-07-30 13:40:12 -07:00
.gitignore Setup Problem Matcher. Added some deliberate docs errors to test with. 2021-03-30 15:27:57 -07:00
.openscad_gendocs_rc Added hull.scad to std.scad. 2021-05-23 17:51:14 -07:00
affine.scad Move affine3d_frame_map to transforms.scad and rename to frame_map. 2021-09-06 18:07:03 -04:00
arrays.scad fix permutation docs 2021-09-09 18:32:58 -04:00
attachments.scad Small docs link fix in attachments.scad. 2021-09-11 02:33:28 -07:00
beziers.scad Removed unnecessary requirement for splinesteps>=3, added some error 2021-07-04 11:25:54 -04:00
bosl1compat.scad Improvements for bosl1compat.scad 2021-05-09 16:44:51 -07:00
bottlecaps.scad fix permutation docs 2021-09-09 18:32:58 -04:00
common.scad Doc error in common.scad for no_module 2021-09-06 19:46:18 -04:00
constants.scad fix permutation docs 2021-09-09 18:32:58 -04:00
CONTRIBUTING.md fixed modulated_circle() to work as advertised 2020-12-01 23:56:57 +01:00
coords.scad Move affine3d_frame_map to transforms.scad and rename to frame_map. 2021-09-06 18:07:03 -04:00
cubetruss.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
debug.scad fix doc errors 2021-09-07 22:49:15 -04:00
distributors.scad move path_spread to distributors 2021-09-07 19:00:28 -04:00
edges.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
fnliterals.scad Added more fnliterals 2021-07-04 17:02:48 -07:00
gears.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
geometry.scad reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
hingesnaps.scad Re-work to use openscad_docsgen package. 2021-02-19 19:56:43 -08:00
hull.scad fix tests, rename in_front_of_plane to above_plane 2021-09-10 18:16:42 -04:00
joiners.scad Modified $overlap to default to zero and made some tweaks to clips and 2021-05-16 20:29:04 -04:00
knurling.scad Corrected knurling.scad Includes. 2021-01-05 01:54:15 -08:00
LICENSE Updated copyright years. Split math.scad up. Enabled attach for lots of shapes. Removed backwards compatability. 2019-04-19 17:02:17 -07:00
linear_bearings.scad Fixes for various example bugs. 2021-03-16 14:46:11 -07:00
masks.scad Bugfix for rounding in cylinder_mask() 2021-03-16 23:31:11 -07:00
math.scad Fix quant docs to point out non-integer quanta are allowed. 2021-07-07 23:28:07 -07:00
metric_screws.scad Added docs Aliases. Fixed repeat of screw() 2021-02-24 14:09:11 -08:00
modular_hose.scad modular hose doc fix 2021-08-30 06:19:35 -04:00
mutators.scad Sped up HSV() slightly. 2021-07-30 13:38:25 -07:00
nema_steppers.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
partitions.scad Added missing 'children()' call. 2021-06-28 18:07:29 -07:00
paths.scad fix permutation docs 2021-09-09 18:32:58 -04:00
phillips_drive.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
polyhedra.scad vmul() to v_mul(), etc. 2021-06-14 20:28:49 -07:00
primitives.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
quaternions.scad Rename quaternion functions to not have uppercase names. 2021-06-12 17:17:05 -07:00
queues.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
README.md Update README.md 2021-04-13 15:16:06 -07:00
regions.scad reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
rounding.scad reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
screws.scad comment example 2021-08-27 23:15:17 -04:00
shapes.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
shapes2d.scad remove modulate_circle, move jitter_poly to shapes2d, 2021-09-07 18:47:08 -04:00
skin.scad reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
sliders.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
stacks.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
std.scad Moved trig functions to trigonometry.scad 2021-09-11 02:29:07 -07:00
strings.scad Improved regressions error reporting. 2021-06-30 19:56:17 -07:00
structs.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
threading.scad Move affine3d_frame_map to transforms.scad and rename to frame_map. 2021-09-06 18:07:03 -04:00
torx_drive.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
transforms.scad reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
triangulation.scad Fix bug where polygon_normal and plane_from_polygon sometimes give a 2021-09-11 16:42:40 -04:00
trigonometry.scad Tweaks to trig docs. 2021-09-11 02:51:21 -07:00
turtle3d.scad Move affine3d_frame_map to transforms.scad and rename to frame_map. 2021-09-06 18:07:03 -04:00
vectors.scad reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
version.scad Bump release version. 2021-06-21 07:52:42 +00:00
vnf.scad reordering and moving for improved docs 2021-09-11 18:48:23 -04:00
walls.scad Fix for issue #581 2021-06-22 20:04:33 -07:00
wiring.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
WRITING_DOCS.md Rework of docs for transforms.scad and affine.scad. Fix for #439. 2021-02-26 13:07:11 -08:00

BOSL2

BOSL2 Logo

The Belfry OpenScad Library, v2

A library for OpenSCAD, filled with useful tools, shapes, masks, math and manipulators, designed to make OpenSCAD easier to use.

  • NOTE: BOSL2 IS BETA CODE. THE CODE IS STILL BEING REORGANIZED.
  • NOTE2: CODE WRITTEN FOR BOSLv1 PROBABLY WON'T WORK WITH BOSL2!

Join the chat at https://gitter.im/revarbat/BOSL2 BOSL2 Docs

Installation

  1. Download the .zip or .tar.gz release file for this library.
  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 for your platform:
    • Windows: My Documents\OpenSCAD\libraries\
    • Linux: $HOME/.local/share/OpenSCAD/libraries/
    • Mac OS X: $HOME/Documents/OpenSCAD/libraries/
  5. Restart OpenSCAD.

Examples

A lot of the features of this library are to allow shorter, easier-to-read, intent-based coding. For example:

BOSL2/transforms.scad Examples Raw OpenSCAD Equivalent
up(5) translate([0,0,5])
xrot(30,cp=[0,10,20]) translate([0,10,20]) rotate([30,0,0]) translate([0,-10,-20])
xcopies(20,n=3) for (dx=[-20,0,20]) translate([dx,0,0])
zrot_copies(n=6,r=20) for (zr=[0:5]) rotate([0,0,zr*60]) translate([20,0,0])
skew_xy(xa=30,ya=45) multmatrix([[1,0,tan(30),0],[0,1,tan(45),0],[0,0,1,0],[0,0,0,1]])
BOSL2/shapes.scad Examples Raw OpenSCAD Equivalent
cube([10,20,30], anchor=BOTTOM); translate([0,0,15]) cube([10,20,30], center=true);
cuboid([20,20,30], fillet=5); minkowski() {cube([10,10,20], center=true); sphere(r=5, $fn=32);}
prismoid([30,40],[20,30],h=10); hull() {translate([0,0,0.005]) cube([30,40,0.01], center=true); translate([0,0,9.995]) cube([20,30,0.01],center=true);}
xcyl(l=20,d=4); rotate([0,90,0]) cylinder(h=20, d=4, center=true);
cyl(l=100, d=40, fillet=5); translate([0,0,50]) minkowski() {cylinder(h=90, d=30, center=true); sphere(r=5);}

Documentation

The full library docs can be found at https://github.com/revarbat/BOSL2/wiki