SUStats Bot - Dokumentacja

Kompletny przewodnik po instalacji, konfiguracji i używaniu bota SUStats do monitorowania statystyk gier Among Us z modem Town of Us.

1. Instalacja

a) Pobierz zmodyfikowany Town of Us

Aby korzystać z systemu SUStats, potrzebujesz specjalnej wersji moda Town of Us z wbudowanym eksporterem danych.

💡 Ważne: Ta wersja moda automatycznie wysyła statystyki gier do naszego API, umożliwiając śledzenie wyników w czasie rzeczywistym.
📥 Pobierz Town of Us + SUStats

Wersja kompatybilna z Among Us v2024.3.5

b) Generator konfiguracji ApiSet.ini

Użyj poniższego kreatora, aby wygenerować plik konfiguracyjny dla Twojego serwera:

Krok 1: ID Serwera Discord

Podaj ID Twojego serwera Discord (tylko cyfry):

Jak znaleźć ID serwera? Kliknij prawym na nazwę serwera → Kopiuj ID

Krok 2: Klucz bezpieczeństwa

Wygeneruj bezpieczny klucz lub wpisz własny:

Krok 3: Serwer API

Adres serwera API (pozostaw domyślny):

Krok 4: Lokalne kopie zapasowe

Czy zapisywać pliki JSON lokalnie?

c) Instalacja plików

Krok 1: Lokalizacja katalogu Among Us

Znajdź folder z grą Among Us. Typowe lokalizacje:

  • Steam: C:\Program Files (x86)\Steam\steamapps\common\Among Us\
  • Epic Games: C:\Program Files\Epic Games\AmongUs\
  • Itch.io: Folder gdzie zainstalowałeś grę

Krok 2: Kopiowanie plików moda

  1. Rozpakuj pobrany plik ZIP z modem Town of Us
  2. Skopiuj wszystkie pliki do folderu BepInEx\plugins\ w katalogu Among Us
  3. Skopiuj wygenerowany plik ApiSet.ini do tego samego folderu
⚠️ Uwaga: Jeśli folder BepInEx\plugins\ nie istnieje, uruchom grę raz z zainstalowanym BepInEx, aby utworzyć strukturę folderów.

Krok 3: Weryfikacja instalacji

Struktura folderów powinna wyglądać tak:

Among Us/
├── BepInEx/
│   ├── plugins/
│   │   ├── TownOfUs.dll
│   │   ├── SUStatsExporter.dll
│   │   └── ApiSet.ini
│   └── ...
└── Among Us.exe

d) Dodaj bota do swojego serwera

Aby móc korzystać z komend i powiadomień, dodaj bota SUStats do swojego serwera Discord:

Wymagane uprawnienia:

  • Wysyłanie wiadomości
  • Osadzanie linków
  • Używanie komend slash
  • Wyświetlanie kanałów
💡 Wskazówka: Po dodaniu bota użyj komendy /suconfig channel aby skonfigurować kanał do powiadomień o grach.

2. Komendy Discord

/sustat - Statystyki Among Us

Główna komenda do wyświetlania statystyk gier Among Us. Oferuje różne tryby wyświetlania danych.

/sustat serwer [type]

Opis: Wyświetla statystyki całego serwera

Parametry:

  • type (opcjonalny) - typ statystyk:
    • general - ogólne statystyki (domyślne)
    • players - top gracze
    • roles - role i meta
    • activity - aktywność serwera

Przykład użycia:

/sustat serwer type:players

Zwracane informacje:

  • Liczba rozegranych gier
  • Unikalni gracze
  • Statystyki zwycięstw drużyn
  • Średni czas gry
  • Ranking najlepszych graczy

/sustat nick <nick> [detailed]

Opis: Wyświetla zaawansowane statystyki konkretnego gracza

Parametry:

  • nick (wymagany) - nazwa gracza w Among Us
  • detailed (opcjonalny) - pokaż szczegółowe statystyki ról

Przykład użycia:

/sustat nick:Boracik detailed:true

Zwracane informacje:

  • Podstawowe statystyki (gry, zwycięstwa, czas gry)
  • Statystyki walki (kille, celność, assassin)
  • Wykonywanie zadań
  • Statystyki per kategoria ról
  • Ulubione role i mapy
  • Historia aktywności
  • Szczegółowe statystyki ról (jeśli detailed=true)

/sustat day <day> [game]

Opis: Statystyki dla konkretnego dnia lub gry

Parametry:

  • day (wymagany) - data w formacie YYYY-MM-DD (z autocomplete)
  • game (opcjonalny) - ID konkretnej gry (z autocomplete)

Przykład użycia:

/sustat day:2024-01-15
/sustat day:2024-01-15 game:12345

Funkcje autocomplete:

  • Automatyczne podpowiedzi dostępnych dni z liczbą gier
  • Lista gier z danego dnia z czasem, wynikiem i liczbą graczy

/suconfig - Konfiguracja bota

Komendy administracyjne do zarządzania ustawieniami bota na serwerze.

🔒 Wymagane uprawnienia: Zarządzaj kanałami

/suconfig channel <kanal>

Opis: Ustawia kanał dla powiadomień o zakończonych grach

Parametry:

  • kanal (wymagany) - kanał tekstowy Discord

Przykład użycia:

/suconfig channel kanal:#among-us-gry

