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 9929e3fff1 doc tweak
2022-01-17 09:39:41 -05:00
.github Fixes for rect(center=) 2021-12-13 16:31:14 -08: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 Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
tests add centering option to move() 2022-01-10 21:23:09 -05:00
tutorials Minor tweaks to Shapes2d tutorital. 2022-01-07 19:31:58 -08:00
.gitignore Setup Problem Matcher. Added some deliberate docs errors to test with. 2021-03-30 15:27:57 -07:00
.openscad_docsgen_rc fix error 2022-01-14 21:55:21 -05:00
.openscad_mdimggen_rc Various documentation fixes. 2021-12-06 14:28:04 -08:00
affine.scad apply tweaks 2021-12-29 17:55:29 -05:00
attachments.scad Merge pull request #752 from adrianVmariano/master 2022-01-09 18:06:14 -08:00
beziers.scad doc tweaks 2022-01-09 09:55:26 -05:00
bosl1compat.scad Improvements for bosl1compat.scad 2021-05-09 16:44:51 -07:00
bottlecaps.scad bugfixes 2022-01-10 22:28:35 -05:00
builtins.scad Added multmatrix(), translate(), rotate(), scale() builtins. 2021-10-05 17:03:15 -07:00
color.scad color stuff moved 2022-01-14 20:31:24 -05:00
comparisons.scad doc tweak 2022-01-17 09:39:41 -05:00
constants.scad fix format call 2022-01-10 20:22:11 -05:00
CONTRIBUTING.md fixed modulated_circle() to work as advertised 2020-12-01 23:56:57 +01:00
coords.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
cubetruss.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
distributors.scad doc tweaks 2022-01-01 22:00:26 -05:00
drawing.scad misc doc fixes and organization 2022-01-07 14:23:01 -05:00
fnliterals.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
gears.scad Added [xyz]move(). Removed affine2d planar returns from transform functions. 2021-12-31 15:22:13 -08:00
geometry.scad hide is_polygon_on_list 2022-01-10 19:55:54 -05:00
hingesnaps.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
joiners.scad misc doc fixes and organization 2022-01-07 14:23:01 -05:00
knurling.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -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
linalg.scad strings reorg 2022-01-10 19:46:51 -05:00
linear_bearings.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
lists.scad bugfixes 2022-01-07 14:56:31 -05:00
masks2d.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
masks3d.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
math.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
metric_screws.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
modular_hose.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
mutators.scad colors and 2d rounding flee mutators.scad 2022-01-14 20:31:02 -05:00
nema_steppers.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
partitions.scad move half-space stuff to partitions.scad 2021-12-16 22:31:49 -05:00
paths.scad misc doc fixes and organization 2022-01-07 14:23:01 -05:00
polyhedra.scad improve polyhedron child alignment to face edge 2021-12-29 18:21:12 -05:00
quaternions.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
README.md Update README.md 2021-04-13 15:16:06 -07:00
regions.scad move linear_sweep and spiral_sweep to skin.scad 2022-01-10 21:00:39 -05:00
rounding.scad doc tweaks 2022-01-09 09:55:26 -05:00
screw_drive.scad Minor tweaks to Shapes2d tutorital. 2022-01-07 19:31:58 -08:00
screws.scad strings reorg 2022-01-10 19:46:51 -05:00
shapes2d.scad colors and 2d rounding flee mutators.scad 2022-01-14 20:31:02 -05:00
shapes3d.scad Added a better usage example for onion() 2022-01-13 19:26:45 -08:00
skin.scad bugfix 2022-01-10 21:50:32 -05:00
sliders.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
std.scad colors and 2d rounding flee mutators.scad 2022-01-14 20:31:02 -05:00
strings.scad strings reorg 2022-01-10 19:46:51 -05:00
structs.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
threading.scad move linear_sweep and spiral_sweep to skin.scad 2022-01-10 21:00:39 -05:00
transforms.scad add centering option to move() 2022-01-10 21:23:09 -05:00
trigonometry.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
turtle3d.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
utility.scad improve file summaries 2022-01-14 22:33:21 -05:00
vectors.scad improve file summaries 2022-01-14 22:33:21 -05:00
version.scad Lots of docs tweaks for openscad-docsgen v2 2021-12-13 15:48:30 -08:00
vnf.scad debug function rename 2022-01-08 23:08:34 -05:00
walls.scad Merge branch 'master' of github.com:revarbat/BOSL2 into revarbat_dev 2021-12-13 15:51:06 -08:00
wiring.scad change wiring radius to use round_corners instead of beziers 2022-01-07 12:47:18 -05:00
WRITING_DOCS.md Updated WRITING_DOCS.md 2021-12-26 20:30: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