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 0290f230d6 doc fixes
2021-07-20 20:53:34 -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 Fix quant docs to point out non-integer quanta are allowed. 2021-07-07 23:28:07 -07:00
tutorials Added cubetruss_support(). 2021-05-21 01:31:16 -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 Removed unnecessary requirement for splinesteps>=3, added some error 2021-07-04 11:25:54 -04:00
arrays.scad Merge remote-tracking branch 'upstream/master' 2021-07-02 11:45:22 +01:00
attachments.scad fix(attachments): utilize font parameter in atext 2021-07-08 23:30:37 -05: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 Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
common.scad Improved regressions error reporting. 2021-06-30 19:56:17 -07:00
constants.scad _UNDEF definition didn't work; moving to constants.scad fixed this. 2021-04-14 16:32:47 -04:00
CONTRIBUTING.md fixed modulated_circle() to work as advertised 2020-12-01 23:56:57 +01:00
coords.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
cubetruss.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
debug.scad Implement vector searches with ball trees and introduces random point generations in debug.scad 2021-06-30 10:55:47 +01:00
distributors.scad Bugfix for line_of() 2021-07-05 20:46:43 -07: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 Doc and formating tweaks, minor code bugs/changes 2021-07-02 11:30:13 +01:00
hingesnaps.scad Re-work to use openscad_docsgen package. 2021-02-19 19:56:43 -08:00
hull.scad cleaning 2021-06-22 04:12:14 +01: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 doc fixes 2021-07-20 20:53:34 -04:00
mutators.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -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 Fixed path_chamfer_and_rounding() default for closed= 2021-07-10 21:39:56 -07: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 Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
rounding.scad Removed unnecessary requirement for splinesteps>=3, added some error 2021-07-04 11:25:54 -04:00
screws.scad Removed range(), rangex(). Added count(). 2021-04-07 20:57:45 -07:00
shapes.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
shapes2d.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07:00
skin.scad Tweaks for docs usage lines. 2021-06-26 20:59:33 -07: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 Added hull.scad to std.scad. 2021-05-23 17:51:14 -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 Tweaks for docs usage lines. 2021-06-26 20:59:33 -07: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 Fixed typo in back() module definition. 2021-07-14 13:50:34 -07:00
triangulation.scad Improved docs gen script for Returns:, Custom:, Includes:, Topics:, and positional/named args spits. 2021-01-05 01:20:01 -08:00
turtle3d.scad vmul() to v_mul(), etc. 2021-06-14 20:28:49 -07:00
vectors.scad Docs link fix. 2021-06-30 17:31:00 -07:00
version.scad Bump release version. 2021-06-21 07:52:42 +00:00
vnf.scad Update vnf_merge 2021-06-30 11:22:48 +01: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