G2A Many GEOs
SHARE
TWEET

Setup helper structure

dragonbane Feb 5th, 2020 (edited) 92 Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1. categories: [
  2.   {
  3.     //Used throughout the json file as an identifier, MUST be unique
  4.     "id": "<Category ID>",
  5.     //Shown in the category select box on the setup helper
  6.     "text": "<Category Description>"
  7.   }
  8. ]
  9.  
  10.  
  11. steps: {
  12.   "<Category ID>": [
  13.     //Variant 1: Short string form ---> Unique action name without a special input value
  14.     "<Action Name>",
  15.     //Variant 2: Long object form to either specify a step-action collection or set a custom input value just for this step
  16.     {
  17.       "name": "<Action/Collection Name>",
  18.       "collection": true //Optional, name specifies a step-action Collection Name if set
  19.       "eventValue": <Number/String/Boolean>, //Optional, overrides action default event value. Don't use if collection reference!
  20.       "messageValue": <Number/String/Boolean> //Optional, overrides action default message value. Don't use if collection reference!
  21.     }
  22.   ]
  23. }
  24.  
  25.  
  26. collections: {
  27.   //MUST be unique
  28.   "<Collection Name>": [
  29.     //Variant 1: Short string form ---> Unique action name without a special input value
  30.     "<Action Name>",
  31.     //Variant 2: Long object form to set a custom input value just for this step. No collection sub references allowed!
  32.     {
  33.       "name": "<Action Name>",
  34.       "eventValue": <Number/String/Boolean>, //Optional, overrides action default event value
  35.       "messageValue": <Number/String/Boolean> //Optional, overrides action default message value
  36.     }
  37.   ]
  38. }
  39.  
  40.  
  41. actions: {
  42.   //MUST be unique
  43.   "<Action Name>": {
  44.     "auto": true, //If set, then this step auto completes, no user input allowed!
  45.     "desc": "<Action Description>", //Tell the user what to do to complete this action, not allowed when 'auto' is true!
  46.     "inputBar": "<Input Placeholder Text>", //Prompt the user for a text string if this key is set and send it to the target
  47.     "dropdown": [ //Prompt the user for a dropdown choice if this key is set. The chosen ID is send to the target as the value
  48.       {
  49.         "id": "<Dropdown Choice ID>", //MUST be unique for this dropdown
  50.         "text": "<Dropdown Choice Text>"
  51.       }
  52.     ],
  53.     //If present, this action should deliver an event to a dashboard element (JUST for the person using the helper!)
  54.     "event": {
  55.       "name": "<Event Name>", //Event name to dispatch. MUST be unique and should be prefixed with "setuphelper_"
  56.       "target": "<Dashboard Element Tag>", //A tag to denote to which dashboard element this event is being sent, only used as a reference
  57.       "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
  58.     },
  59.     //If present, this action should deliver a NodeCG message to the server/an extension
  60.     "message": {
  61.       "name": "<Message Name>", //Message name to dispatch. MUST be unique and should be prefixed with "setuphelper_"
  62.       "target": "<Extension Element Tag>", //A tag to denote to which extension this message is being sent, only used as a reference
  63.       "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
  64.     }
  65.   }
  66. }
  67.  
  68.  
  69. Changed modules:
  70. zsr-irc
  71. zsr-timekeeper
  72. teams-info
  73. zsr-scoreboard
  74. zsr-countdown
  75. zsr-music
  76. zsr-streamdelay
  77. countdown-info
  78. rando-tracker/ootr-tracker
  79. command-list
  80. zsr-lead
  81.  
  82. Extensions:
  83. discord.js
RAW Paste Data
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy. OK, I Understand
Top