Skip to content

croziors/follower

Repository files navigation

🎮 KRIPY Follower & Raid Tracker

Overlay Twitch avec style Liquid Glass pour suivre vos followers et raids en temps réel.

⚡ Installation Express

5 minutes pour démarrer : QUICKSTART.md

📋 Guides Complets

🎯 Prérequis

  • Docker Desktop pour Windows
  • Un compte développeur Twitch
  • Client ID et Client Secret Twitch

🔧 Configuration

1. Configuration Twitch API

  1. Allez sur Twitch Developer Console
  2. Créez une nouvelle application
  3. Notez votre Client ID et Client Secret
  4. Éditez le fichier config/config.json :
{
  "twitch": {
    "clientId": "VOTRE_CLIENT_ID_ICI",
    "clientSecret": "VOTRE_CLIENT_SECRET_ICI",
    "redirectUri": "http://localhost:3000/auth/callback",
    "scopes": ["channel:read:subscriptions", "moderator:read:followers"]
  }
}

2. Déploiement avec Docker

  1. Ouvrez PowerShell ou Command Prompt
  2. Naviguez vers le dossier follower
  3. Construisez et lancez le conteneur :
docker-compose up -d --build

🚀 Utilisation

Accès à l'overlay

Configuration de votre canal

  1. Ouvrez votre navigateur sur http://127.0.0.1:3000
  2. Ouvrez la console du navigateur (F12)
  3. Configurez votre canal Twitch :
// Remplacez "votre_nom_twitch" par votre nom d'utilisateur
fetch('/api/setup', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ username: 'votre_nom_twitch' })
})

Tests

Pour tester l'overlay sans attendre de vrais événements :

// Tester un follower
testFollower('TestUser');

// Tester un raid
testRaid('TestRaider', 42);

🎨 Intégration OBS

  1. Ajoutez une source "Navigateur" dans OBS
  2. URL : http://127.0.0.1:3000
  3. Largeur : 150px
  4. Hauteur : 120px
  5. Activez "Contrôler l'audio via OBS"

📊 API Endpoints

  • GET / - Page principale de l'overlay
  • GET /api/events - Récupère les derniers événements
  • POST /api/setup - Configure le canal Twitch
  • GET /api/test/follower - Test d'un nouveau follower
  • GET /api/test/raid - Test d'un nouveau raid

🛠 Commandes Docker

# Construire et lancer
docker-compose up -d --build

# Voir les logs
docker-compose logs -f

# Arrêter le service
docker-compose down

# Redémarrer
docker-compose restart

# Reconstruire après modification
docker-compose down && docker-compose up -d --build

🔍 Dépannage

Le conteneur ne démarre pas

  • Vérifiez que Docker Desktop est lancé
  • Vérifiez que le port 3000 n'est pas utilisé par une autre application

Pas de nouveaux followers détectés

  • Vérifiez vos credentials Twitch dans config/config.json
  • Assurez-vous que votre nom d'utilisateur est correct
  • Utilisez les routes de test pour vérifier que l'overlay fonctionne

L'overlay ne s'affiche pas dans OBS

  • Vérifiez que l'URL est correcte : http://127.0.0.1:3000
  • Essayez de rafraîchir la source navigateur
  • Vérifiez les dimensions (150x120px)

📝 Notes importantes

  • Les credentials Twitch ne sont jamais exposés dans le code frontend
  • Le système fonctionne en mode test même sans credentials valides
  • Les raids sont simulés pour les tests (EventSub requis pour les vrais raids)
  • L'overlay est optimisé pour le streaming avec un fond transparent

🔒 Sécurité

  • Ne commitez JAMAIS vos credentials Twitch
  • Le fichier config/config.json contient des valeurs d'exemple
  • Utilisez des variables d'environnement en production

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published