Weryfikacje:

  • Sprawdza czy kanał jest tekstowy
  • Weryfikuje uprawnienia bota do pisania
  • Zapisuje konfigurację w bazie danych

/suconfig show

Opis: Pokazuje aktualną konfigurację serwera

Przykład użycia:

/suconfig show

Wyświetlane informacje:

  • Aktualny kanał powiadomień
  • Data ostatniej aktualizacji
  • Status kanału (czy istnieje)

/suconfig reset

Opis: Resetuje konfigurację i wyłącza powiadomienia

Przykład użycia:

/suconfig reset

Automatyczne powiadomienia

Bot automatycznie monitoruje API co 30 sekund w poszukiwaniu nowych gier. System powiadomień działa w tle i wysyła informacje o zakończonych grach na skonfigurowany kanał.

Jak działają powiadomienia:

  1. Monitorowanie: Bot sprawdza nowe gry co 30 sekund
  2. Detekcja: Wykrywa gry z ID większym niż ostatnio sprawdzony
  3. Analiza: Określa zwycięską drużynę na podstawie ról i modyfikatorów
  4. Wysyłanie: Tworzy embed z informacjami o grze

Zawartość powiadomienia:

  • 🏆 Zwycięska drużyna (z kolorowym emoji)
  • ⏱️ Rzeczywisty czas trwania rundy
  • 👥 Liczba graczy
  • 🗺️ Mapa (jeśli dostępna)
  • 📋 Lista graczy z rolami i statusem (zwycięzca/przegrany)
  • ⭐ Specjalni zwycięzcy (jeśli są)
  • 🏠 Kod lobby i ID gry

Inteligentne określanie zwycięzców:

System automatycznie analizuje role i modyfikatory, aby określić zwycięską drużynę:

  • Lover Couple: Wykrywa pary kochanków na podstawie modyfikatorów
  • Neutrals: Identyfikuje zwycięstwa ról neutralnych
  • Crewmates/Impostors: Standardowe drużyny

Obliczanie czasu rundy:

Bot oblicza rzeczywisty czas trwania rundy, odejmując czas poprzedniej gry w tym samym lobby:

Czas rundy = Czas obecnej gry - Czas poprzedniej gry w lobby
💡 Wskazówka: Powiadomienia są wysyłane tylko na serwery, które mają skonfigurowany kanał za pomocą /suconfig channel.

Wymagania dla powiadomień:

  • Skonfigurowany kanał powiadomień
  • Bot musi mieć uprawnienia do pisania na kanale
  • Kanał musi istnieć i być dostępny
  • Serwer musi być w cache bota
⚠️ Rozwiązywanie problemów:
  • Jeśli powiadomienia nie działają, sprawdź uprawnienia bota
  • Upewnij się, że kanał nie został usunięty
  • Sprawdź logi bota pod kątem błędów połączenia z API

Rozwiązywanie problemów

❌ Bot nie odpowiada na komendy

Możliwe przyczyny i rozwiązania:

  1. Sprawdź czy bot jest online na serwerze
  2. Upewnij się, że bot ma uprawnienia do używania komend slash
  3. Spróbuj ponownie dodać bota z odpowiednimi uprawnieniami
  4. Sprawdź czy komendy są zarejestrowane (może potrwać do 1 godziny)

📊 Brak statystyk gracza

Możliwe przyczyny:

  • Gracz nie grał jeszcze z zainstalowanym modem SUStats
  • Nieprawidłowa konfiguracja ApiSet.ini
  • Błąd w nazwie gracza (sprawdź dokładną pisownię)

Rozwiązanie:

  1. Sprawdź czy plik ApiSet.ini jest w folderze BepInEx\plugins
  2. Upewnij się, że gracz rozegrał przynajmniej jedną grę z modem
  3. Sprawdź logi Among Us pod kątem błędów eksportu

🔕 Powiadomienia nie działają

Lista kontrolna:

  1. Użyj /suconfig show aby sprawdzić konfigurację
  2. Upewnij się, że kanał istnieje i bot ma do niego dostęp
  3. Sprawdź uprawnienia bota: Wyświetlanie kanału, Wysyłanie wiadomości, Osadzanie linków
  4. Jeśli kanał został usunięty, ustaw nowy za pomocą /suconfig channel

⚙️ Problemy z instalacją moda

Najczęstsze problemy:

  • Brak folderu BepInEx: Zainstaluj BepInEx i uruchom grę raz
  • Mod się nie ładuje: Sprawdź czy wszystkie pliki DLL są w plugins
  • Błędy API: Sprawdź poprawność ApiSet.ini

Weryfikacja instalacji:

  1. Uruchom Among Us i sprawdź czy mod się ładuje
  2. Rozegraj testową grę
  3. Sprawdź czy dane pojawiają się w statystykach

🔑 Błędy autoryzacji API

Objawy: Gry nie są zapisywane, błędy w logach

Rozwiązanie:

  1. Sprawdź poprawność Token (ID serwera Discord)
  2. Upewnij się, że Secret spełnia wymagania bezpieczeństwa
  3. Wygeneruj nowy plik ApiSet.ini za pomocą kreatora
  4. Sprawdź czy ApiEndpoint jest poprawny
💬 Potrzebujesz pomocy?

Jeśli nadal masz problemy, skontaktuj się z nami: