# Velora

## Getting Started

Mix It Up connects to your Velora channel so chat, channel points, Volts cheers, subscriptions, and channel settings can drive your stream automation.

Velora also handles bot accounts differently than other platforms: bots live under your streamer account rather than being a separate login.

## Actions

Velora actions allow you to perform actions on your Velora channel, such as setting your title, announcing, raiding, and managing channel points. Your Velora account must be connected on the Accounts page for this action to run.

This action supports the following options:

- **Set Title:** Sets the title for the channel.
- **Set Game:** Sets the game/category for the channel. The category is matched by name first, then by slug, then by a name that starts with what you typed. If no category matches, the action reports the failure rather than updating the title and quietly dropping the category.
- **Announce:** Sends an announcement to your Velora chat. An accent color can be selected for the announcement: Default, Blue, Gold, Green, Red, Orange, or Coral. Announcements send as your Velora bot by default when a bot is connected. Enable the Send as Streamer option to send it as your streamer account instead.
- **Clear Chat:** Clears all messages from your Velora chat.
- **Mod User:** Makes the specified user a moderator of the channel.
- **Unmod User:** Removes moderator status from the specified user.
- **VIP User:** Makes the specified user a VIP of the channel.
- **Un-VIP User:** Removes VIP status from the specified user.
- **Ban User:** Bans the specified user from the channel. An optional reason can be provided.
- **Unban User:** Unbans the specified user from the channel.
- **Timeout User:** Times out the specified user for the specified number of seconds. If no amount is specified, a default of 300 seconds is used. An optional reason can be provided.
- **Untimeout User:** Removes an active timeout from the specified user. On Velora, timeouts and bans are lifted separately.
- **Raid:** Raids the specified channel.
- **Shoutout:** Sends a shoutout for the specified user in the channel.
- **Grant Channel Points:** Grants the specified amount of your channel's points to the target user.
- **Deduct Channel Points:** Deducts the specified amount of your channel's points from the target user.

For the user-based options, the target username field supports [Special Identifiers](/docs/reference/special-identifiers) (EX: $targetusername). If no username is specified, the user who triggered the command is used.

