RO-BOT Dokumentacja

Panel

Aplikacja: Aplikacja Website v. 1.0

Wstępne informacje

Przeczytaj poniższe informacje, aby ułatwić sobie konfigurację naszej aplikacji

Wtyczki

Pobierz jedną z dwóch polecanych wtyczek:

Serwer

  1. Dodaj IP maszyny na której stoi bot do pliku „query_ip_whitelist” lub „query_ip_allowedlist” w serwerze teamspeak (lub poproś oto swojego dostawcę)
  2. Jeśli jest to ta sama maszyna używaj adresu 127.0.0.1 lub localhost do łączenia się z serwerem teamspeak
  3. Początkową konfigurację najlepiej prowadzić na osobnym serwerze, który jest kopią głównego serwera (Te same id grup, kanałów itp.)

Inne

  1. Konfig należy często zapisywać i testować funkcja po funkcji w celu szybkiego poprawiania zjadania „przecinka”
  2. Jeśli nie wiesz czegoś lepiej to wyłączyć i zapytać się kogoś co to robi!!!
  3. By wykryć błędy konfiguracji używaj komendy:
    • ./server

Podłączenie domeny

Otwórz instrukcję

Połączenie TS / DB

TeamSpeak (ts3)

Skonfiguruj połączenie z serwerem TeamSpeak

host - TS host - IP serwera TeamSpeak
queryPort - TS port query - Port query serwera TeamSpeak
serverPort - TS port - Port instancji TeamSpeak'a
username - TS login - Login do serwera TeamSpeak
password - TS hasło - Hasło do wyżej wpisanego loginu
type - TS typ połączenia - Wybierz typ z powyższej listy
nickname - Nick bota - Nick pod jakim będzie widoczny bot
botChannel - Kanał bota - Kanał, na którym będzie przebywać bot

Baza danych (database)

Skonfiguruj połączenie z bazą danych

host - DB host - IP serwera z bazą danych
user - DB użytkownik - Login do bazy danych
password - DB hasło - Hasło do bazy danych
database - DB nazwa bazy - Nazwa bazy danych
port - DB port - Port, na którym stoi baza danych

Ustawienia główne

Główne ustawienia (main)

port - Port serwera - Port, na którym będzie działać strona
pointsDivider - Dzielnik liczby punktów (monet) - Liczba, która dzieli ilość monet i dla użytkownika będzie to liczba monet (bot nadaje jedną monetę co sekundę, ale można to np. podzielić na 60 i będzie wtedy 1 moneta na minutę z perspektywy użytkownika).
token - Ustawienia tokenu
timeValid - Czas ważności tokenu (w sekundach)
timeToResent - Czas po jakim token może zostać wysłany ponownie (w sekundach)
infoSent - Treść wiadomości z tokenem
offlineAccountServerGroup - Grupa serwerowa nadawana po utworzeniu konta offline
offlineAccountChannelId - Kanał do awaryjnego tworzenia konta offline (gdy bot nie wykryje użytkownika na serwerze)

Ustawienia maila (email)

Skonfiguruj połączenie do adresu email

host - Adres hosta do maila
port - Port do maila
secure - Połączenie szyfrowane
user - Nazwa użytkownika - Zazwyczaj jest to adres email
password - Hasło do maila
from - Od kogo mają przychodzić maile
logo - Link do loga, które będzie w mailu
footer - Ustawienia stopki maila
name - Nazwa wyświetlana w mailu
url - Link wyświetlany w mailu
contactFormMail - Docelowy adres email od formularza kontaktowego - Na jaki adres email mają przychodzić maile z formularza kontaktowego

Ustawienia globalne

Informacje o Twoim serwerze (information)

Podstawowe informacje, które będą wyświetlane o Twoim serwerze

email - Email kontaktowy wyświetlany na stronie
serverName - Nazwa Twojego serwera
tsDomain - Domena/IP Twojego serwera

Ustawienia kolorów motywu (theme)

Aby skonfigurować kolory motywu odwiedź stronę: https://websiteTheme.ro-bot.net. Tam możesz wpisać wybrane kolory i wygenerować pliki, które wrzucisz do swojej strony. Tutaj musisz tylko wpisać kolory, które wybrałeś. Jeśli nie ustawiałeś własnych kolorów, zostaw ustawienia domyślne.

primaryColor - Kolor podstawowy
themeColor1 - Kolor motywu 1
themeColor2 - Kolor motywu 2
fontColor - Kolor czcionki

