ducki/README.md

Simple CLI for working with KiCad projects.

DucKi
=====

A simple scripting language for interacting with KiCad, mostly for
the purpose of creating 3D renders, scheamtics, etc. for README files
in projects.


Usage
-----

Create a file in a KiCad project files called `ducki.js`, that will
be run in a VM with a global `project` variable.

All file paths are relative to the project folder (where the `ducki.js`
file is located).

```
// Create a 3D Render
project.render("output/render-front.jpg", {
    perspective: true,
    rotate: { x: -25, y: 25, z: 10 },
    size: { width: 1024 },
    zoom: 1.5
});

// Create a 3D fly-around GIF, the board can be rotated to any position
// and the fly around will be around the board's y-axis
project.flyaround("output/fly-around.gif", {
    perspective: true,
    rotate: { x: -25, y: 25, z: 10 },
    size: { width: 1024 },
    zoom: 1.2
});

// Plot all the schematic SVG files; the root schematic will be
// named sch.svg and each hierarchal sheet will be `sch-FILENAME.svg`.
project.plot("output");
```


License
-------

MIT License.