diff --git a/README.md b/README.md index b7f781e..cc71f60 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,11 @@ You need two values from PayPal: a **Client ID** and a **Secret**. Start in **Sandbox**, make a test donation using a PayPal sandbox buyer account, then repeat the steps with the Live credentials and switch the mode to Live in Settings. +### Behind Cloudflare? +Nothing to do: the plugin recognises Cloudflare automatically (by its published addresses) so each visitor is rate +limited separately. For another proxy, choose it in StreamGoals > Settings > Advanced; the panel there shows what your +server sees. + ### Notes on fees and currency - "Cover the processing fees" adds an estimate based on the rates in Settings (default: US domestic, 3.49% + $0.49). Your actual PayPal rate depends on your account, country and payment method. @@ -51,6 +56,19 @@ with the Live credentials and switch the mode to Live in Settings. form, as a **Rewards menu** overlay for OBS, and as a highlighted line in the donation alert. Triggered rewards land in a **queue** on the Rewards screen so you can tick them off as you do them. Rewards count the donation amount, not the optional fee cover, and must be at least your minimum donation. +- **Alerts with pictures, GIFs, videos and sounds:** StreamGoals > Alerts. Pick files from your WordPress Media Library + (PNG, JPEG, GIF, WebP, MP4, WebM for the picture/video; MP3, OGG, WAV for sound). Tie an alert to **a donation size** + ("any donation of at least $5": the highest matching amount wins) or to **a reward** (a reward alert beats an amount + alert). Set the volume, how long a picture stays, and a message using `{name}`, `{amount}` and `{reward}`. In OBS media + plays automatically; in an ordinary browser tab click the page once before sound is allowed. Keep files small (videos + under about 25 MB). If a file is deleted the alert still shows, just without it. +- **Tiers (milestones):** on the Goals screen use **Tiers** to turn one goal into a ladder, for example $100 "Giveaway", + $250 "New microphone", $500 "24-hour stream". The goal bar shows the current tier and fills within it; unlocking a tier + shows a **TIER UNLOCKED** line in the alert and the bar moves on to the next one. The goal's final target is your highest + tier. The donation form shows "Next unlock: ... to go". +- **End at target:** tick "Close this goal to donations when the target is reached" on a goal. When the total reaches or + passes the target (for a tiered goal, the final tier) the goal closes and the donation page says so. Donations already + in checkout still go through. Use **Reopen** after raising the target. - **Test:** "Send test donation" on the Overlays screen shows an alert without touching real totals. ## Privacy and moderation