Dokumentacja

Wszystko, czego potrzebujesz, żeby uruchomić overlay i go skonfigurować.

Pierwsze kroki

1. Załóż konto (email + hasło).
2. Wybierz szablon (możesz go potem swobodnie zmienić).
3. W panelu uzupełnij chatroomId i channelId (instrukcja niżej).
4. Skopiuj URL overlaya i wklej w OBS jako Browser Source 1920×1080.

Dodanie źródła w OBS

1. W OBS dodaj nowe źródło: Browser Source.
2. URL: https://overlay.streamtips.pl/streamer/twoj-nick
3. Szerokość: 1920, wysokość: 1080.
4. Custom CSS: zostaw puste.
5. Refresh browser when scene becomes active: ✅ (opcjonalnie).

Czat — chatroomId i channelId

Backend łączy się z czatem Kicka po WebSocket — potrzebne są dwa numery z Twojego kanału:

1. Otwórz https://kick.com/api/v2/channels/TWOJ-NICK w przeglądarce.
2. Z JSON-a wyłuskaj id (to jest channelId) oraz chatroom.id (to jest chatroomId).
3. Wpisz oba w panelu w zakładce Podstawowe.

Follow / Sub przez Botrix

Botrix udostępnia widgety z ostatnim follow/sub. Backend pobiera je z API (CORS nie pozwala robić tego z przeglądarki).

1. Zaloguj się na botrix.live, dodaj kanał Kicka.
2. W zakładce Widgets stwórz widget typu Ultimo Follow i Ultimo Sub.
3. Skopiuj linki widgetów (zawierają bid=...&type=...) i wklej w pola followWidget i subWidget.

Donate przez Tipply

Tipply ma CORS, więc overlay sam pobiera dane.

1. W panelu Tipply utwórz widget Latest Messages.
2. Skopiuj URL widgeta i wklej w pole donateWidget.
3. Ustaw walutę (PLN / EUR / USD) i częstotliwość odpytywania (sekundy).

Mapa lokalizacji (RTIRL + Moblin)

Mapa wymaga aktywnego streamu z aplikacją Moblin lub innym integratorem RTIRL.

1. Załóż konto na rtirl.com, w aplikacji wpisz swój pull key.
2. W panelu wklej pull key w pole RealtimeIRL pull key.
3. Włącz pokazanie mapy, wybierz róg (BR/BL/TR/TL), rozmiar i zoom.
4. Opcjonalnie: cel podróży (miasto albo lat,lon) — overlay narysuje trasę i pokaże dystans.

Mapa jako osobne źródło OBS (/mapa/<nick>)

Dla większej kontroli — mapa jako osobne Browser Source. Działa niezależnie od głównego overlaya: możesz mieć mapę wyłączoną w panelu, a osobne źródło w wybranej scenie pokaże ją tylko tam. Idealne dla scen tylko-mapa albo „kamera + mapa", bez paska statów i czatu.

• URL: https://overlay.streamtips.pl/mapa/<twoj-nick> jako Browser Source 1920×1080.
• Czyta ten sam RTIRL key + ustawienia mapy z panelu (rozmiar, róg, zoom, mapStats, cel podróży, cykl).
• Cykl pokaż/ukryj: ustaw cykl: widoczna i cykl: ukryta w sekcji Mapa (np. 30 i 60 → mapa miga 30s widoczna / 60s schowana, w pętli).

Per-scena overrides w URL-u (bez ruszania panelu)

• ?pos=tl|tr|bl|br — róg ekranu
• ?w=400&h=240 — rozmiar mapy w pikselach
• ?zoom=14 — przybliżenie 1–18
• ?stats=1 / ?stats=0 — wymuś pokazanie/ukrycie pigułki (prędkość, dystans, zostało)
• ?goal=Kraków lub ?goal=50.06,19.94 — cel podróży tylko dla tej sceny
• ?vis=30&hid=60 — cykl widoczności (30s widać, 60s schowana, w kółko)

Cel zbiórki (Tipply TIPS_GOAL)

Pasek postępu celu (np. „nowy mikrofon", „setup pod kontent") — taki sam jak widget celu na Tipply, tylko wkomponowany w overlay, w rogu mapy.

1. W panelu Tipply utwórz widget Cel wpłat (TIPS_GOAL).
2. Skopiuj URL widgetu — wygląda tak: https://widgets.tipply.pl/TIPS_GOAL/<userId>/GOAL/<goalId>
3. W panelu (zakładka Konfiguracja → sekcja Cel zbiórki) włącz „pokaż cel" i wklej link.
4. Nazwa celu, kwota i procent ciągną się automatycznie z Tipply i odświeżają co kilka sekund — bez F5 w OBS.

Skąd Tipply bierze kwotę?

Kwota = wartość początkowa celu + suma wpłat od daty startu (count_from). To dokładnie ta sama liczba, którą widzisz na swoim widgecie Tipply.

