AuraEconomy README

README проекта с github.com/AhmadHassan-BTed/AuraEconomy. Одним файлом markdown: 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)

Ищем в базе…

Что это такое?AuraEconomy — это система геймификации для стримов на Twitch, которая работает внутри Streamer.bot: время просмотра зрителей превращается в очки, ранги и ставки, а результаты выводятся в реальном времени на оверлей OBS.
Это отдельная программа или она подключается к чему-то ещё?Это не отдельная программа — это C#-скрипт 'Inline', который вставляется в Streamer.bot, и файл оверлея на Vanilla JS/HTML, поэтому он работает только вместе со Streamer.bot и OBS.
Как запустить это на моём стриме?Выполни schema.sql в инструменте для SQLite, чтобы создать базу данных, укажи DBPATH в EconomySystem.cs, вставь блоки кода в действия Streamer.bot, затем добавь Overlay.html как источник Browser Source в OBS размером 1920x1080.
Нужны ли мне Streamer.bot и OBS, чтобы всё работало?Да — логика экономики работает как C# Inline-код внутри Streamer.bot, а оверлей — это браузерный источник для OBS; отслеживание времени просмотра также зависит от нативного триггера 'Present Viewers' в Streamer.bot.
Есть ли подводные камни при настройке, о которых мне стоит знать?Начисление очков за время просмотра работает корректно только при подключении к триггеру 'Present Viewers' в Streamer.bot, а оверлей рассчитан на фиксированный источник Browser Source 1920x1080, поэтому для других разрешений может понадобиться ручная настройка.
Какие ранги могут получить зрители?Есть 10 уровней: от 'Wood' до престижного ранга 'Eternal'. У каждого свой порог очков, лимит ставки и цвет свечения Aura — от Wood (0 очков, лимит 25) до Eternal (топ-3, лимит 10 000).
Что происходит с очками при ежемесячном сбросе?Сезонные очки сбрасываются каждый месяц, но общая статистика и самый высокий ранг зрителя за всё время сохраняются как постоянный окрашенный значок 'Legacy Aura'.
Как работает функция ставок?В AuraEconomy есть система ставок Win/Loss с эскроу: максимальная сумма, которую зритель может поставить, ограничена его текущим рангом.
Зачем используется SQLite в режиме WAL?Режим WAL позволяет Streamer.bot и внешним инструментам, например плагину для Minecraft, одновременно читать и записывать один и тот же файл базы данных без проблем с блокировками.
Какие есть похожие проекты?iPhoneMirror, DmNote, NCE, Transub-Player, impress.js, SoulMatrix, simplefolio, JavaScript30
Размер
0.1 MB
Звёзды
2.8K
Обновлён
КоммитJun 30
Возраст
6 мес
Коммиты · 90 дней