Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.84 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.84 KB

SVG Builder

Create inceractive SVG models for lasercutting.

Similar to OpenSCAD's customizer, but more flexible on the UI side (in my totally unbiased opinion :) ).

How to use

Currently, it's probably easiest to look at the catapult example and adapt it. See index.html, js/catapult.js and js/catapult.css.

To handle the different aspects of your interactive SVG model, SVG Builder offers these ES6 modules:

  • svgbuilder.js -- (re)creating your parametrized SVG design (Drawable base class, PathD helper class and other helpers)
  • ui.js -- Handle parameter I/O and model download
  • qrhandler.js -- QR Code creation and scanning
  • (jsloader.js -- Just a helper for loading libraries that are not ES6 modules)

Contributing

All help and support is welcome. :)

For example:

  • Show how you are using it
  • Create an Issue if you found a bug or have an improvement idea
  • Take on one of the existing issues
  • Generally improve usability
  • Improve documentation

License and acknowledgements

License of catapult design: Creative Commons - Attribution - Non-Commercial. License of source code: MIT License (2023 by Andreas Schuderer).

Catapult design based on this educational Tension Catapult by Thingiverse user mfalk (CC BY-NC 4.0) and its no-glue derivative by SimpleAsWar (CC BY 4.0).

Uses the libraries Paper.js for boolean operations, QRCode.js for generating QR Codes and QR Scanner for scanning them.