Pilot dla moderatora (bez hasła)

Jednym klikiem generujesz URL, który Twój zaufany mod może wpiąć w dock OBS lub otworzyć na telefonie. Loguje się bez hasła, ale może tylko zmieniać miasto/strefę/RTIRL/odliczanie — bez dostępu do reszty konfiguracji.

1. W panelu kliknij Generuj klucz pilota.
2. Skopiuj URL (zawiera ?auth-key=...).
3. Wyślij modowi lub wpinj w OBS → Docks → Custom Browser Docks.

Zaufani moderatorzy (pełny dostęp do panelu)

Jeśli chcesz dać komuś pełny dostęp do panelu Twojego overlaya (z własnym kontem) — zaproś go linkiem:

1. W panelu sekcja Moderatorzy → Wygeneruj link zaproszenia.
2. Wyślij link modowi (Discord, czat — link działa 7 dni).
3. Mod loguje się / zakłada konto, akceptuje zaproszenie i już ma Twój overlay w swoim dashboardzie.
4. Możesz w każdej chwili odebrać dostęp przyciskiem Usuń.

Walka emotek

Walka emotek pokazuje pasek tug-of-war między 2–4 emotkami. Backend liczy emotki z czatu, overlay tylko renderuje.

• Źródło OBS (osobna scena): /versus/nick — bezczynne do startu.
• Start: panel → Versus → Start walki.
• Komenda dla modów: !walka [emotka] vs [emotka] (60 s) lub !walka [emotka] vs [emotka] 120 (120 s). Wymaga włączenia w panelu.

Przejścia scen

9 animowanych przejść (wipe, slide, iris, diamond, blinds, bars, split, sweep, glitch). Działa jako osobne źródło OBS, które animuje się na trigger z panelu.

• Źródło OBS: /transition/nick (1920×1080, bezczynne dopóki nie kliknięsz „Odpal przejście").
• Możesz zapisać preset (styl, czas, napis, kolor) i odpalać tym samym przyciskiem.

Odliczanie do startu

Dwa tryby: w pasku statów (na żywym overlayu) albo osobne źródło OBS na BRB / pre-stream.

• Osobne źródło: /countdown/nick (sterowane z panelu lub pilota).
• Wbudowane w staty: włącz „odliczanie w statach" w panelu.

Sponsorzy

Wgrywasz dowolną liczbę banerów (PNG/JPG/GIF/WebP). Overlay je rotuje albo wyświetla na stałe.

• Pozycja: prawa/lewa (środek), góra/dół, lewy/prawy dolny róg (przy statach).
• Tryb: wysuwany (co X sekund, na Y sekund) lub stały.
• Banery działają też w trybie offline (BRB).

Scena offline (BRB)

Kiedy stracisz zasięg lub robisz przerwę — overlay przełącza się w tryb offline: efekt CRT (śnieżenie + scanlines) i Twoje klipy z Kicka odtwarzane w tle. Sponsorzy wciąż działają.

1. W OBS dodaj drugie źródło Browser Source na scenie BRB / offline.
2. URL: https://overlay.streamtips.pl/streamer/twoj-nick?offline=1
3. Szerokość 1920, wysokość 1080.
4. Skopiowanie URL-a znajdziesz w panelu w zakładce Podgląd jako „Scena offline / BRB".

Skąd biorą się klipy?

Domyślnie używamy KickBRBClipsPlayer z Twoimi klipami z Kicka (rozpoznawany po nicku). Możesz nadpisać pole clipsUrl w panelu (sekcja Tryb offline) jeśli chcesz pokazywać:

• Wybrane klipy z innego serwisu (Twitch clips, YouTube playlist embed)
• Własny player z konkretnymi filmami
• Statyczny obraz / wideo (musi być URL do strony, nie pliku)

Temperatura przy mieście

Obok napisu z miastem na górze overlaya pokazuje się aktualna temperatura (np. WARSAW | 12°C). Dane z Open-Meteo (free, bez API key).

• Bez RTIRL: nazwa miasta z pola miasto w panelu jest geokodowana raz, potem temperatura odświeża się co 10 minut.
• Z RTIRL: temperatura brana z aktualnej pozycji GPS — automatycznie aktualizuje się, gdy się przemieszczasz.
• Gdy nazwa miasta nie zostanie rozpoznana — temperatura po prostu się nie pokazuje (overlay nic nie krzyczy).

FAQ

Czy to jest darmowe?

Tak, podczas bety. Bez limitów, bez znaków wodnych.

Czy działa na Twitchu?

Nie. Czat, follow/sub i wszystkie integracje są przygotowane pod Kicka.

Stream nie ładuje czatu — co robić?

Sprawdź chatroomId. Jeśli się zmienił (zdarza się), wyciągnij nowy z kick.com/api/v2/channels/<nick>.

Zapomniałem hasła

Skontaktuj się ze streamtips — w becie reset hasła robi superadmin.