Explorar o código

Updated with information on new Kofi options

allens hai 2 semanas
pai
achega
26ce094ca4
Modificáronse 1 ficheiros con 5 adicións e 8 borrados
  1. 5 8
      README.md

+ 5 - 8
README.md

@@ -32,8 +32,7 @@ A chatbot for Owncast, enabling viewers to earn points which can be used to purc
  * Viewer management for manually adjusting viewers' points.
  * Viewer management for manually adjusting viewers' points.
  * A queue manager, where the streamer can mark rewards fulfilled as they go, or refund rewards if needed.
  * A queue manager, where the streamer can mark rewards fulfilled as they go, or refund rewards if needed.
 * Kofi integration.
 * Kofi integration.
- * Your viewers can get points for donating via kofi.
- * *Monthly dontation/subscription and shop integration coming next*
+ * Your viewers can get points for donating via Kofi, and as part of their monthly Kofi membership.
 
 
 ## Screenshots
 ## Screenshots
 #### Votes and Goals Overlays
 #### Votes and Goals Overlays
@@ -54,11 +53,9 @@ A chatbot for Owncast, enabling viewers to earn points which can be used to purc
 
 
 ## Roadmap
 ## Roadmap
 *Not necessarily in this order*
 *Not necessarily in this order*
-* Kofi monthly subscription benefits
- * Subscriber-only emojis, monthly points awards, etc.
+* Streak tracker, to track how many consecutive streams a viewer has watched, and reward accordingly
 * Get emojis in OwnchatBot panels working correctly, because my partner insists on it
 * Get emojis in OwnchatBot panels working correctly, because my partner insists on it
 * Audible sound when a goal is reached
 * Audible sound when a goal is reached
-* Streak tracker, to track how many consecutive streams a viewer has watched, and reward accordingly
 * Option to only allow authenticated users, followers, or Kofi subscribers to redeem certain rewards.
 * Option to only allow authenticated users, followers, or Kofi subscribers to redeem certain rewards.
 * !Timer - Set a timer that will sound an audible alarm. A command only available to the streamer or mods.
 * !Timer - Set a timer that will sound an audible alarm. A command only available to the streamer or mods.
 * A "watch" function that watches chat for certain words or phrases, and responds with preset messages.
 * A "watch" function that watches chat for certain words or phrases, and responds with preset messages.
@@ -147,7 +144,7 @@ You need to create a button on your Owncast page, so your viewers can access the
 
 
 #### Make sure you don't lose your viewers' benefits! It is extremely important that you back up your instance folder daily, if not hourly.
 #### Make sure you don't lose your viewers' benefits! It is extremely important that you back up your instance folder daily, if not hourly.
 
 
-Integration is accomplished via a webhook triggered by Kofi every time a donation is made. Again, this webhook is your external OwnchatBot server address with `/kofiHook` appended.
+Integration is accomplished via a webhook triggered by Kofi every time a donation or subscription is made. Again, this webhook is your external OwnchatBot server address with `/kofiHook` appended.
 
 
 Paste the webhook address into Kofi -> More -> API -> Webhooks -> Webhook URL.
 Paste the webhook address into Kofi -> More -> API -> Webhooks -> Webhook URL.
   ```
   ```
@@ -160,9 +157,9 @@ You need the verification token the Kofi to send when it triggers the webhook.
 Below "Webhook URL", click on "Advanced".
 Below "Webhook URL", click on "Advanced".
 A pre-generated token will already be there. Copy that token, and paste it into the OCB Management Panel -> Settings -> Kofi Integration -> Verification Token. Then click "Save Changes".
 A pre-generated token will already be there. Copy that token, and paste it into the OCB Management Panel -> Settings -> Kofi Integration -> Verification Token. Then click "Save Changes".
 
 
-OwnchatBot associates viewer accounts with Kofi accounts using their email address. So in order for viewers to get Kofi benefits in-stream, they must enter their email address in OwnchatBot viewer panel -> OwnchatBot Info -> Kofi. It **must** be the same email address associated with their Kofi account.
+OwnchatBot associates viewer accounts with Kofi accounts using the viewer's email address. So in order for viewers to get Kofi benefits in-stream, they must enter their email address in OwnchatBot viewer panel -> OwnchatBot Info -> Kofi. It **must** be the same email address associated with their Kofi account.
 
 
-If a viewer donates before entering their email address, OwnchatBot creates a temporary entry with their email and donation amount, and then applies it once the viewer enters their email address into the viewer panel. If there is any sort of mix-up here, the streamer can manually connect the viewer's email and account via the management panel by entering the email into the viewers account. OwnchatBot will do the merge automatically.
+If a viewer donates/subscribes before entering their email address, OwnchatBot creates a temporary entry with their email and points award, and then applies it once the viewer enters their email address into the viewer panel. If there is any sort of mix-up here, the streamer can manually connect the viewer's email and account via the management panel by entering the email into the viewers account. OwnchatBot will do the merge automatically.
 
 
 Email addresses are **ONLY** used for Kofi integration. They are not sent to any other individual or company, will not be used to create or send mailing lists of any kind, or for any other purposes. Ever.
 Email addresses are **ONLY** used for Kofi integration. They are not sent to any other individual or company, will not be used to create or send mailing lists of any kind, or for any other purposes. Ever.