generator-zn-plugin

Zengine Plugin Generator for Yeoman

Yeoman Generators for Zengine Plugins

Install

If you don't have yeoman.io installed

npm install -g yo

Then install the generator

# New version
npm install -g generator-zn-plugin

# Legacy version for Maya
npm install -g generator-zn-plugin@legacy

You can then keep it up to date with:

npm upgrade -g [generator-zn-plugin|generator-zn-plugin]

Which version should I use?

• the 2.x branch is only compatible with mayan and supports frontend config and other helper modules
• the 1.x branch is compatible with both maya and mayan (caveat being that you must manually update your maya-build scripts)

Usage

• zn-plugin
• zn-plugin:backend
• zn-plugin:frontend

Creating a full plugin

# change to your projects directory
cd Projects

# run yo
yo zn-plugin zn-plugin-demo

# then install npm modules
cd zn-plugin-demo

npm install

Adding a backend service for an existing plugin

# change to your plugin directory
cd zn-plugin-demo

# run yo
yo zn-plugin:backend my-test-api

# then install npm modules
cd my-test-api

npm install

Adding a new frontend plugin for an existing plugin

# change to your plugin directory
cd zn-plugin-demo

# run yo
yo zn-plugin:frontend my-test-ui

# then install npm modules
cd my-test-ui

npm install

Contribute

See the contributing.