Skip to content
developers
Developer home

YOUR FIRST PLUGIN

Getting started

Install the SDK, create a plugin from a template, try it in the simulator and package it.

Node.js 20.10+Local simulator3 starter templates

You need Node.js 20.10 or later. Nothing else: the simulator emulates the platform locally.

1. Plugin folder

Section titled “1. Plugin folder”
Terminal window
npx @viswoo/plugin-sdk init gift-draw --template interactive
cd gift-draw
npm install

There are three templates:

Template Contains
basic Settings schema (required field, labels, colour, server-only field), panel tab, screen view, placement
interactive Touch screen and phone page via QR, draw pool, one-time codes, redemption at the till, counters
server The plugin’s own server (Node example): signature verification, install token, platform API

The plugin code (gift-draw) is permanent: lower-case letters, digits and hyphens, 3–40 characters. It cannot change after publishing.

2. Simulator

Section titled “2. Simulator”
Terminal window
npm run dev

http://localhost:5199 opens the panel tab, the TV and the phone side by side. Bridge calls are answered with the platform rules: permissions, user role, settings schema, server-only fields, draw limits, codes. Frames reload when you save a file. Details: Development tools.

3. Validate and pack

Section titled “3. Validate and pack”
Terminal window
npm run validate   # package rules and the ES5 check of the screen view
npm run pack       # dist/gift-draw-0.1.0.vzp

pack adds the bridges and kits (viswoo-panel.js, viswoo-ui.css …) from the SDK; you do not put them in the package. The screen view is inlined into a single file.

4. Upload and publish

Section titled “4. Upload and publish”

Create an account in the developer portal, register the plugin code and upload the package (or VISWOO_TOKEN=vzd_… npx viswoo-plugin publish .). Try the draft version on a real screen in your own test area. See Publishing and review.

Next steps

Section titled “Next steps”