Frazy zakazane (badPhrases)

Ustaw zakazane frazy, których nie będzie można użyć w komentarza, edycji kanałów prywatnych, opiniach itp.

content - Zakazane frazy po przecinku (Można tę część kopiować)

Aktywne podstrony (enabledPages)

Poniżej możesz włączyć lub wyłączyć poszczególne podstrony

landingPage - Landing page
administration - Zakładka administracja
top - Zakładka ranking
info - Zakładka informacje
contact - Zakładka kontakt
dashboard - Panel
registration - Zakładka rejestracja
groups - Zakładka zmiana grup
privateChannel - Zakładka kanał prywatny
premium - Zakładka kanał premium
friends - Zakładka znajomi
rules - Zakładka regulamin
faq - Zakładka FAQ
recruitment - Zakładka rekrutacja
adminOpinions - Zakładka opine administratorów
clans - Zakładka klany
shop - Zakładka sklep

Ustawienia landing page

Nagłówek (header)

Ustawienia nagłówka wyświetlanego w landing page'u

onlineIgnoredGroups - Ignorowane grupy do liczenia osób online - Wybierz grupy, które mają być ignorowane
additionalNav - Dodatkowe zakładki w menu
Zawartość
name - Nazwa zakładki
link - Link, gdzie ma prowadzić zakładka
openNewTab - Czy ma się otwierać w nowej karcie
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free
additionalButton - Dodatkowe przyciski w menu
Zawartość
name - Nazwa przycisku
link - Link, gdzie ma prowadzić przycisk
openNewTab - Czy ma się otwierać w nowej karcie
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free

Strona główna (home)

Ustawienia podstrony - strona główna

newsCount - Liczba wyświetlanych aktualności
mainSlogan - Slogan serwera
aboutServer - Informacje o serwerze
cards - Ustawienia kart
Zawartość
title - Tytuł karty - Jeśli napiszesz za dużo tekstu, będzie on ucinany.
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free
desc - Opis karty - Wyświetla się po najechaniu na kartę. Jeśli napiszesz za dużo tekstu, będzie on ucinany.

Administracja (administration)

Ustawienia podstrony - administracja

adminGroups - Grupy adminów - Wybierz grupy administratorów

Ranking (top)

Ustawienia podstrony - ranking

ignoredGroups - Ignorowane grupy - Wybierz grupy, które mają być ignorowane
levels - Levele
Klucz - Grupa serwerowa
Zawartość - Wymagana ilość czasu spędzonego (w sekundach)

Panel użytkownika

Dashboard (home)

Ustawienia strony głównej panelu

adminGroups - Grupy adminów - Wybierz grupy administratorów

Rejestracja (registration)

Ustawienia rejestracji. Nadawania początkowych grup np. płeć, wiek, województwo

zones - Kategorie - Kategorie kolejnych kroków rejestracji. Np. Płeć, Wiek
Klucz - Klucz danej kategorii - Musi być unikalny
Zawartość
name - Nazwa kategorii
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free
groups - Grupy serwerowe - Wybierz grupy serwerowe
canSkip - Czy użytkownik może pominąć wybór grupy w tej kategorii - Czasami użytkownik może nie chcieć podawać np. swojego wieku, wtedy może nie zaznaczyć grupy w kategorii Wiek.

Zmiana grup (groups)

Ustawienia zmiany grup

requiredRegistration - Czy rejestracja jest wymaga do zmiany grup
requiredGroup - Wymagane grupy - Wpisz grupy, które użytkownik powinien posiadać, żeby móc zmieniać swoje rangi. Jeśli wpiszesz grupy: zarejestrowany, zarejestrowana to klient będzie mógł zmieniać swoje rangi, gdy będzie posiadał co najmniej jedną z nich
interval - Co ile użytkownik może zmieniać swoje grupy - W sekundach
zones - Kategorie - Kategorie grup np. ForFun, Rangi Gier
Klucz - Nazwa danej kategorii
Zawartość
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free
groups - Grupy serwerowe - Wybierz grupy serwerowe
limit - Limit grup z danej kategorii

Kanały prywatne (privateChannels)

Ustawienia zarządzania kanałem prywatnym

