Warning

This is the documentation the latest work-in-progress version of MPF!

This is the documentation for MPF 0.56, which is the “dev” (next) release of MPF that is a work-in-progress. This is probably ok, and means you’ll be on the latest, cutting-edge version of MPF.

However, if you want a more stable version, select the v:stable version from the lower-left corner of this page, which is the most recent version that is not getting new updates.

If you are new to MPF, we have recently rewritten the installation process which only applies to this “latest” 0.56, so you probably want to stay here because the prior installation process doesn’t work on the latest OS and Python versions.

twitch_subscription

MPF Event

A chat user has subscribed or resubscribed on Twitch

Keyword arguments

(See the Conditional Events guide for details for how to create entries in your config file that only respond to certain combinations of the arguments below.)

gift
True if this sub was gifted by another user
message
Chat message text
months
The number of months that the user has been a subscriber
sub_plan
The subscription tier (Prime, 1000, 2000, 3000)
sub_plan_name
The streamer specific name for the sub tier
sub_recipient
The user who is subscribing
subscriber_message
The message the user typed when subscribing
user
The chat user name who paid for the subscription