Skip to main content

Background Changed

  • Alert key: vtubestudio-backgroundChanged
  • Source: Vtubestudio

Default message template​

{{name}} background changed

Template variables​

Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').

Template variableOverlay payload fieldDescription
{{name}}data.extraSettings.nameName of user

Example payloads​

Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).

Background Change​

{
  "alert": "vtubestudio-backgroundChanged",
  "dynamic": {
    "value": "night_time"
  },
  "extraSettings": {
    "name": "night_time"
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_STRING - Background is equal to
  • EQUAL_VARIABLE