The Stream Pass feature allows you to set up a “Season Pass”/“Battle Pass”-like design for your stream where users gain points & level up to earn rewards. You can have multiple Stream Passes available at any given point and a Stream Pass remains valid as long as it is between the defined Start & End dates for it.
When customizing a Stream Pass, you have the ability to define the full structure for who can participate in it, how many levels there are, how many points are required per level, and how a user acquires points throughout your stream. To reward your players for each level, you can either set up a Custom Level Up Command that is triggered when a user reaches a specific level and/or a Default Level Up Command which will be run for every level that doesn’t have a Custom Level Up Command associated with it.
NOTE: The maximum number for any currency, rank, inventory, or stream pass value is 2,147,483,647.
Special Identifiers
Stream Pass Special Identifiers are ways to reference a user’s stream pass amounts. The actual Special Identifiers for your Stream Pass will be different for every single one, as they vary based off of the name. However, they do fit into a pre-determined format. These can also be used with other Special Identifiers that work for users such as Target, Argument, Streamer, & Random (EX: $targetuser____)
For example, if I have a Stream Pass named “Power”, then all of the ____’s below would be replaced with “power”. If the name of your Stream Pass has spaces in it, then those spaces will NOT be in it (EX: “Super Power” -> “superpower”).
- $user____ = The amount of points for the user who ran the command. (EX: 20000)
- $user____display = The amount of points for the user who ran the command in a display-friendly format. (EX: 20,000)
- $user____level = The level for the user who ran the command. (EX: 18)