coord_kit

A coordinate-based geometry manipulation library for OpenSCAD.

Overview

coord_kit provides functions for working with 2D and 3D coordinates in OpenSCAD, including point generation, transformation, and extrusion utilities. It is basically a thin wrapper around Kurt Hutten's Round-Anything library that I found handy.

Key Features:

• Point-based geometry creation
• Coordinate transformation utilities
• Advanced extrusion functions
• Clean, documented API

Installation

Method 1: Git Submodule (Recommended)

Add to your project as a git submodule:

cd your-project
git submodule add https://github.com/LazerPlatypus/coord_kit.git deps/coord_kit
git submodule update --init --recursive

Method 2: Direct Download

Download and place in your OpenSCAD library directory:

• Linux: ~/.local/share/OpenSCAD/libraries/
• macOS: ~/Documents/OpenSCAD/libraries/
• Windows: My Documents\OpenSCAD\libraries\

Quick Start

If installed as submodule (recommended):

include <deps/coord_kit/core.scad>

// Use coord_kit functions
coords = points_to_coords([[0, 0, 2], [10, 0, 2], [10, 10, 2], [0, 10, 2]]);
// extrude into 3D
linear_extrude(height = 5) { polygon(coords); };

If installed in OpenSCAD libraries directory:

include <coord_kit/core.scad>

// Use coord_kit functions
coords = points_to_coords([[0, 0, 2], [10, 0, 2], [10, 10, 2], [0, 10, 2]]);
// extrude into 3D
linear_extrude(height = 5) { polygon(coords); };

Documentation

• API Reference - Complete function and module documentation

Usage Examples

Creating Points

include <deps/coord_kit/core.scad>

// create coords for a square
coords = points_to_coords([[0, 0], [10, 0], [10, 10], [0, 10]]);
// extrude into 3D
linear_extrude(height = 5) { polygon(coords); };

// create coords for a rounded square
coords = points_to_coords([[0, 0, 2], [10, 0, 2], [10, 10, 2], [0, 10, 2]]);
 // extrude into 3D
linear_extrude(height = 5) { polygon(coords); };

Extrusion

include <deps/coord_kit/core.scad>

// extrude into "Y" plane
planar_linear_extrude(30, plane="Y") { polygon([[0,0],[10,0],[10,10],[0,10]]); }

See docs/ for more complete examples & documentation.

Development

Setup

First-time setup of development environment:

make setup

This creates a Python virtual environment and installs openscad-docsgen for documentation generation.

Building

# Build everything (docs + images)
make

# Build documentation only
make docs

# Render example images
make images

# Run tests
make test

Project Structure

coord_kit/
├── core.scad              # Main entry point
├── src/                   # Source modules
│   ├── extrude.scad      # Extrusion utilities
│   └── points.scad       # Point generation
├── examples/              # Usage examples
├── tests/                 # Test files
├── docs/                  # Generated documentation
├── deps/                  # Dependencies (submodules)
├── scripts/               # Build scripts
└── Makefile              # Build automation

Dependencies

• OpenSCAD 2026.02.11 or newer
• Python 3 (for documentation generation only)
• openscad-docsgen (installed automatically with make setup)

Optional dependencies in deps/ are included as git submodules.

Contributing

Contributions welcome!

License

This project is licensed under the CERN Open Hardware License Version 2 – Strongly Reciprocal (CERN-OHL-S v2).

Summary:

• ✓ Use, modify, and manufacture (including commercially)
• ✓ Distribute original or modified versions
• ⚠️ Modified versions must use the same license
• ⚠️ Must provide complete source for any distributed modifications

Full license text available in the LICENSE file.

Support

• Issues: GitHub Issues
• Documentation: docs/

---

Status: Active development Version: 0.1.0 (pre-release)