Skip to content

ggabbiani/OFL

Repository files navigation

OpenSCAD Foundation Library

GitHub Workflow Status

Cover

OpenSCAD Foundation Library (OFL) is a foundation library for OpenSCAD integrating concepts not included natively in the OpenSCAD language and providing an extendible standardized API base.

Usage

  1. download and expand the library

  2. modify the OPENSCADPATH Environment Variable to point the lib/ directory of this repo as described in OpenSCAD Library Folder

  3. include the needed library file(s) in your OpenSCAD code like in the following example:

    include <OFL/foundation/core.scad>

Library documentation

OFL comes with three major components:

Architecture

Every library component is accessed through a set of verb-based APIs (Common API Template), even third part libraries eventually used internally.

OFL architecture

Disclaimer

The following libraries, used and distributed internally this project, are not part of OFL:

Each of them can be found in the lib/ project directory together with the release and LICENSE notes provided originally.