grey/BOSL2
1
0
Fork 0
mirror of https://github.com/BelfrySCAD/BOSL2.git synced 2024-12-28 07:49:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Page: Home
Pages
AlphaIndex CheatSheet Home TOC Topics Tutorial Attachments Tutorial Beziers_for_Beginners Tutorial Distributors Tutorial FractalTree Tutorial Mutators Tutorial Paths Tutorial Rounding_the_Cube Tutorial Shapes2d Tutorial Shapes3d Tutorial Transforms Tutorial VNF Tutorials attachments.scad ball_bearings.scad beziers.scad bottlecaps.scad color.scad comparisons.scad constants.scad coords.scad cubetruss.scad distributors.scad drawing.scad fnliterals.scad gears.scad geometry.scad hinges.scad joiners.scad linalg.scad linear_bearings.scad lists.scad masks2d.scad masks3d.scad math.scad miscellaneous.scad modular_hose.scad nema_steppers.scad nurbs.scad partitions.scad paths.scad polyhedra.scad regions.scad rounding.scad screw_drive.scad screws.scad shapes2d.scad shapes3d.scad skin.scad sliders.scad strings.scad structs.scad threading.scad transforms.scad trigonometry.scad tripod_mounts.scad turtle3d.scad utility.scad vectors.scad version.scad vnf.scad walls.scad wiring.scad
1 Home
Revar Desmera edited this page 2024-12-14 02:23:46 -08:00
Unescape Escape
Table of Contents
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

BOSL2 Logo

Belfry OpenSCAD Library v2

Documentation Indices

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.

Indices

Table of Contents
Function Index
Topics Index
Cheat Sheet
Tutorials

List of Files:

Basic Modeling:

Advanced Modeling:

Math:

Data Management:

Threaded Parts:

Parts:

Footnotes:

STD = Included in std.scad

Home – Table of Contents – Functions Index – Topics – Cheat Sheet – Tutorials