Channel Point Rewards that users redeem with these points can trigger commands via the [Velora Channel Points Commands](/docs/platforms/velora#velora-channel-points-commands) page.

## Events

### Velora Channel Stream Start
This event will run when your stream goes from offline to online. It is often used to send out Discord and Twitter notices to your social media accounts to alert users that your stream is starting. This event is only triggered once per-application launch. This event provides no additional special identifiers.

Going live carries the category the stream started with, and that category is applied before the event fires. Stream start commands therefore see the category you are actually live with rather than whatever the last background refresh left behind.

### Velora Channel Stream Stop
This event will run when your stream goes from online to offline. It is often used to send out Discord and Twitter notices to your social media accounts to alert users that your stream has ended. This event is only triggered once per-application launch. This event provides no additional special identifiers.

### Velora Channel Updated
This event triggers when a change to your stream has been detected, such as your title or category. This event provides the following additional Special Identifiers:
- $streamtitle = The updated title of the stream
- $streamgame = The updated category of the stream
- $streamgamename = The updated category of the stream
- $streamgameid = The ID (slug) of the updated category of the stream
- $streamgameimage = The image URL for the updated category of the stream

### Velora Channel Followed
This event will run the first time a user follows during this specific session of Mix It Up. This means that if a user follows, unfollows, and then re-follows quickly, it will only run the first time. This event is only triggered once per-user, per-application launch.

This event provides no additional special identifiers, however, it is often used with the [User](/docs/reference/special-identifiers#user) special identifiers.

### Velora Channel Raided
This event triggers when a channel raids your channel. It is often used to thank the user for the raid using chat and possibly overlay. This event is only triggered once per-user, per-application launch.

The [User](/docs/reference/special-identifiers#user) special identifiers indicate the user that raided. This event provides the following additional Special Identifiers:
- $raidviewercount = The number of viewers of the channel that raided (EX: 10)
- $hostviewercount = The number of viewers of the channel that raided (EX: 10)

### Velora Channel Subscribed
This event will run when a user subscribes to your channel. This event is only triggered once per-user, per-application launch.

In addition to regular [User](/docs/reference/special-identifiers#user) Special Identifiers, this event provides the following additional Special Identifiers:
- $usersubmonths = The number of months the user has been subscribed for (EX: 1)
- $usersubtier = The tier number of the subscription (EX: 1)
- $usersubplan = The tier of the plan (EX: Tier 1)
- $usersubplanname = The name of the plan. Velora subs are numbered tiers with no streamer-set plan names, so this carries the same tier label (EX: Tier 1)
- $message = An optional message that the user can supply when subscribing

### Velora Channel Resubscribed
This event will run when a user resubscribes to your channel. This event is only triggered once per-user, per-application launch.

In addition to regular [User](/docs/reference/special-identifiers#user) Special Identifiers, this event provides the following additional Special Identifiers:
- $usersubmonths = The cumulative number of months that the user has been subscribed for
- $usersubstreak = The continuous number of months that the user has been subscribed for
- $usersubtier = The tier number of the subscription (EX: 1)
- $usersubplan = The tier of the plan (EX: Tier 1)
- $usersubplanname = The name of the plan, carrying the same tier label (EX: Tier 1)
- $message = An optional message that the user can supply when resubscribing

### Velora Channel Subscription Gifted
This event will run for every user that is gifted a subscription by another user in your channel. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user that GIFTED the subscription (Ex: $username), while the [Target User](/docs/reference/special-identifiers#target-user) Special Identifiers reference the user that RECEIVED the subscription (Ex: $targetusername). This event provides the following additional Special Identifiers:
- $usersubtier = The tier number of the gifted subscription (EX: 1)
- $usersubplan = The tier of the plan (EX: Tier 1)
- $usersubplanname = The name of the plan, carrying the same tier label (EX: Tier 1)
- $isanonymous = Whether the sub gifting was done anonymously (EX: true/false)

### Velora Channel Mass Subscriptions Gifted
This event will run once for each time a user in your channel gifts a **set** of subscriptions. This is when a user selects a number of subs to gift all at once to users in the channel. For example, if a user gifts 5 subscriptions to your channel, this event will be run once, while the [Velora Channel Subscription Gifted](/docs/platforms/velora#velora-channel-subscription-gifted) will be run 5 times, once for each user. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user that GIFTED the subscription.

What determines whether this command or the Velora Channel Subscription Gifted command will run is based on what is set for the Mass Gifted Subscriptions Filter Amount under Settings -> Commands. This option is designed to help reduce the spam of subscription gifted commands and provide a better experience for your stream. For example, if this option is enabled and the amount is set to 5, then any time 5 OR LESS subscriptions are gifted at once, it will ONLY run the regular Subscription Gifted event for each subscription. If MORE THAN 5 are gifted, then it will ONLY run the Mass Subscriptions Gifted event once.

This event provides the following additional Special Identifiers:
- $subsgiftedamount = The number of subscriptions gifted for this specific instance
- $subsgiftedlifetimeamount = The lifetime amount of subs for the gifter
- $usersubtier = The tier number of the gifted subscriptions (EX: 1)
- $usersubplan = The tier of the plan (EX: Tier 1)
- $usersubplanname = The name of the plan, carrying the same tier label (EX: Tier 1)
- $isanonymous = Whether the sub gifting was done anonymously (EX: true/false)

### Velora Channel Points Redeemed
This event is run when a channel point reward is redeemed in your channel. Redemptions that are canceled or rejected will not trigger this event. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user who triggered the event. This event provides the following additional Special Identifiers:
- $rewardname = The name of the reward
- $rewardcost = The cost of the reward
- $message = An optional message that the user can supply when the reward is redeemed
- $messagenoemotes = The supplied message without emotes
- $messageemotecount = The number of emotes in the supplied message

### Velora Channel Cheered
This event is run when a user cheers Volts in your channel. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user who triggered the event. This event provides the following additional Special Identifiers:
- $voltsamount = The number of Volts cheered
- $cheeramount = The number of Volts cheered
- $message = An optional message that the user can supply when cheering
- $messagenoemotes = The supplied message without emotes

## Velora Channel Points Commands

The Velora Channel Points feature allows you to create commands that can be triggered automatically when specific Velora Channel Point Rewards are redeemed in your Velora channel.

When creating a command, you select one of the Channel Point Rewards that exist on your Velora channel and the command will be run whenever that reward is redeemed. Redemptions that are canceled or rejected will not trigger the command. Channel Point Rewards themselves are created and managed on Velora's website. Mix It Up reads the list of rewards from your channel when you create or edit a command. Your Velora account must be connected on the Accounts page for the rewards list to load.

Velora Channel Point commands provide the following additional Special Identifiers:
- $rewardname = The name of the reward
- $rewardcost = The cost of the reward
- $message = An optional message that the user can supply when the reward is redeemed
- $messagenoemotes = The supplied message without emotes
- $messageemotecount = The number of emotes in the supplied message

Channel points can be granted to or deducted from your users with the Grant Channel Points and Deduct Channel Points options on the [Velora action](/docs/platforms/velora#actions).