shadowdaoandClaude Sonnet 5.5 1c6d93ad5f
Test and Release / test (push) Successful in 1m14s
Test and Release / release (push) Successful in 4s
Test: schema version assertion is a minimum, not an exact value
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-15 12:50:35 -08:00
2026-11-15 12:45:45 -08:00

StreamGoals Donate

PayPal donations for WordPress, built for streamers: multiple donation goals, optional "cover the fees", and OBS overlays (goal bar, subathon timer, counter, donation alerts) that update live.

Requires WordPress 7.x, PHP 8.1+, and a PayPal Business account to take live payments (see below).

Install

  1. Download streamgoals-donate.zip from the latest release.
  2. WordPress admin → Plugins → Add New → Upload Plugin → activate.
  3. Open StreamGoals in the admin menu. The setup wizard walks you through the rest.

Which PayPal account?

  • Testing: nothing special. PayPal's Sandbox gives every developer account a sandbox business account (the seller) and a sandbox personal account (the buyer).
  • Live payments: PayPal's developer policy requires a Business account to go live. Upgrading a Personal account is free, and a personal name is fine (no company needed).
  • PayPal's User Agreement also expects accounts used mainly for business or donation-taking to be Business accounts; a Personal account used that way risks limits or closure. Read PayPal's current terms before going live.

Connect PayPal (about 5 minutes)

You need two values from PayPal: a Client ID and a Secret.

  1. Go to https://developer.paypal.com and log in with your PayPal Business account.
  2. Open Apps & Credentials. Use the Sandbox toggle for testing, Live for real money.
  3. Click Create App, name it anything (e.g. "My Donations"), type Merchant.
  4. Copy the Client ID and Secret into the StreamGoals wizard (Step 1).
  5. Click Test connection. On success the plugin registers its webhook with PayPal automatically.

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.

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.
  • Cross-border and currency-conversion fees are not included in the estimate, so a covered donation from another country can net slightly less than intended.
  • One currency per site. PayPal converts for donors paying from another currency.
  • Donations are not tax-deductible. Don't present them as such.

Using it

  • Donation page: add the shortcode [streamgoals_donate] to a page (or [streamgoals_donate goal="ID"] to pin one goal).
  • Goals: StreamGoals → Goals. Create as many as you like; each can have its own rules.
  • Rules (time and counters): per goal, e.g. "+60 seconds per $1" (subathon timer), "+1 per $10" (counter), or a bonus event above a minimum amount. Amounts can be measured on the base donation or including fee cover.
  • Overlays: StreamGoals → Overlays. Copy a widget URL into OBS as a Browser Source (suggested 800×200 for the goal bar; transparent background is built in). Keep the URL private; "Regenerate token" invalidates it.
  • Rewards (actions for set amounts): StreamGoals > Rewards. Add things you do on stream for a set amount, for example "$5: eat an every-flavor bean" or "$25: 25 pushups". Each reward is either exactly this amount or every time the donation adds up to this amount (a $10 donation triggers a $5 reward twice). Rewards appear as buttons on the donation 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.
  • Test: "Send test donation" on the Overlays screen shows an alert without touching real totals.

Privacy and moderation

  • Donors choose a name or "Anonymous". For anonymous donors the name is never stored.
  • Optional message approval queue and a streamer-controlled profanity filter (whole-word, your own word list).

Not supported

  • Refunds and chargebacks are not tracked. If you refund someone in PayPal, goal totals, timers and counters are not adjusted.

Updates

New versions appear in WordPress automatically (Dashboard > Updates and the Plugins screen), checked against this repository's releases. The repository is public, so no token is needed. (If you run a private fork, paste an access token with read access to releases in StreamGoals > Settings > Advanced > Plugin updates.) You can switch automatic updates on or off for this plugin on the Plugins screen, and use "Check for updates now" in StreamGoals > Settings > Advanced to look straight away.

Development

composer install
vendor/bin/phpunit

Architecture notes are in docs/ARCHITECTURE.md. Every push to main runs the tests and, if they pass, publishes a versioned zip release via Gitea Actions.

S
Description
StreamGoals Donate: PayPal donations, goals and OBS stream overlays for WordPress
Readme GPL-2.0
777 KiB
0 Stars 1 Watchers 0 Forks
2026-11-15 22:09:14 +00:00
Languages
PHP 87.8%
JavaScript 8.8%
CSS 3.4%