Documentation

Overview

HyperTrain is a real-time donation train overlay system for streamers. It aggregates donations from multiple payment platforms and displays them as a unified "hype train" experience for your viewers.

  • Combines donations from Ko-fi, PayPal, Patreon, Tipeeestream, Fourthwall, and Twitch
  • Real-time overlay updates via WebSocket
  • Multiple customizable themes
  • Chatbot integration for Twitch chat announcements
  • QR code overlay for easy mobile donations

Getting Started

  1. Add the Overlay to OBS

    Copy your overlay URL from the Dashboard and add it as a Browser Source in OBS. Recommended size: 800x200 pixels.

  2. Connect Payment Sources

    Go to Dashboard → Payment Sources and enable the platforms you use. Each platform has its own setup instructions.

  3. Start a Train

    Click "Start Train" on the Dashboard. The train will appear on your overlay and start tracking donations.

Dashboard

Train Control

Start and stop trains manually. When active, shows real-time stats: current level, total donations, elapsed time, and time remaining on the current level.

Limit Indicators

Shows cooldown timer between trains and hourly train limits. Configure these in Settings.

Auto-Trigger Progress

If enabled, shows progress toward automatically starting a train when enough donations come in within a time window.

Overlay Themes

Classic

Clean gradient design with smooth animations. Great for most streams.

Neon

Cyberpunk style with glowing effects. Perfect for gaming streams.

Minimal

Compact and clean, perfect for smaller overlay areas.

Retro

Pixel art style with 8-bit aesthetics for retro gaming vibes.

Fire

Warm, fiery theme with flame animations for high energy streams.

C64

Commodore 64 style with PETSCII characters. Nostalgic retro computing vibes.

Superminimal

Ultra compact single-line overlay. Black/white only, barely visible.

Payment Sources

Ko-fi

Add your webhook URL in Ko-fi settings → Advanced → Webhooks.

PayPal

Configure IPN notifications in PayPal to point to your webhook URL.

Twitch

Requires Twitch Affiliate/Partner. Automatically connected through your Twitch login.

Patreon

Connect your Patreon account and configure webhook in Patreon settings.

Tipeeestream

Add webhook URL in Tipeeestream settings → API/Webhooks.

Fourthwall

Configure webhook in Fourthwall dashboard → Developer settings.

Twitch HypeTrain Integration

When Twitch starts a native HypeTrain on your channel, you can choose how HyperTrain responds:

  • Pause: Temporarily pause your train, resume when Twitch's ends.
  • Boost: Keep running and show a "Twitch HypeTrain active!" indicator.
  • Ignore: Completely ignore Twitch HypeTrains.
  • Stop: End your train completely (won't resume).

Chatbot

HyperTrainBot can announce train events in your Twitch chat.

Setup: The bot must be a moderator in your channel. Type /mod HyperTrainBot in your Twitch chat.

Announcements: Configure messages for train start, donations, level ups, timer warnings, and train end.

!train command: Viewers can type !train in chat to see current train status.

Settings

Level Thresholds

Configure the donation amounts required for each level (default: $5, $15, $30, $50, $75, $100...).

Timer Duration

How long the timer runs before the train ends (default: 5 minutes). Timer resets on level up.

Cooldown

Minimum time between trains to prevent spam (default: disabled).

Hourly Limit

Maximum number of trains per hour (default: disabled).

Auto-Trigger

Automatically start a train when X donations come in within Y minutes (default: disabled).

Moderator Control

Allow trusted moderators to start/stop trains on your behalf.

Billing

Free tier: HyperTrain is completely free until it makes you $30/month in donations.

Pro ($10/mo): Unlimited donations, priority support, all features.

When you exceed the free tier threshold, trains will be paused until you upgrade to Pro.

We only ask for money when you've made money with the system — essentially it pays for itself!