Getting started
Run a script
Try the Windrose JavaScript API now, directly inside Windrose. The code below prints a message at the bottom of your document window saying Hello Windrose 👋.
- Open a new or existing file in Windrose
- Choose Run Script… from the Extensions menu, or press
control + shift + k, to bring up the code editor - Paste in the code below
- Select Run
const windrose = require('windrose') windrose.UI.message('Hello Windrose 👋')
Publish an extension
Use the Windrose Extension Manager wpm to publish a new extension or an update to an existing one. This adds your extension to the Windrose Extension Directory ↗ for review before it is listed on the Windrose website.
Export assets automatically
Create assets with a single command using the Windrose command-line interface windtool. Generate files for every exportable layer, slice, board or whole page, in as many resolutions as you need.
- Open a new file in Windrose
- Add a shape, or anything else, to the canvas
- Save the file locally, e.g. Atlas.wind on your Desktop
- Open Terminal and run the command below, which looks up the
windtoolbundled with Windrose and exports all pages of Atlas.wind
This writes an image file called Page 1.png into the same folder you ran the command in.
WINDROSE=$(mdfind kMDItemCFBundleIdentifier == 'com.oakmeadow.windrose3' | head -n 1) "$WINDROSE/Contents/Resources/windtool/bin/windtool" export pages ~/Desktop/Atlas.wind