Skip to content
🚁extend functionality of Windy.com. Develop your plugin in less than 5 minutes.
Branch: master
Clone or download
ilblog Merge pull request #3 from vicb/sounding
Major refactoring of the sounding plugin
Latest commit f8040b9 Feb 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dev Changed dir structure Nov 2, 2018
dist
docs fixed formatting Jan 15, 2019
examples Major refactoring of the sounding plugin Feb 28, 2019
src Initial commit Oct 25, 2018
test Initial commit Oct 25, 2018
.editorconfig Initial commit Oct 25, 2018
.eslintrc.json Commit before cahnge Jan 14, 2019
.gitignore Changed dir structure Nov 2, 2018
.npmignore Initial commit Oct 25, 2018
LICENSE Initial commit Oct 25, 2018
README.md v0.4.0 - new pluginDataLoader example and docs Jan 15, 2019
compiler.js Commit before cahnge Jan 14, 2019
package.json v0.4.0 - new pluginDataLoader example and docs Jan 15, 2019

README.md

Windy plugins

This repository acts as an documentation, playground and boilerplate for your own Windy plugin.

Therefore always fork this repository before editing it.

Plugins are written in Javascript and published as npm package, so you already know how to create them

Getting started

Fork this repository and then clone it

git clone https://github.com/yourUsername/windy-plugins
cd windy-plugins
npm i
npm start

Now open your browser browser at https://localhost:9999/plugin.js to accept self signed SSL certificate.

Then open your browser at www.windy.com/dev to test your plugin.

If it fails, make sure that your plugin is correctly built and accessible with your browser at https://localhost:9999/plugin.js.

Tutorials

Other resources

Compiling your plugin

Our custom Windy Plugin Compiler does all the job for you. Just run npm start to launch it or npm run start-dev to skip beginner's prompt.

Publishing your plugin

  1. Make sure, that your package.json is updated, and that:
    • name, is unique name of your plugin
    • description, describes what your plugin does
    • author and repository reflects your name and where the plugin hosted is
  2. Remove this README.md and put there few words about your plugin (and maybe some screenshot if you want). The text from README file will be used in our planned plugins gallery.
  3. Publish your plugin as npm package by npm publish
  4. Test your published npm package on Windy's Plugin page
  5. Let us know in our community about your new achievement
  6. Commit your work and pull your repository back to GitHub. Rename your repository to reflect name of your plugin.

Conditions

It is strictly prohibited to use plugin to:

  • Modify user's setting without his consent
  • Download any of user's settings, favorites or location to your server
  • Download any meteorological data from Windy to your own server or use them in any other scope than inside your plugin
  • Do any action that would harm our privacy policy

Enterprise use

We prepare Windy Enterprise project, that will enable to

  1. Use private plugins (not published publicly)
  2. Limit access to your data just to your invited users
  3. Let us know if you want to be informed about this project

Things to remember

  • While providing coordinates to Leaflet can be done via object { lat, lng } with lng property, Windy supports { lat, lon } with lon property.
  • Using undocumented functions of Windy API can break your plugin, when we decide to upgrade our codes. If you miss something, rather let us know here and ask us to document and expose other features.

Technical support

Drop a line in our Windy Plugins section of our Community forum.

ROADMAP

  • Initial release
  • Extend Windy API on a basis users requests
  • Create gallery of the most useful plugins
  • Create system so anyone can publish its own forecast/climatological model on Windy

CHANGELOG

  • 0.4.0
    • Added pluginDataLoader to the Plugins API
  • 0.3.0
    • Examples moved to examples dir
  • 0.2.0
    • Fixed wrong examples
  • 0.1.1
    • Initial version of this repo

This is default readme - please do not remove this line

You can’t perform that action at this time.