ServerBot User Manual v1.6.3
ServerBot - Bot Discordowy rozwijany przez Kamile320 umożliwiający:

Spis Treści

  1. Struktura Katalogowa
  2. Uruchomienie
  3. Uruchamianie Automatyczne
  4. Tokeny
  5. Windows - instalacja FFmpeg
  6. Komendy

Struktura Katalogowa:

  1. ServerBot.py - Główny plik skryptu
  2. setup.bat - Plik instalujący wymagane biblioteki pythona (Windows)
  3. setup.sh - Menu operacyjne: uruchamianie bota, instalowanie wymaganych biblioteki itp. (wymaga zainstalowania komendy "dialog")
  4. Logs.txt - Plik z Dziennikiem zdarzeń bota na serwerze
  5. manual.html - Manual Bota
  6. Media - Katalog z Domyślnymi Muzykami/Dźwiękami
  7. .env - Specialny plik do przechowywania Tokenów Bota
  8. .venv - Wirtualne Środowisko Pythona (Po użyciu setup.sh - opcja 4)
  9. Files - Katalog z wymaganymi (i nie) plikami Bota
    • favicon.ico - Ikona Manuala
    • updates.txt - Plik z listą ostatnich aktualizacji
    • Logs.txt - Kopia Logów Bota
    • autorun.sh - Po użyciu .mksysctlstart
    • Inne Pliki (zdjęcia, nagrania, itp.)
    • setup - Pliki konfiguracyjne
      • setuplib.sh - Instalacja Bibliotek
      • mkvenv.sh - Utworzenie venv

Zdj.1 - Uruchomienie skryptu

Pierwsze uruchomienie:

Bot do uruchomienia wymaga:

Należy poprzez IDE, terminal albo inny program uruchomić Skrypt,
jeżeli coś pójdzie nie tak, Bot powinien dać znać w czym problem
i poprosić o zatwierdzenie wykonania korekty albo porzuci uruchomienie/instalację

Aktualne Komendy Bota można zobaczyć używając komendy .help

Uruchamianie Automatyczne:

Korzystając z Bota może zechcesz aby automatycznie uruchamiał się wraz z systemem operacyjnym (Linux).
Aby to łatwo umożliwić istnieje komenda .mksysctlstart
Po wpisaniu komendy trzeba podać dodatkową wartość:

def -> tworzy domyślny plik autorun.sh w katalogu Files. Działa głównie na systemach opartych na Ubuntu 22.04 (Nie korzysta z utworzonego venv)

venv -> czasem przy instalacji modułów za pomocą pip3 może wyskoczyć błąd externally managed pip.
W tym przypadku należy utworzyć Wirtualne Środowisko Pythona (Virtual Environment/Venv)
Jeśli jeszcze go nie utworzyłeś - rekomendowane jest utworzenie go w głównym katalogu Bota (ServerBot).

Przykład: .mksysctl venv <- wykonujesz tą komendę na Discordzie gdy skrypt działa w głównym katalogu Bota.
UWAGA! Bot (a raczej setup.sh) jest przystosowany do nazwy katalogu z wirtualnym środowiskiem o nazwie ".venv".
Jeśli utworzyłeś ręcznie venv z inną nazwą katalogu, bot może się nie uruchomić!
Zalecane jest użycie opcji 4 z setup.sh -> Bez problemu wszystko zainstaluje i skonfiguruje jak trzeba.
Aby autostart zadziałał, należy ustawić pliki bota z uprawnieniami odczytu/zapisu/wykonania na 777 (dla wszystkich). Rekomenduję przenieść pliki Bota do katalogu /ServerBot (żeby nie był w innych katalogach)

Jak utworzyć venv:
  1. znajdując się w głównym katalogu bota wpisz: python3 -m venv .venv
  2. aby aktywować venv: source .venv/bin/activate (jako root)
  3. sprawdź wersję i lokalizację: which python
  4. gdy już jesteś w venv, uruchom setup.sh
  5. aby wyjść z venv wpisz w termianalu: deactivate
  6. albo prościej - użyj opcji 4 w setup.sh

Pełna dokuntacja tutaj

Zdj. 2 - opcje setup.sh

Tokeny

Bot korzysta z tokenów: Discorda API, OpenAI oraz z ID użytkowników.
Aby bot się uruchomił należy wypełnić odpowiednimi danymi plik .env

Schemat:
TOKEN="twój token"
OpenAI="twój token"
admin_usr = ['twoje ID']
mod_usr = ['twoje ID']
dscserv_link = 'Link do Serwera Discord'
addstable = 'stable_link of Discord Bot'
addtesting = 'testing_link of Discord Bot'
service_list = 'Lista usług systemctl do monitorowania poprzez Discorda'

ID użytkownika

Niektóre komendy korzystają z funkcji i danych związanych z twoim systemem operacyjnym,
więc wymagają uprawnień administratora do uruchomienia - chyba nie chcesz żeby ktoś ci usunął system!
Aby te komendy wykonać, należy podać w admin_usr ID uprawnionych użytkowników do wykonywania tych komend - to muszą być zaufane osoby, a najlepiej tylko ty!
Należy też podać mod_usr - pozwala na wykonywanie komend ingerujących w serwer itp.
To mogą być zaufani moderatorzy Serwera.

Windows - instalacja FFmpeg

FFmpeg odpowiada za odtwarzanie muzyki na Kanałach Głosowych. Na Windowsie instalacja FFmpeg wygląda inaczej niż na Linuksie.
Dla wygody uruchom skrypt setup.bat - po instalacji wszystkich wymaganych bibliotek pythona, pojawi się komunikat o konfiguracji FFmpeg. Należy pobrać .zip programu FFmpeg z oficjalnej strony GitHub, najlepiej z podanego w skrypcie linku. Po pobraniu należy wypakować pliki tak, aby pliki .exe znajdowały się w lokalizacji C:\ffmpeg\bin. Jeśli chcesz wypakować w innym miejscu - edytuj skrypt! Po czym (w skrypcie) wciśnij enter, aby ścieżkę z plikami FFmpeg dodać do PATH. Jeśli pojawi się komunikat o udanej operacji, uruchom ponownie system Windows.

Podstawowe Komendy:

======Chat======
hello
bye
hi
hello_there
 =========Converter=========
binary {dec. number}
hexa {dec. number}
convert {type} {number}
 ========Fun========
random
banner
botbanner
blankthing
apple
gpt
badge
 ======Admin======
ShutDown
copylog
bash
rebuild
mkshortcut
mksysctlstart {mode}
service
pingip
=====BotInfo=====
manual {web/local}
credits
time
ping
release
next_update
issues
 ========FileManager========
cd {directory}
dir {mode}
file {mode} {filename}
touch {file} {content}
 ====VoiceChannel====
join
leave
play {file dir}
ytplay {type} {link}
stop
waiting
micspam
pause
 =====ModOnly=====
testbot
testos
disks
delete
cleaner
webreq
kick
ban
unban