AuraEconomy README

The project's README from github.com/AhmadHassan-BTed/AuraEconomy. As one markdown file: README.md.

AuraEconomy: Advanced Streamer.bot Gamification System

An Open Source Project by Ahmad Hassan (B-Ted)

Status Platform Database

AuraEconomy is a high-performance, engagement-focused economy system for Twitch streamers. It combines a robust C# backend with a stunning Vanilla JS overlay to create a mini-RPG experience for your viewers.

Key Features

Project Structure

/
├── docs/
│   └── ImplementationGuide.md    # Simple step-by-step setup for non-technical users
├── src/
│   ├── bot/
│   │   └── EconomySystem.cs      # Core C# logic for Streamer.bot
│   ├── database/
│   │   └── schema.sql            # SQLite database structure & views
│   └── overlay/
│       ├── Overlay.html          # Vanilla JS Chat & Notification Overlay
│       └── icons/                # Rank icons (SVG)
└── README.md                     # Project overview

Quick Start

  1. Database: Run schema.sql in a SQLite tool to create your database file.
  2. Configuration: Open EconomySystem.cs and set your DB_PATH.
  3. Streamer.bot: Create actions and paste the corresponding code regions from EconomySystem.cs. Ensure "Watch Time" uses the 'Present Viewers' trigger.
  4. OBS: Add Overlay.html as a Browser Source (1920x1080).

For detailed instructions, see the Implementation Guide.

Tech Stack

Rank Thresholds

Rank Points Bet Cap Aura Color
Wood 0 25 #8B6914
Bronze 500 50 #CD7F32
Silver 1,500 100 #A8A9AD
... ... ... ...
Eternal Top 3 10,000 #FFE566

Developed with by Ahmad Hassan (B-Ted) for the streaming community.

AuraEconomy (AhmadHassan-BTed/AuraEconomy)

obs-studio
Searching Database…

1.7K ·GitHub
AuraEconomy
What is this?AuraEconomy is a gamification system for Twitch streams that runs inside Streamer.bot, turning viewer watch time into points, ranks, and bets, with the results shown live on an OBS overlay.
Is this a standalone app or does it plug into something else?It is not a standalone program — it is a C# 'Inline' script you paste into Streamer.bot plus a Vanilla JS/HTML overlay file, so it only works together with Streamer.bot and OBS.
How do I get this running on my stream?Run schema.sql in a SQLite tool to create the database, set DBPATH in EconomySystem.cs, paste the code regions into Streamer.bot actions, then add Overlay.html as a 1920x1080 OBS Browser Source.
Do I need Streamer.bot and OBS for this to work?Yes — the economy logic runs as C# Inline code inside Streamer.bot and the overlay is a browser source for OBS; watch-time tracking also depends on Streamer.bot's native 'Present Viewers' trigger.
Any setup pitfalls I should know about?Watch-time accrual only works correctly when wired to Streamer.bot's 'Present Viewers' trigger, and the overlay is built for a fixed 1920x1080 browser source, so other resolutions may need manual adjustment.
What ranks can viewers reach?There are 10 tiers from 'Wood' up to the prestigious 'Eternal' rank, each with its own point threshold, bet cap and Aura glow color, ranging from Wood (0 pts, cap 25) to Eternal (top 3, cap 10,000).
What happens to points at the monthly reset?Seasonal points reset every month, but lifetime stats and a viewer's highest-ever rank are preserved as a permanent 'Legacy Aura' colored badge.
How does the betting feature work?AuraEconomy has an escrow-based Win/Loss betting system where the maximum wager a viewer can place is capped according to their current rank.
Why does it use SQLite in WAL mode?WAL mode lets Streamer.bot and external tools, like a Minecraft plugin, read and write the same database file simultaneously without locking issues.
What are similar projects?iPhoneMirror, DmNote, NCE, Transub-Player, SoulMatrix, impress.js, PCL-CE, jellyfin
Which topics is it in?obs-studio, obs, glassmorphism, overlay, vanilla-javascript, html5, community, c#, csharp, websocket, real-time, streaming
Creator
AhmadHassan-BTed
Size
0.1 MB
Stars
1.7K
Updated
CommitJun 30
Age
5mo
Commits · 90 Days