Zengine Plugin SDK

Writing Zengine plugins? We got you covered!

This is a monorepo containing various Zengine Plugin development related libraries.

Available Packages

Name	Version
PostRPC Client
PostRPC Server
Zengine SDK
Zengine SDK React
Zengine UI
Zengine UI React

Documentation

Development

• Install Lerna: npm i -g lerna
• Bootstrap the repo: npm i && lerna bootstrap && lerna run build
• Run dev script: lerna run watch --parallel

Publishing

After any code or docs change has been made, publish to npm and/or the documentation site with these commands. Lerna will take care of intelligently determining what changed and where to publish it. You need only occasionally determine the semver bump (Lerna usually gets that right too though).

• First build all packages: lerna run build
• Publish! lerna publish --message "chore: release" (see note)

Notes

• Due to our commitlint rules the default commit message for publishing fails, so this valid message argument is required.

Wishlist

• Install and configure Prettier for all packages
• If possible move ESLint and Prettier configs up to root level and propagate down
• Repeat above with shared node_modules stuff if possible