ProdDash/modules/overflow-tap/module.json

{
  "id": "overflow-tap",
  "name": "Overflow Tap",
  "version": "1.0.0",
  "proddash": ">=1.11.0",
  "description": "Switches Overflow Tap destinations from keywords in ProPresenter slide notes",
  "permissions": [
    {
      "kind": "local-network",
      "reason": "Reaching ProPresenter on this network"
    }
  ],
  "client": "client.js",
  "server": "server.js",
  "style": "style.css",
  "minSize": {
    "w": 2,
    "h": 2
  },
  "defaultSize": {
    "w": 4,
    "h": 3
  },
  "configGroups": {
    "ProPresenter": {
      "help": "The ProPresenter whose slide notes carry the keywords. Enable the network in ProPresenter's Preferences › Network and enter the host and port shown there. Only the live slide's notes (and the announcement layer's) are read — nothing on the stage screens changes."
    },
    "Overflow": {
      "collapsed": "whenSet",
      "help": "An Overflow Dashboard login with Tap access — what Overflow's own ProPresenter helper app signs in with. Google sign-in does not work here: the account needs a password (Forgot Your Password? on the Dashboard sets one). The keywords, their destinations and their Tap groups are managed in the Dashboard under Integrations › ProPresenter › Keyword Mappings and read from there; after changing them, press the tile's refresh button or wait a few minutes."
    },
    "Alerts": {
      "toggle": "alertEnabled",
      "collapsed": true,
      "help": "Flash the dashboards listening on this channel when a switch fails — Overflow unreachable or refusing the change — so someone can fix Tap by hand before the moment passes."
    }
  },
  "configSchema": {
    "propresenter": {
      "type": "endpoint",
      "label": "ProPresenter",
      "group": "ProPresenter",
      "default": {
        "host": "",
        "port": 1025
      }
    },
    "password": {
      "type": "password",
      "label": "API password",
      "group": "ProPresenter",
      "default": "",
      "help": "Only if a password is set in ProPresenter's network preferences."
    },
    "overflowEmail": {
      "type": "string",
      "label": "Email",
      "group": "Overflow",
      "default": ""
    },
    "overflowPassword": {
      "type": "password",
      "label": "Password",
      "group": "Overflow",
      "default": ""
    },
    "nonprofitId": {
      "type": "string",
      "label": "Nonprofit ID",
      "group": "Overflow",
      "default": "",
      "help": "Leave blank: a church login carries its own. Only an @overflow.co staff login needs one."
    },
    "alertEnabled": {
      "type": "switch",
      "label": "Alert when a switch fails",
      "group": "Alerts",
      "default": false
    },
    "alertChannel": {
      "type": "number",
      "label": "Channel",
      "group": "Alerts",
      "default": 1,
      "min": 1,
      "max": 6,
      "help": "1–6; each dashboard chooses the channels it listens to in its Layouts menu."
    }
  },
  "instanceSchema": {
    "showDestination": {
      "type": "switch",
      "label": "Destination",
      "default": true
    },
    "showGroups": {
      "type": "switch",
      "label": "Groups",
      "default": true
    },
    "showSlide": {
      "type": "switch",
      "label": "Slide match",
      "default": true
    },
    "showHistory": {
      "type": "switch",
      "label": "History",
      "default": true
    }
  }
}