requiredRegistration - Czy rejestracja jest wymaga do założenia i zarządzania kanałem prywatnym
requiredGroup - Wymagane grupy - Wpisz grupy, które użytkownik powinien posiadać, żeby móc zmieniać stworzyć / zarządzać kanałem prywatnym. Jeśli wpiszesz grupy: zarejestrowany, zarejestrowana to klient będzie mógł używać tej zakładki, gdy będzie posiadał co najmniej jedną z nich
channelsZone - Strefa kanałów prywatnych
emptyChannelTopic - Topic w wolnych kanałach
channelGroupId - Grupa kanałowa właściciela kanału
maxSubChannels - Maksymalna liczba podkanałów jaką może stworzyć użytkownik
manageChannelGroups - Jakimi grupami kanałowymi może zarządzać użytkownik
guestChannelGroup - Grupa kanałowa gościa
getPrivateChannel - Kanał, od nadawania kanału prywatnego - To samo ID, które podpięte jest w RO-BOCIE
editDescInMainChannel - Czy można edytować opis kanału głównego

Kanały premium (premiumChannels)

Ustawienia wyświetlania kanałów premium użytkownika

requirements - Wymagania, aby otrzymać kanał w strefie Premium - Będą one wyświetlane w zakładce Strefa Premium, gdy klient nie będzie posiadał żadnego kanału Premium
robotLiderPanel - Podłączenie panelu lidera od RO-BOT'a
enabled - Czy funkcja ma być włączona
urlToPanel - Link do panelu
secret - Token - Ten sam token musi być wpisany w configu Panelu Lidera. Musi to być losowy ciąg znaków. WAŻNE!
customLiderPanel - Podłączenie własnego panelu lidera
enabled - Czy funkcja ma być włączona
urlToPanel - Link do panelu

Regulamin (rules)

Ustawienia regulaminu

content - Treść regulaminu (Można tę część kopiować)

FAQ (faq)

Ustawienia pytań i odpowiedzi

content - Kategorie (Można tę część kopiować)
Klucz - Nazwa kategorii
Zawartość
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free
questions - Treść pytań i odpowiedzi
Klucz - Pytanie
Zawartość - Odpowiedź

Profil (profile)

Ustawienia związane z profilem

comments - Ustawienia komentarzy
edit - Edycja komentarzy
delete - Usuwanie komentarzy
hide - Ukrywanie komentarzy
enabled - Czy funkcja ma być włączona
canHideSelf - Czy użytkownik może ukrywać komentarze pod swoim profilem
adminGroups - Grupy administracyjne mogące ukrywać komentarze pod każdym profilem - Wybierz grupy administratorów
adminGroups - Grupy administratorów - W tym miejscu możesz wybrać, które grupy administracyjne będą wyróżnione
Klucz - Grupa administracyjna
Zawartość - Ustawienia
name - Nazwa grupy - Jeśli zostawisz to pole puste, to nazwa zostanie pobrana z grupy serwerowej
color - Kolor wyróżnienia admina - Podany jako HEX RGB np. #ff00ff
textColor - Kolor tekstu - Podany jako HEX RGB np. #ffffff
background - Tło profilu - Możesz podać link do grafiki tła

Opinie administratorów (adminOpinions)

Konfiguracja opinia administratorów

adminGroups - Grupy adminów - Wybierz grupy administratorów

Rekrutacja (recruitment)

Ustawienia rekrutacji

delay - Co ile dni użytkownik może przesłać podanie
requirements - Wymagania do rekrutacji
Zawartość
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free
description - Opis wymagania
action - Ustawienia automatyczne sprawdzanych wymagań
enabled - Czy funkcja ma być włączona
type - Typ wymagania
comparisonType - Typ porównania wymagania z wartością
value - Wymagana wartość - W przypadku spędzonego czasu są to godziny, w przypadku połączeń to liczba połączeń, dla typu: pierwsze połączenie - liczba dni od ostatniego połączenia, dla procent bycia online do AFK - procenty (od 1 do 100), ale zaleca się użycie powyżej 80%

Panel admina (administration)

Konfiguracja panelu administratora

mainAdminDbid - DBID głównego administratora - Ten admin będzie mógł dodać innych adminów poprzez panel

Zarządzanie grupami w panelu admina (manageGroups)

Ustal jakimi grupami może zarządzać administrator przez panel admina

zones - Kategorie - Kategorie grup np. ForFun, Rangi Gier
Klucz - Nazwa danej kategorii
Zawartość
icon - Ikonka - Wpisz nazwę ikonki fontawesome. Np. fa fa-home. Ikonki możesz znaleźć na stronie: https://fontawesome.com/icons?m=free
groups - Grupy serwerowe - Wybierz grupy serwerowe
limit - Limit grup z danej kategorii