Skip to content

Latest commit

Β 

History

28 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ’Έ StreamPe

A free, open-source, ultra-fast, and self-hosted solution to display real-time mobile payment alerts, donation goal bars, top supporter leaderboards, recent donation history, and auto-cycling widgets directly on your OBS Studio or Streamlabs live stream.


πŸ“Έ Previews & Screenshots

πŸ’» Desktop Client & Web Control Panel

πŸ“Š Earning Overview & Analytics πŸŽ›οΈ Live Alert Customizer & OBS Preview
StreamPe Earning Overview Live Alert Customizer
Interactive earnings dashboard with income charts & payment breakdowns Real-time alert customizer with live transparent OBS overlay grid
🎯 Payment Goal Bar Widget πŸ† Unified List Widget System
Payment Goal Bar Top Supporters & Recent List
Configurable donation goal track, fill colors, and progress overflow Modular list widget system for Top Supporters and Recent Donations
πŸ”„ Auto-Cycling Info Widget ⚑ Native Desktop App & System Tray
Auto Cycling Widget StreamPe Desktop App
Rotational info widget cycling through custom cards & recent alerts Ultra-lightweight Tauri v2 + Bun desktop app (< 25 MB RAM)

πŸ“± Android Companion App Features

πŸ“‘ Server Auto-Discovery (mDNS) πŸ“‹ 3-Slide Permission Setup 🎯 App Selector
Server Auto Discovery Permission Setup App Selector
Native mDNS local scanning & IP history chips Concise 3-slide onboarding setup Select payment apps (PhonePe, GPay, Amazon)
πŸ”” Notification Tester & Presets πŸ“œ Alert History & Retrigger Log
Notification Tester Alert History Log
Test payment alerts for GPay, PhonePe, and Amazon Pay Permanent local log of received alerts with 1-click retriggering

πŸ“Œ Key Highlights & Features

⚑ Ultra-Lightweight Desktop Client (Tauri v2 + Bun)

  • Minimal Resource Footprint: Built with Tauri v2 and Bun β€” uses < 25 MB RAM with instant startup and zero UI rendering lag.
  • Dual Release Distribution: Available as both a standard Windows Setup Installer (.exe) and a Zero-Install Portable ZIP (.zip).
  • System Tray Integration: Minimizes cleanly to the taskbar system tray so your server stays running invisibly in the background.
  • Start Minimized & Start on Boot: Option to launch silently into the system tray or on Windows startup automatically.
  • One-Click Control Panel: Launch the full web control panel in your default web browser at http://127.0.0.1:2907/config.

🎨 Fully Customizable Overlays & Live Preview

  • Live Transparent Grid Preview: Real-time live preview iframe with transparent checkerboard background.
  • Dynamic Background & Backdrop Blur: Adjust background opacity from 0% to 100% with automatic backdrop blur scaling (blurs to 0px at 0% opacity to reveal crisp transparency).
  • Customizable Borders: Adjustable border width (px) and border color for all widgets (set border width to 0 to turn off borders completely).
  • Lucide Icon Picker: Access 60+ vector icons for Cycling Widgets and custom overlay templates.
  • Cycling Widget: Automatically cycles between Recent Donation & Top Supporter with configurable In/Out animation effects and duration timings.

