Update README.md

2025-10-05 13:49:07 +02:00
parent 759910802c
commit 231de42412
1 changed files with 70 additions and 55 deletions
--- a/README.md
+++ b/README.md
@@ -2,72 +2,87 @@

 [📄 CHANGELOG.md](CHANGELOG.md) · [📄 INSTALL.md](INSTALL.md) · [📄 ROADMAP.md](ROADMAP.md)

-# README — DA
+# Twitch PHP Bot 🇩🇰 / 🇬🇧

-Dette projekt er et **PHP-baseret starterkit** til en **Moderator Platform** til Mix It Up Bot, som kører på **Windows** med lokale brugere (uden Twitch-login). Systemet giver **SU-Admin** og **Moderatorer** adgang til administration af kommandoer, filer, events m.m. direkte via en webgrænseflade.
-
-## Funktioner
- Login-system (lokale brugere gemt i MySQL)
- Roller: SU-Admin, Moderator, Redaktør
- Dashboard med basisfunktioner
- Kommandooversigt (stub – klar til at blive udvidet)
- Fil-editor (`storage/files/*.txt`) hvor Moderator og SU-Admin kan redigere
- Database-opsætning (`schema.sql` + `seed.sql`)
- Klar til integration med Mix It Up API via `app/MixItUpService.php`
-
-## Installation (Windows + XAMPP)
-1. Installer **XAMPP** (Apache, PHP 8.2+, MariaDB).
-2. Opret database, kør `database/schema.sql` + `database/seed.sql`.
-3. Placer mappen i `C:\xampp\htdocs\mod-platform`.
-4. Ret `app/config.php` (DB login, base_url, MixItUp API).
-5. Start Apache & MySQL i XAMPP.
-6. Gå til `http://localhost/mod-platform/public/login.php`.
-7. Log ind med: **admin / ChangeMe!2025** (skift straks kodeord!).
+En letvægts **Twitch Chat Bot** skrevet i **PHP**, der kører direkte på en webserver som **XAMPP** eller **Apache**, uden Node.js eller eksterne services.  
+Webinterface til styring af kommandoer, timers, polls, giveaways, loyalty points og brugere.

 ---

-# README — EN
+## ✨ Features

-This project is a **PHP-based starter kit** for a **Moderator Platform** for Mix It Up Bot, running on **Windows** with local users (no Twitch login). The system provides **SU-Admin** and **Moderators** access to manage commands, files, events, and more via a web interface.
-
-## Features
- Login system (local users stored in MySQL)
- Roles: SU-Admin, Moderator, Editor
- Dashboard with basic controls
- Commands overview (stub – ready to be expanded)
- File editor (`storage/files/*.txt`) where Moderator and SU-Admin can edit
- Database setup (`schema.sql` + `seed.sql`)
- Ready for Mix It Up API integration via `app/MixItUpService.php`
-
-## Installation (Windows + XAMPP)
-1. Install **XAMPP** (Apache, PHP 8.2+, MariaDB).
-2. Create database, run `database/schema.sql` + `database/seed.sql`.
-3. Place project folder in `C:\xampp\htdocs\mod-platform`.
-4. Edit `app/config.php` (DB login, base_url, MixItUp API).
-5. Start Apache & MySQL in XAMPP.
-6. Open `http://localhost/mod-platform/public/login.php`.
-7. Login with: **admin / ChangeMe!2025** (change password immediately!).
+- Twitch IRC chat-bot (PHP socket)
+- Dashboard med login og rettigheder
+- Kommandoer med placeholders (`@$user`, `@$target`, `{uptime}`, `!points`, …)
+- Live log (SSE + WebSocket fallback)
+- Timers, Polls, Giveaways
+- Loyalty points + Bets, Slots, Raffle
+- Helix API-integration (subs, mods, VIPs, cheerers, uptime, osv.)
+- Rettighedsstyring (Admin / Mod / User)
+- SQLite database – ingen ekstern DB
+- Dansk/Engelsk dokumentation

 ---

-# Beskrivelse — DA
+## ⚙️ Krav / Requirements

-Moderator Platform er udviklet for at give en samlet og brugervenlig webgrænseflade til styring af Mix It Up Bot. Den gør det muligt for moderatorer og admins at:
- Oprette og redigere kommandoer
- Administrere events og timere
- Se og ændre i tekstfiler (fx citater)
- Udvides med moderation, statistik og logs
-
-Målet er at skabe et fleksibelt og sikkert værktøj, som kan køre direkte på din Windows-server sammen med Mix It Up Bot.
+- PHP **8.1+**
+- Extensions: `pdo_sqlite`, `curl`, `mbstring`, `json`
+- Webserver (XAMPP, Apache, Nginx …)
+- Twitch OAuth-token: [https://twitchapps.com/tmi/](https://twitchapps.com/tmi/)
+- (Valgfrit) Node.js + `ws` for WebSocket-live-log

 ---

-# Description — EN
+## 🚀 Installation

-Moderator Platform is built to provide a unified and user-friendly web interface for managing Mix It Up Bot. It allows moderators and admins to:
- Create and edit commands
- Manage events and timers
- View and edit text files (e.g., quotes)
- Extend with moderation, statistics, and logs
+Se [INSTALL.md](INSTALL.md) for komplette trin.

-The goal is to deliver a flexible and secure tool that runs directly on your Windows server alongside Mix It Up Bot.
+---
+
+## 🔐 Login
+
+Efter første installation:
+- Brugernavn: `admin`
+- Adgangskode: `lan2025`  
+(kan ændres under **Indstillinger**)
+
+---
+
+## 📁 Struktur
+
+/bot
+├── /data
+│ ├── app.db
+│ ├── bot.log
+│ └── settings.json
+├── /web
+│ ├── index.php # Dashboard
+│ ├── settings.php # Indstillinger + brugere
+│ ├── commands.php # Kommandoer
+│ ├── timers.php # Timers
+│ ├── poll.php # Polls
+│ ├── points.php # Loyalty Points
+│ ├── db.php, guard.php, api.php …
+├── bot.php # PHP-socket bot
+├── ws_server.js # WebSocket server
+├── .env # Twitch credentials
+
+yaml
+Kopier kode
+
+---
+
+## 📄 Filer
+
+- [CHANGELOG.md](CHANGELOG.md) – versionshistorik  
+- [ROADMAP.md](ROADMAP.md) – planlagte funktioner  
+- [LICENSE](LICENSE) – MIT-licens
+
+---
+
+## 🧡 Credits
+
+Udviklet af **Thomas / DjGulvBasS**  
+Med hjælp fra **ChatGPT (OpenAI)**  
+MIT Licenseol that runs directly on your Windows server alongside Mix It Up Bot.