{"id":13570302,"url":"https://github.com/revarbat/BOSL","last_synced_at":"2025-04-04T06:32:18.428Z","repository":{"id":23452392,"uuid":"99049902","full_name":"revarbat/BOSL","owner":"revarbat","description":"The Belfry OpenScad Library - A library of tools, shapes, and helpers to make OpenScad easier to use.","archived":false,"fork":false,"pushed_at":"2023-02-20T02:52:25.000Z","size":416,"stargazers_count":557,"open_issues_count":6,"forks_count":62,"subscribers_count":22,"default_branch":"master","last_synced_at":"2024-11-05T02:36:25.964Z","etag":null,"topics":["3d-printing","openscad","openscad-library","scad","stl"],"latest_commit_sha":null,"homepage":"https://github.com/revarbat/BOSL/wiki","language":"OpenSCAD","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/revarbat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-08-01T22:59:44.000Z","updated_at":"2024-11-03T00:26:13.000Z","dependencies_parsed_at":"2024-01-14T03:50:29.851Z","dependency_job_id":"0b36548a-6d51-470b-953f-3638bddf0c21","html_url":"https://github.com/revarbat/BOSL","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revarbat%2FBOSL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revarbat%2FBOSL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revarbat%2FBOSL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revarbat%2FBOSL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revarbat","download_url":"https://codeload.github.com/revarbat/BOSL/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247134977,"owners_count":20889412,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d-printing","openscad","openscad-library","scad","stl"],"created_at":"2024-08-01T14:00:50.721Z","updated_at":"2025-04-04T06:32:13.410Z","avatar_url":"https://github.com/revarbat.png","language":"OpenSCAD","funding_links":[],"categories":["OpenSCAD"],"sub_categories":[],"readme":"# BOSL\nThe Belfry OpenScad Library - A library of tools, shapes, and helpers to make OpenScad easier to use.\n\nThis library is a set of useful tools, shapes and manipulators that I developed while working on various\nprojects, including large ones like the Snappy-Reprap printed 3D printer.\n\n\n## Installation\n1. Download the .zip or .tar.gz release file for this library.\n2. Unpack it.  It should create a `BOSL-v1.0` directory with the library files within it.\n3. Rename the directory to `BOSL`.\n4. Move the `BOSL` directory into the apropriate OpenSCAD library directory for your platform:\n    - Windows: `My Documents\\OpenSCAD\\libraries\\`\n    - Linux: `$HOME/.local/share/OpenSCAD/libraries/`\n    - Mac OS X: `$HOME/Documents/OpenSCAD/libraries/`\n5. Restart OpenSCAD.\n\n\n## Terminology\nFor purposes of the BOSL library, the following terms apply:\n- **Left**: Towards X-\n- **Right**: Towards X+\n- **Front**/**Forward**: Towards Y-\n- **Back**/**Behind**: Towards Y+\n- **Bottom**/**Down**/**Below**: Towards Z-\n- **Top**/**Up**/**Above**: Towards Z+\n\n- **Axis-Positive**: Towards the positive end of the axis the object is oriented on.  IE: X+, Y+, or Z+.\n- **Axis-Negative**: Towards the negative end of the axis the object is oriented on.  IE: X-, Y-, or Z-.\n\n## Common Arguments:\n\nArgs    | What it is\n------- | ----------------------------------------\nfillet  | Radius of rounding for interior or exterior edges.\nchamfer | Size of chamfers/bevels for interior or exterior edges.\norient  | Axis a part should be oriented along.  Given as an XYZ triplet of rotation angles.  It is recommended that you use the `ORIENT_` constants from `constants.scad`.  Default is usually `ORIENT_Z` for vertical orientation.\nalign   | Side of the origin that the part should be on.  Given as a vector away from the origin.  It is recommended that you use the `V_` constants from `constants.scad`.  Default is usually `V_ZERO` for centered.\n\n\n## Examples\nA lot of the features of this library are to allow shorter, easier-to-read, intent-based coding.  For example:\n\n[`BOSL/transforms.scad`](https://github.com/revarbat/BOSL/wiki/transforms.scad) Examples | Raw OpenSCAD Equivalent\n------------------------------- | -------------------------------\n`up(5)`                         | `translate([0,0,5])`\n`xrot(30,cp=[0,10,20])`         | `translate([0,10,20]) rotate([30,0,0]) translate([0,-10,-20])`\n`xspread(20,n=3)`               | `for (dx=[-20,0,20]) translate([dx,0,0])`\n`zring(n=6,r=20)`               | `for (zr=[0:5]) rotate([0,0,zr*60]) translate([20,0,0])`\n`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]])`\n\n[`BOSL/shapes.scad`](https://github.com/revarbat/BOSL/wiki/shapes.scad) Examples | Raw OpenSCAD Equivalent\n---------------------------------- | -------------------------------\n`upcube([10,20,30]);`              | `translate([0,0,15]) cube([10,20,30], center=true);`\n`cuboid([20,20,30], fillet=5, edges=EDGES_Z_ALL);` | `minkowski() {cube([10,10,20], center=true); sphere(r=5, $fn=32);}`\n`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);}`\n`xcyl(l=20,d=4);`                  | `rotate([0,90,0]) cylinder(h=20, d=4, center=true);`\n`cyl(l=100, d=40, fillet=5);`      | `translate([0,0,50]) minkowski() {cylinder(h=90, d=30, center=true); sphere(r=5);}`\n\n[`BOSL/masks.scad`](https://github.com/revarbat/BOSL/wiki/masks.scad) Examples | Raw Openscad Equivalent\n----------------------------------- | -------------------------------\n`chamfer_mask_z(l=20,chamfer=5);`   | `rotate(45) cube([5*sqrt(2), 5*sqrt(2), 20], center=true);`\n`fillet_mask_z(l=20,fillet=5);`     | `difference() {cube([10,10,20], center=true); for(dx=[-5,5],dy=[-5,5]) translate([dx,dy,0]) cylinder(h=20.1, r=5, center=true);}`\n`fillet_hole_mask(r=30,fillet=5);`  | `difference() {cube([70,70,10], center=true); translate([0,0,-5]) rotate_extrude(convexity=4) translate([30,0,0]) circle(r=5);}`\n\n\n## The Library Files\nThe library files are as follows:\n\n### Commonly Used\n  - [`transforms.scad`](https://github.com/revarbat/BOSL/wiki/transforms.scad): The most commonly used transformations, manipulations, and shortcuts are in this file.\n  - [`shapes.scad`](https://github.com/revarbat/BOSL/wiki/shapes.scad): Common useful shapes and structured objects.\n  - [`masks.scad`](https://github.com/revarbat/BOSL/wiki/masks.scad): Shapes that are useful for masking with `difference()` and `intersect()`.\n  - [`threading.scad`](https://github.com/revarbat/BOSL/wiki/threading.scad): Modules to make triangular and trapezoidal threaded rods and nuts.\n  - [`paths.scad`](https://github.com/revarbat/BOSL/wiki/paths.scad): Functions and modules to work with arbitrary 3D paths.\n  - [`beziers.scad`](https://github.com/revarbat/BOSL/wiki/beziers.scad): Functions and modules to work with bezier curves.\n\n### Standard Parts\n  - [`involute_gears.scad`](https://github.com/revarbat/BOSL/wiki/involute_gears.scad): Modules and functions to make involute gears and racks.\n  - [`joiners.scad`](https://github.com/revarbat/BOSL/wiki/joiners.scad): Modules to make joiner shapes for connecting separately printed objects.\n  - [`sliders.scad`](https://github.com/revarbat/BOSL/wiki/sliders.scad): Modules for creating simple sliders and rails.\n  - [`metric_screws.scad`](https://github.com/revarbat/BOSL/wiki/metric_screws.scad): Functions and modules to make metric screws, nuts, and screwholes.\n  - [`linear_bearings.scad`](https://github.com/revarbat/BOSL/wiki/linear_bearings.scad): Modules to make mounts for LMxUU style linear bearings.\n  - [`nema_steppers.scad`](https://github.com/revarbat/BOSL/wiki/nema_steppers.scad): Modules to make mounting holes for NEMA motors.\n  - [`phillips_drive.scad`](https://github.com/revarbat/BOSL/wiki/phillips_drive.scad): Modules to create Phillips screwdriver tips.\n  - [`torx_drive.scad`](https://github.com/revarbat/BOSL/wiki/torx_drive.scad): Functions and Modules to create Torx bit drive holes.\n  - [`wiring.scad`](https://github.com/revarbat/BOSL/wiki/wiring.scad): Modules to render routed bundles of wires.\n\n### Miscellaneous\n  - [`math.scad`](https://github.com/revarbat/BOSL/wiki/math.scad): Useful helper functions.\n  - [`constants.scad`](https://github.com/revarbat/BOSL/wiki/constants.scad): Useful constants for vectors, edges, etc.\n  - [`quaternions.scad`](https://github.com/revarbat/BOSL/wiki/quaternions.scad): Functions to work with quaternion rotations.\n  - [`debug.scad`](https://github.com/revarbat/BOSL/wiki/debug.scad): Modules to help debug creation of beziers, `polygons()`s and `polyhedron()`s\n\n## Documentation\nThe full library docs can be found at https://github.com/revarbat/BOSL/wiki\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevarbat%2FBOSL","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevarbat%2FBOSL","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevarbat%2FBOSL/lists"}