πŸ”’ 100% Private & Safe (Local Network Only)

  • Runs Completely Local: Operates entirely within your local network (http://<YOUR-PC-IP>:2907).
  • No External Cloud Servers: Zero third-party payment gateways, intermediate cloud servers, or subscription fees.
  • Data Security: Your payment amounts, bank notifications, and financial details stay 100% private and secure on your own devices.

πŸ“± Recommended Payment Apps: Google Pay & PhonePe

Tip

Google Pay & PhonePe are Highly Recommended ⚑

  • Google Pay (GPay) & PhonePe work best because they ONLY require Notification Listener Access on Android.
  • πŸ’¬ Google Pay supports Donor Messages: Google Pay notifications include both the donation amount and the donor's custom message/note (e.g. Rahul paid you β‚Ή500 + "Keep up the great stream! πŸ”₯").
  • ⚑ PhonePe supports Amount: PhonePe notifications include the donor name and amount (PhonePe does not include custom donor messages in its notification banner).
  • Zero Accessibility Permissions Required: Both Google Pay and PhonePe work 100% without Accessibility Services. (Payment apps like Amazon Pay may require Accessibility Service Fallbacks if amounts are masked by Android).

πŸ”’ Android Permissions & Security Explained

Permission Required For Security & Privacy Note
android.permission.INTERNET Local Network Communication Required by Android OS to open WebSocket TCP connections to your PC (ws://<YOUR-PC-IP>:2907). Zero data is sent to external internet/cloud servers.
BIND_NOTIFICATION_LISTENER_SERVICE Payment Notification Reader Allows the companion app to detect incoming payment notifications (Google Pay, PhonePe, Amazon Pay).
FOREGROUND_SERVICE Background Stream Connection Keeps the local WebSocket connection active in the background while streaming.
RECEIVE_BOOT_COMPLETED Auto Start on Boot Automatically restarts the local background service when your Android phone reboots.
REQUEST_IGNORE_BATTERY_OPTIMIZATIONS Uninterrupted Alert Service Prevents Android OS battery saver from putting the background connection to sleep during long streams.

⬇️ How to Install & Use (Streamer Setup)

1. Download Pre-Built Release

  • Visit the official GitHub Releases Page.
  • Download StreamPe-v2.0.0-Portable.zip (Zero-install portable archive).
  • Extract the ZIP file to any folder on your PC.

2. Launch the Application

  • Run StreamPe.exe.
  • Run as Administrator: If network discovery isn't working, right-click the app and select Run as Administrator.
  • Firewall Permission: When Windows Security Alert appears, check both Private and Public networks and click Allow Access.
  • The app starts on port 2907 by default.
  • Click Open Control Panel in Browser to open the full dashboard in Chrome/Edge/Brave.

3. Connect Your Android Phone

  • Install the companion Android App APK on your phone.
  • Enter your PC's Connection URL displayed in the desktop app (e.g., http://192.168.1.5:2907).
  • Grant Notification Access when prompted.

4. Add Overlays in OBS Studio

In OBS Studio, click + (Add Source) βž” Browser:

Overlay Type URL Recommended Size
πŸ“‘ Payment Alert Widget http://<YOUR-PC-IP>:2907/overlay/alerts 800 x 600
🎯 Payment Goal Bar http://<YOUR-PC-IP>:2907/overlay/goal 800 x 120
πŸ† Top Leaderboard http://<YOUR-PC-IP>:2907/overlay/list?id=top-supporters 400 x 600
πŸ“œ Recent Donations List http://<YOUR-PC-IP>:2907/overlay/list?id=recent-donations 400 x 600
πŸ”„ Cycling Widget http://<YOUR-PC-IP>:2907/overlay/cycling-widget 400 x 140

πŸ› Report Issues, FAQ & Feedback

Check our Frequently Asked Questions (FAQ) & Troubleshooting Guide for step-by-step help with Android Play Protect, Android 13+ Restricted Settings, battery optimization, and network setup!


πŸ› οΈ How to Build from Source (Developer Guide)

git clone https://github.com/clowneon1/streampe.git
cd streampe/pc-server
npm install

Development Server:

# Start local Node.js server (with auto-reload)
npm run dev

Run Tauri Desktop Client in Dev Mode:

npm run app:dev

Build Final Portable Release ZIP:

npm run app:dist

Outputs StreamPe-v2.0.0-Portable.zip into dist/.


πŸ“„ License & Credits

Developed with ❀️ by clowneon1.
Distributed under the MIT License. ⭐ If you like this project, please give it a star on GitHub!

About

Real-Time Mobile Payment Alerts Overlays

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages