Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- categories: [
- {
- //Used throughout the json file as an identifier, MUST be unique
- "id": "<Category ID>",
- //Shown in the category select box on the setup helper
- "text": "<Category Description>"
- }
- ]
- steps: {
- "<Category ID>": [
- //Variant 1: Short string form ---> Unique action name without a special input value
- "<Action Name>",
- //Variant 2: Long object form to either specify a step-action collection or set a custom input value just for this step
- {
- "name": "<Action/Collection Name>",
- "collection": true //Optional, name specifies a step-action Collection Name if set
- "eventValue": <Number/String/Boolean>, //Optional, overrides action default event value. Don't use if collection reference!
- "messageValue": <Number/String/Boolean> //Optional, overrides action default message value. Don't use if collection reference!
- }
- ]
- }
- collections: {
- //MUST be unique
- "<Collection Name>": [
- //Variant 1: Short string form ---> Unique action name without a special input value
- "<Action Name>",
- //Variant 2: Long object form to set a custom input value just for this step. No collection sub references allowed!
- {
- "name": "<Action Name>",
- "eventValue": <Number/String/Boolean>, //Optional, overrides action default event value
- "messageValue": <Number/String/Boolean> //Optional, overrides action default message value
- }
- ]
- }
- actions: {
- //MUST be unique
- "<Action Name>": {
- "auto": true, //If set, then this step auto completes, no user input allowed!
- "desc": "<Action Description>", //Tell the user what to do to complete this action, not allowed when 'auto' is true!
- "inputBar": "<Input Placeholder Text>", //Prompt the user for a text string if this key is set and send it to the target
- "dropdown": [ //Prompt the user for a dropdown choice if this key is set. The chosen ID is send to the target as the value
- {
- "id": "<Dropdown Choice ID>", //MUST be unique for this dropdown
- "text": "<Dropdown Choice Text>"
- }
- ],
- //If present, this action should deliver an event to a dashboard element (JUST for the person using the helper!)
- "event": {
- "name": "<Event Name>", //Event name to dispatch. MUST be unique and should be prefixed with "setuphelper_"
- "target": "<Dashboard Element Tag>", //A tag to denote to which dashboard element this event is being sent, only used as a reference
- "value": <Number/String/Boolean> //Optional, sends the value along the event as the default value. Not applicable if inputBar or dropdown. Can be overridden per step via eventValue
- },
- //If present, this action should deliver a NodeCG message to the server/an extension
- "message": {
- "name": "<Message Name>", //Message name to dispatch. MUST be unique and should be prefixed with "setuphelper_"
- "target": "<Extension Element Tag>", //A tag to denote to which extension this message is being sent, only used as a reference
- "value": <Number/String/Boolean> //Optional, sends the value along the message as the default value. Not applicable if inputBar or dropdown. Can be overridden per step via messageValue
- }
- }
- }
- Changed modules:
- zsr-irc
- zsr-timekeeper
- teams-info
- zsr-scoreboard
- zsr-countdown
- zsr-music
- zsr-streamdelay
- countdown-info
- rando-tracker/ootr-tracker
- command-list
- zsr-lead
- Extensions:
- discord.js
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement