=============================================================================== DZIKBOT – INSTRUKCJA OBSŁUGI =============================================================================== Spis treści 1. Podstawy 2. Logowanie 3. Rozmowa z AI 4. Polecenia dla każdego 5. Polecenia operatora kanału (flaga o) 6. Polecenia właściciela kanału – tylko ircx.net.pl (flaga q) 7. Polecenia mastera (flaga m) 8. Polecenia właściciela bota (flaga n) 9. Flagi i uprawnienia 10. Pamięć bota 11. Panel administracyjny 12. Obsługa na serwerze (Instalacja i przenoszenie bota na inny serwer: patrz CZYTAJ.txt) ------------------------------------------------------------------------------- 1. PODSTAWY ------------------------------------------------------------------------------- Na kanale polecenia zaczynają się od wykrzyknika: !op Marek Na priv (prywatnej wiadomości) można pisać z wykrzyknikiem lub bez: /msg DZiK op #dzik Marek Polskie znaki w nazwach poleceń są opcjonalne – działa zarówno !wyrzuć, jak i !wyrzuc. Odpowiedzi na polecenia wydane na kanale bot wysyła jako NOTICE (widoczny tylko dla Ciebie), żeby nie zaśmiecać kanału. Oznaczenia w składni: <coś> – wymagane [coś] – opcjonalne a|b – jedno albo drugie Jeśli piszesz polecenie na kanale, parametr [#kanał] możesz pominąć – bot przyjmie kanał, na którym piszesz. ------------------------------------------------------------------------------- 2. LOGOWANIE ------------------------------------------------------------------------------- Polecenia administracyjne wymagają zalogowania. Logujesz się zawsze na priv (nigdy na kanale – hasło byłoby widoczne dla wszystkich): /msg DZiK zaloguj <hasło> Sesja trwa do wylogowania albo wyjścia z sieci – zmiana nicku jej nie przerywa. Logujesz się osobno w każdej sieci (IRCnet i ircx.net.pl). Po zalogowaniu bot automatycznie nadaje Ci należne statusy (@, +, .) na kanałach, na których je masz. /msg DZiK wyloguj /msg DZiK kim-jestem – sprawdzenie, jak bot Cię rozpoznaje ------------------------------------------------------------------------------- 3. ROZMOWA Z AI ------------------------------------------------------------------------------- Bot odzywa się tylko wtedy, gdy ktoś go zawoła: DZiK: co sądzisz o poniedziałkach? hej dzik, jak leci? Na priv wystarczy po prostu do niego napisać. Charakter: sarkastyczny, zgryźliwy, z humorem, przeklina, mówi po nicku, nie unika żadnych tematów, odpowiada na zaczepki. Odpowiedzi: krótkie (1–3 zdania, maksymalnie 4 linie). Ochrona przed zasypywaniem: jedna osoba może zadać pytanie co 5 sekund. Charakter bota zmienia się w config.yaml (ai.prompt_systemowy). Każdy kanał może mieć własną instrukcję (prompt_systemowy przy kanale) – zastępuje ona wtedy instrukcję ogólną. ------------------------------------------------------------------------------- 4. POLECENIA DLA KAŻDEGO ------------------------------------------------------------------------------- pomoc [polecenie] Lista poleceń dostępnych dla Ciebie albo opis jednego polecenia. zaloguj <hasło> (tylko na priv) Logowanie do bota. wyloguj Zakończenie sesji. hasło <nowe hasło> (tylko na priv) Zmiana własnego hasła. kim-jestem Pokazuje, jako kogo bot Cię rozpoznaje i jakie masz flagi. zapomnij Usuwa z pamięci bota wszystkie Twoje wypowiedzi i fakty o Tobie. wersja Wersja bota. ------------------------------------------------------------------------------- 5. POLECENIA OPERATORA KANAŁU (flaga o) ------------------------------------------------------------------------------- Bot musi mieć na kanale operatora (@), żeby te polecenia działały. op [#kanał] [nick ...] deop [#kanał] [nick ...] Nadaje / odbiera operatora (@). Bez nicku – Tobie. głos [#kanał] [nick ...] odbierz-głos [#kanał] [nick ...] Nadaje / odbiera voice (+). Bez nicku – Tobie. wyrzuć [#kanał] <nick> [powód] Wyrzuca użytkownika z kanału (kick). banuj [#kanał] <nick|maska> [powód] Banuje. Jeśli podasz nick – także wyrzuca. odbanuj [#kanał] <maska> Zdejmuje bana. temat [#kanał] <tekst> Ustawia temat kanału. tryb [#kanał] <tryby> [parametry] Ustawia tryby kanału, np.: !tryb +nt !tryb +l 50 Przykłady: !op Marek !wyrzuć Troll spadaj !banuj #dzik *!*@zly.host.pl spam /msg DZiK głos #cycki Ola Kasia ------------------------------------------------------------------------------- 6. POLECENIA WŁAŚCICIELA KANAŁU – TYLKO ircx.net.pl (flaga q) ------------------------------------------------------------------------------- Działają tylko w sieci ircx.net.pl (MS Exchange Chat, tryb IRCX). Bot sam włącza tryb IRCX po połączeniu. właściciel [#kanał] [nick ...] odbierz-właściciela [#kanał] [nick ...] Nadaje / odbiera właściciela kanału (+q, oznaczenie „.” przed nickiem). ------------------------------------------------------------------------------- 7. POLECENIA MASTERA (flaga m) ------------------------------------------------------------------------------- Użytkownicy bota: dodaj <nazwa> [maska|nick] Dodaje użytkownika bota. Zamiast maski możesz podać nick osoby, która jest na kanale – bot sam utworzy maskę. usuń <nazwa> Usuwa użytkownika bota. maska+ <nazwa> <maska|nick> maska- <nazwa> <maska> Dodaje / usuwa maskę użytkownika (np. *!marek@*.home.pl). flagi <nazwa> [+zmiany] [#kanał] Pokazuje lub zmienia flagi. Bez kanału – flagi globalne. !flagi Marek – pokaż flagi !flagi Marek +o #dzik – op na #dzik !flagi Marek +v-o #dzik – voice zamiast opa !flagi Troll +k #dzik – autokick użytkownicy Lista użytkowników bota. ustaw-hasło <nazwa> <hasło> Ustawia hasło innemu użytkownikowi (lepiej na priv). Kanały i AI: dołącz <#kanał> [klucz] Bot wchodzi na kanał i zapamiętuje go (wraca po restarcie). opuść [#kanał] [powód] Bot wychodzi z kanału i przestaje na niego wracać. ai [#kanał] <wł|wył|domyślnie> Włącza / wyłącza rozmowy AI na kanale. „domyślnie” przywraca ustawienie z config.yaml. tryb-ai [#kanał] <wzmianka|zawsze|losowo> Kiedy bot się odzywa: wzmianka – tylko gdy ktoś go zawoła (ustawienie obecne) zawsze – odpowiada na każdą wiadomość losowo – czasem wtrąca się sam (5% wiadomości) Pozostałe: statystyki Statystyki pamięci i zużycia API (tokeny). zapomnij-nick <nick> Usuwa z pamięci bota wszystkie dane danej osoby. kanały Lista sieci i kanałów, na których jest bot. ------------------------------------------------------------------------------- 8. POLECENIA WŁAŚCICIELA BOTA (flaga n) ------------------------------------------------------------------------------- powiedz <cel> <tekst> Wysyła wiadomość jako bot (cel: #kanał albo nick). akcja <cel> <tekst> Wysyła akcję (/me) jako bot. nick <nowy nick> Zmienia nick bota (do czasu ponownego połączenia). zapomnij-kanał [#kanał] Czyści całą pamięć kanału. przeładuj Wczytuje ponownie config.yaml (bez rozłączania). surowe <linia IRC> Wysyła surową linię do serwera, np.: !surowe WHOIS saint restart Restartuje bota (usługa uruchomi go ponownie). ------------------------------------------------------------------------------- 9. FLAGI I UPRAWNIENIA ------------------------------------------------------------------------------- n – właściciel bota (wszystko) m – master (zarządza użytkownikami i kanałami) o – operator kanału v – voice q – właściciel kanału (tylko ircx.net.pl) k – autokick (bot wyrzuca tę osobę z kanału) i – ignorowanie (bot nie reaguje na tę osobę) Hierarchia: n > m > o > v – wyższa flaga zawiera uprawnienia niższych. Flagi mogą być globalne (na wszystkich kanałach) albo dla jednego kanału. Administratorzy wpisani w config.yaml mają zawsze flagę n. ------------------------------------------------------------------------------- 10. PAMIĘĆ BOTA ------------------------------------------------------------------------------- Bot pamięta rozmowy i potrafi do nich wracać po czasie: – widzi ostatnie 40 wiadomości z kanału, – co dzień robi streszczenia rozmów i notuje fakty o ludziach, – przeszukuje dawne rozmowy, gdy pytanie do nich nawiązuje. Pamięć jest osobna dla każdego kanału i każdej sieci. Usuwanie z pamięci: !zapomnij – każdy może usunąć dane o sobie !zapomnij-nick <nick> – master usuwa dane wybranej osoby !zapomnij-kanał #kanał – właściciel czyści cały kanał ------------------------------------------------------------------------------- 11. PANEL ADMINISTRACYJNY ------------------------------------------------------------------------------- Uruchomienie (jako użytkownik dzik): cd ~/dzikbot ./dzikbot panel Panel pokazuje na żywo kanały, rozmowy i listę użytkowników. Masz w nim pełne uprawnienia bez logowania. Klawisze: F1 pomoc Tab, Alt+strzałki przełączanie okien Alt+1 … Alt+9 przejście do okna o danym numerze Alt+A przejście do okna z nową aktywnością PgUp / PgDn przewijanie strzałki góra/dół historia wpisanych poleceń Ctrl+C lub F10 zamknięcie panelu (bot działa dalej!) Mysz: kliknięcie nazwy okna na liście po lewej – przejście do tego okna kółko myszy – przewijanie rozmowy Shift + przeciągnięcie – zaznaczanie i kopiowanie tekstu Pisanie: zwykły tekst wysyła wiadomość do bieżącego okna /msg <cel> <tekst> wiadomość do kanału lub osoby /me <tekst> akcja w bieżącym oknie /notice <cel> <tekst> notice Polecenia bota w panelu – z ukośnikiem zamiast wykrzyknika: /op #dzik Marek /kanały /statystyki Polecenia samego panelu: /okno <numer|nazwa> przejście do okna /wyczyść czyści bieżące okno /wyjdź zamyka panel ------------------------------------------------------------------------------- 12. OBSŁUGA NA SERWERZE ------------------------------------------------------------------------------- Katalog bota: /home/dzik/dzikbot ./dzikbot sprawdz sprawdza config.yaml ./dzikbot test-ai próbne pytanie do OpenAI ./dzikbot modele lista modeli dostępnych dla klucza API sudo systemctl reload dzikbot przeładowanie konfiguracji (bez rozłączania) sudo systemctl restart dzikbot restart bota sudo systemctl status dzikbot stan usługi sudo journalctl -u dzikbot -f dziennik na żywo Logi: logi/dzikbot.log dziennik bota logi/<sieć>/<#kanał>/RRRR-MM-DD.log logi kanałów Po każdej zmianie config.yaml: sudo systemctl reload dzikbot (albo !przeładuj na IRC, albo /przeładuj w panelu). Serwer ident (oidentd) działa jako osobna usługa: sudo systemctl status oidentd ===============================================================================