Skip to content

gitagogaming/Kofi-TouchPortal-Plugin

Repository files navigation

Kofi

Description

This documentation generated for Kofi V100 with Python TouchPortal SDK.

Settings Overview

Read-only Type Default Value
False text
Read-only Type Default Value
False text 5000
Read-only Type Default Value
False text
Read-only Type Default Value
False text

Features

States

Category: Kofi - New Subscriptions (Click to expand)
Id Description DefaultValue parentGroup
.subscription.is_first_subscription_payment Is this the first subscription payment
.subscription.timestamp Timestamp of the Subscription Payment
.subscription.is_public Is the Subscription Payment Public
.subscription.from_name Name of the Subscriber
.subscription.message Message from the Subscriber
.subscription.amount Amount of the Subscription Payment
.subscription.currency_type Currency Type of the Subscription Payment
.subscription.tier_name Name of the Subscription Tier
.state.newSubscription New Subscription Event
.state.recurringSubscription Recurring Subscription Event
Category: Kofi - New Donations (Click to expand)
Id Description DefaultValue parentGroup
.donation.name Name of the Donor
.donation.message Message from the Donor
.donation.amount Amount Donated
.donation.timestamp Timestamp of the Donation
.donation.is_public Is the Donation Public
.donation.currency Currency Type of the Donation
.state.newDonation New Donation Event
Category: Kofi - New Shop Orders (Click to expand)
Id Description DefaultValue parentGroup
.shop.timestamp Timestamp of the Shop Order
.shop.is_public Is the Shop Order Public
.shop.city City of the Shop Order
.shop.state State of the Shop Order
.shop.country Country of the Shop Order
.shop.country_code Country Code of the Shop Order
.shop.shop_item_1 Shop Item 1 Details
.shop.shop_item_2 Shop Item 2 Details
.shop.shop_item_3 Shop Item 3 Details
.shop.shop_item_4 Shop Item 4 Details
.shop.shop_item_5 Shop Item 5 Details
.shop.shop_item_6 Shop Item 6 Details
.shop.total_items Total Items Ordered
.shop.amount Total Amount of the Shop Order
.state.newShopOrder New Shop Order Event

Events

Category: Kofi Main Category (Click to expand)
IdNameEvaluated State IdFormatTypeChoice(s)
.event.newDonationKofi | New Donation.state.newDonationWhen receiving a new donation $valchoice
  • True
.event.newSubscriptionKofi | New Subscription.state.newSubscriptionWhen receiving a new subscription $valchoice
  • True
.event.newShopOrderKofi | New Shop Order.state.newShopOrderWhen receiving a new shop order $valchoice
  • True
.event.recurringSubscriptionKofi | Recurring Subscription.state.recurringSubscriptionWhen receiving a recurring subscription $valchoice
  • True

How To Install

YouTube Tutorial
IMAGE ALT TEXT HERE

Bugs and Suggestion

Open an issue on github or join offical TouchPortal Discord for support.

License

This plugin is licensed under the [GPL 3.0 License] - see the LICENSE file for more information.