scad-js

0.5.0 • Public • Published

scad-js SCAD-JS

scad-js transpile your Javascript to OpenSCAD letting you create programmatic 3d solid models with the familiar javascript syntax.

Latest release Codecov coverage Build passing scad-js demo

OpenSCAD is an amazing software for creating solid 3D CAD objects, but modeling with the OpenSCAD language can be really cumbersome and limited.

scad-js overcomes these limitations with the power of Javascript.

Getting started

First make sure you have OpenSCAD installed on your system, we will use it to visualize the model.

clone scad-js-starter:

git clone https://github.com/20lives/scad-js-starter.git my-scad-js-project
cd my-scad-js-project

install dependencies and run develpment script:

yarn # or npm install
yarn dev # or npm run dev

Now open index.js in your favourite text editor and start tinkering.

Documentation

For detailed documentation on how to use scad-js visit scad-js-docs, you can also look at the official OpenSCAD Documentation page.

Examples

A good way for learning scad-js and OpenSCAD is throught examples: examples

Acknowledgements

This project was inspired by many other projects: farrellm/scad-clj, OpenJSCAD.org, tasn/scadjs and more... And of course it would not even exist without OpenSCAD itself.

License

This project is open source and available under the MIT License.

Readme

Keywords

none

Package Sidebar

Install

npm i scad-js

Weekly Downloads

0

Version

0.5.0

License

MIT

Unpacked Size

37.5 kB

Total Files

18

Last publish

Collaborators

  • 20lives