simeonradivoev/gameflow-deck
simeonradivoev/gameflow-deck
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
gameflow-deck/scripts/sdk/README.md

755 B
Raw Blame History

Gameflow Deck SDK

This is the type definitions for Gameflow Deck plugins.

Developing a plugin

The plugin must have a default export class of type PluginType. It exposes the context and all the hooks to be tapped. Gameflow uses the Tapable Hooks.

The package must expose a main script gameflow will import and validate. It must implement the type fields on PluginDescriptionType.

Publishing

For the plugin to show up in the UI for download. It must be published to NPM with the gameflow-plugin keyword. Gameflow uses bun to install plugins as packages from npmjs. Follow publishing instruction check the NPM Docs