RO-BOT Dokumentacja

Aplikacja: LiveHelp v. 3.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:
    • java -jar LiveHelpRobot.jar

Połączenie TS / DB

TeamSpeak (ts3)

Skonfiguruj połączenie z serwerem TeamSpeak

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

Baza danych (database)

Skonfiguruj połączenie z bazą danych

DataBaseIp - DB host - IP serwera z bazą danych
DataBaseUser - DB użytkownik - Login do bazy danych
DataBasePassword - DB hasło - Hasło do bazy danych
DataBaseName - DB nazwa bazy - Nazwa bazy danych
DataBasePort - DB port - Port, na którym stoi baza danych

Ustawienia

Globalne ustawienia (main)

RulesAccept - Akceptacja zasad aplikacji ro-bot
ActavtionChannel - Kanał aktywcji bota - Jeśli klient wejdzie na ten kanał bot wyśle do niego listę dostępnych komend oraz puści odpowiedni komunikat głosowy
AdminsGroupsAll - Grupy administracyjne do administracyjnych komend livehelpa - Te grupy będą miały dostęp do wielu komend administracyjnych typu ustawianie punktów graczom
AdminWorkingAll - Grupy które będą traktowały administratora jako offline - Przykładowa nazwa grupy to Admin Zajęty
ChannelPermissionGroup - Grupy kanałowe (nie serwerowe) liderów i członków gildi/klanów itp. - Grupy te będą słóżyły jako wyznacznik czy dana osoba z gildi jest uprawniona do komedny !gchat
OtherCase - Czy bot po wpisaniu błędnej komendy ma wyświetlić listę komend
OwnOtherText - Własny tekst jak źle wpisana jest komenda - Tekst wyświetla się przed komendą pomocy

Rejestracja (register)

RegisterGroups - Group ktore trzeba miec by dostawac inne grupy - Aby osoba mogła być zarejestrowna musi mieć daną grupe serwerową
RegisterTime - Czas do rejestracji - Czas wymagany w sekundach do tego by osoba po wpisaniu komendy została zarejestrowna
RegisterCommand - Komendy rejestracyjne
Zawartość - Podaj komende - Komenda musi być w składni !KOMENDA-ID_GRUPY np. !m-5 lub !kobieta-37, potem użytkownik wystarczy że wpisze !kobieta i dostanie rangę
RegisterText - Tekst do rejestracji - Tekst może mieć parametr [HELP] który poda nazwę komendy do listy komend
RegisterTimeNeeded - Informacja ile czasu brakuje do rejestracji - Przykładowe parametry to [TIME] do wymaganego czasu, [SPENT] tyle spedził dany użytkownik
RegisterAlready - Informacja że osoba jest już zarejestrowana
RegisterDone - Informacja że osoba została właśnie zarejestrowana
RegisterChannels - Kanały rejestracyjne - Po wejściu na dany kanał osoba dostanie instrukację jak się zarejestrować
RegisterChannelJoin - Informacja początkowa dla osoby wchodzącej na kanał rejestracji
RegisterForEachGroup - Schemat wypisywania komend po wejściu na kanał rejestracji - Możliwe parametry to [COMMAND] oznaczające komende i [GROUP] oznaczające którą grupe ktoś dostanie
RegisterCaptcha - Czy captcha jet wymagana - Użytkownik dostanie do przepisania unikalny kod, jeśli się pomyli nie dostanie rangi
RegisterCaptchaText - Tekst werefikacyjny - Parametr [CODE] zastępuje fraze do przepisania
RegisterBadCaptcha - Informacja że ktoś źle przepisał kod

Nadawanie grup (grupki)

PrefixAddCommand - Komenda dodania grupy - Komenda aby zawierała spację musi mieć parametr [SPACE] np. !add[SPACE]
PrefixDelCommand - Komenda usuwania grupy - Komenda aby zawierała spację musi mieć parametr [SPACE] np. !add[SPACE]
PrefixListCommand - Komenda wyświetlająca liste grup
NamePriceGroupsLimit - Ustawienia cen, limitów i grup jakie mogą być nadawane w odpowiednich kategoriach
Zawartość
SectionName - Nazwa sekcji
SectionPrice - Cena za jedną rangę
SectionGroups - Lista grup w sekcji
SectionLimit - Limit grup
GroupNotAvailable - Tekst jak grupa jest niedostępna
GroupAdded - Tekst gdy grupa dodana pomyślnie
GroupAddMistake - Tekst gdy gracz wpisze złą składnie komendy
GroupOverLimit - Teksty gdy gracz przekorczy limit grup
GroupPrice - Tekst jak ktoś ma zbyt mało hajsu - Parametry możliwe: [MONEY] zostanie zastąpione ilościa monet osoby, [PRICE] zostanie zastapione cena za grupy
GroupDelMistake - Tekst gdy gracz wpisze złą składnie komendy
GroupDelSuccess - Tekst gdy grupa jest usunięta poprawnie
GroupAddSuccess - Tekst gdy grupa została poprawnie dodana
ListNameText - Wiadomosc przy pisaniu nazwy strefy i ceny za grupe w niej oraz limit - Możliwe parametry to: [NAME] zostanie zastapione nazwą strefy, [PRICE] ceną, [LIMIT] limitem grup
ListGroupText - Wiadomosc przy pisaniu grupy - Możliwe parametry to [GROUPID] to id grupy, [GROUPNAME] to nazwa grupy

Komenda pomocy (help)

PrefixHelpCommand - Komenda wyświetlająca listę komend
HelpCommandText - Sekcja list komend
Zawartość - Komenda

Komenda informacji (infor)

PrefixInfoCommand - Komenda informacja o sobie
InfoCommandShowTime - Typ wyświetlania czasu online w minutach lub godzinach
InfoCommandShowCoins - Liczba przez jaką dzielić liczbę monet robota - Robot nalicza jedną monetę na jedną sekundę więc liczba 60 sprawi że gracz będzie miał jedną monetę na jedną minutę
InfoCommandText - Tekst informacji o kliencie - Dostępne parametry to: [IP],[UID],[NICK],[DBID],[CLID],[CONNECTIONS],[CONNECTEDTIME],[CONNECTEDRECORD],[CONNECTEDSPENT],[IDLESPENT],[IDLERECORD],[WEEKTIME],[COINS]
Zawartość - Informacja
InfoAboutSomeoneCommand - Komenda informacji o kimś
InfoAboutSomeoneHide - Lista grup których nie można sprawdzać
InfoAboutSomeoneOnline - Informacja że ktoś jest online dany okres czasu - Dostępne parametry [NICK],[HOURS],[MINUTES]
InfoAboutSomeoneNoUser - Brak takiego użytkownika w bazie danych
InfoAboutSomeoneAdmin - Tekst że takiej osoby nie mozna sprawdzać
InfoAboutSomeoneOffline - Informacja że ktoś jest offline dany okres czasu - Dostępne parametry [DATE]
InfoAboutSomeoneNotUid - Informacja że dany tekst nie jest uuid osoby z danego ts3
InfoAboutSomeoneBadCommand - Podany został zły format komendy
InfoAboutSomeone - Tekst informacji o kliencie - Dostępne parametry to: [IP],[UID],[NICK],[DBID],[CLID],[CONNECTIONS],[CONNECTEDTIME],[CONNECTEDRECORD],[CONNECTEDSPENT],[IDLESPENT],[IDLERECORD],[WEEKTIME],[COINS]
Zawartość - Informacja

Wzywanie admina (helpCommand)

HelpCommand - Komenda do wezwania admina
HelpUserJoin - Tekst proszący o wskazanie konkretnej grupy adminów - Dostępne parametry to: [NICK],[UUID],[COUNTRY]
HelpInfoForAdminMessage - Wiadmość do admina - Dostępne parametry to: [NICK],[UUID],[COUNTRY]
HelpInfoForUserMessageSucces - Informacja że admin został powiadomiony - Dostępne parametry to: [NICK],[UUID]
HelpInfoForUserMessageFail - Informacja że admin nie został powiadomiony - Dostępne parametry to: [NICK],[UUID]
HelpCaseCommandMain - Lista możliwych wezwań adminów
Zawartość
HelpCaseCommand - Komenda do konkretnej sekcji administracji
HelpCaseInfo - Opis kim jest dana sekcja
HelpAdminsToPoke - Lista grup adminów z sekcji - Jeśli nie ma konkretnego wpisz 0 nie usuwaj!
HelpDbidAdminsToPoke - Limit dbid adminów z tej sekcji - Jeśli nie ma konkretnego wpisz 0 nie usuwaj!

Własna komenda-tekst (ownCommand)

OwnCommandMain - Lista własnych komend
Zawartość
OwnCommand - Własna komenda
OwnMessage - Własna wiadmość

Kanały prywatne (getPrivate)

GetPrivateChannelCommand - Komenda zajęcia kanału prywatnego
GetPrivateChannelId - Kanał gdzie osoba dostaje kanał prywatny
DeletePrivateChannelCommand - Usuwanie kanału prywatnego
DeletePrivateChannelList - Lista kanałów które osoba może usunąć
DeletePrivateChannelChannelInfo - Sposób wypisania tej listy kanałów - Dostępne parametry to: [NAME],[ID]
DeletePrivateChannelCorrect - Zły format komendy
DeletePrivateChannelNoPrivate - Brak kanału prywatnego
DeletePrivateChannelBadId - Podałeś złe id kanału
DeletePrivateChannelZone - Strefa kanałów prywatnych
DeletePrivateChannelOwner - Id grupy właściciela kanału

Sprawdzanie banów (checkBan)

CheckBanCommand - Komenda do sprawdzenia bana
CheckBanIpBanned - Informacja że dane ip nie ma bana
CheckBanNickBanned - Informacja że dany nick nie ma bana
CheckBanUidBanned - Informacja że dane uuid nie ma bana
CheckBanNotBanned - Informacja o braku bana

Sprawdzanie osób online (checkOnline)

CheckOnlineUsersCommand - Lista osób online z grupy
CheckOnlineUsersCorrect - Zły format komendy
CheckOnlineUsersGroup - Nagłówek listy osób z grupy - Dostępne parametry to: [GROUP]
CheckOnlineUsersOnline - Tekst o osobie online - Dostępne parametry to: [NICK][UUID]
CheckOnlineUsersHide - Lista grup serwera których nie można sprawdzać

Helpop dla graczy (reportRespond)

ReportCommand - Komenda zgłoszenia danej osoby
ReportSent - Informacja że zgłoszenie zostało wysłane
ReportAdminView - Informacja do admina o zgłoszeniu - Dostępne parametry to: [UUID],[NICK],[ID],[TEXT]
ReportNoText - Informacja o braku tekstu w komendzie
ReportBadCommand - Informacja o złym formacie komendy
RespondCommand - Komenda odpowiedzi admina
RespondUserView - Wygląd wiadmośći od admina - Dostępne parametry to: [NICK],[UUID],[TEXT]
RespondAdminView - Wygląd wiadmości od admina do innych adminów - Dostępne parametry to: [NICK],[UUID],[TEXT],[ID]
RespondNotId - Podanie błędnego id usera
RespondNotAdmin - Brak permisji do wysłania
RespondNoText - Brak tekstu do wysłania
RespondBadCommand - Zły format komendy
RespondSpliter - Rozdzielacz komendy, przykładowo -

Chat administracji (adminChat)

AdminChatCommand - Komenda chatu administracji
AdminchatView - Wgląd tekstu w adminchat - Dostępne parametry to: [NICK],[UUID],[TEXT]
AdminChatNoPerm - Brak permisji
AdminChatNoText - Brak tekstu do wysłania
AdminChatBadCommand - Zły format komendy

System punktów (checkPoints)

CheckPointsCommand - Komenda sprawdzania punktów
CheckPointsHas - Zwrot ile posiada ktoś punktów - Dostępne parametry to: [COINS]
CheckPointsBadDbid - Błędne dbid osoby
CheckPointsNoPerm - Brak permisji do sprawdzania
CheckPointsNoDbid - Brak parametru dbid
CheckPointsBadCommand - Zły format komendy
SetPointsCommand - Komenda ustawiania punktów
SetPointsSpliter - Rozdzielacz komendy, przykładowo -
SetPointsPointsSet - Informacja o zmianie punktów
SetPointsBadId - Podanie błędnego dbid
SetPointsNotAdmin - Brak permisji do komendy
SetPointsNoText - Brak parametrów w komendzie
SetPointsBadCommand - Zły format komendy

Historia kar (historyCommand)

BanHistoryCommand - Komenda histori kar
BanHistoryNoPunishments - Brak kar
BanHistoryBadDbid - Błędne dbid
BanHistoryNotAdmin - Brak permisji
BanHistoryNoText - Brak parametrów
BanHistoryBadCommand - Zły format komendy
BanHistoryBansMain - Format wypisywania banów
Zawartość
BanHistoryBans - Własna wiadmość informacyjna - Dostępne parametry to: [ID],[TYPE],[TIME],[REASON],[DATE],[INVOKER]

Informacje o adminie (adminInfoCommand)

AdminInfoCommand - Komenda informacji o adminie
AdminInfoNoText - Brak parametrów w komendzie
AdminInfoBadCommand - Zły format komendy
AdminInfoAdminMain - List adminów
Zawartość
AdminInfoAdmin - Dbid administratora
AdminInfoText

Chat gildi (gchatCommand)

GChatCommnad - Komenda chatu gildi
GChatNoPerm - Brak permisji do komendy
GChatBadNumber - Błędne id gildi
GChatMainTexy - Format tekstu do gildi - Dostępne parametry to: [GROUP],[NICK],[TEXT]

System teleportow (homeSystem)

SetHomeCommand - Komenda ustawienia domu
SetHomeOffChannels - Lista kanałów gdzie nie można mieć home
SetHomeOffParentChannels - Lista głównych kanałów gdzie nie można mieć home
DelHomeChannelGroups - Grupy które mogą kasować na własnym kanale home
DelHomeServerGroups - Grupy adminów którzy mogą kasować home
DelHomeCommandChannel - Komenda usuwania kanału
DelHomeCommandChannelList - Lista osób z home na kanale
DelHomeCommandServer - Komenda usuwania kanału dla admina
DelHomeCommandServerList - Lista home na danym kanale
DelHomeTextFormat - Informacja o domach - Dostępne parametry to: [NICK],[DBID],[CID]
WhereHomeCommand - Komenda gdzie ktoś ma dom dla admina
SetHomeDeny - Informacja o braku permisji do home na danym kanale
DelHomeListEmpty - Brak home na danym kanale
NoHomeInfo - Brak informacji o danym home
GoToHomeCommand - Komenda przejścia na home
SetHomeInfo - Informacja że kanał został zapisany jako home

Szukanie osob do gry (searchGame)

SearchGameOnlyRegister - Czy tylko dla zarejestrowanych
SearchGameCommand - Komenda do szukania osób do gry
SearchGameBadCommand - Zły format komendy
SearchGameSeparator - Rozdzielacz komendy
SearchGameDel - Komenda anulowania wyszkukiwania
SearchGameDelInfo - Informacja o zakończeniu szukania
SearchGameBadDel - Zła składnia komendy
SearchGameDelNoGroup - Osoba nie ma już grupy szukającego
SearchGameInformed - Informacja o wysłaniu informacji do innych graczy
SearchGameInfoTo - Informacja dla osób szukających od osoby szukającej - Dostępne parametry to: [UID],[NICK],[MESSAGE],[GAME]
SearchGameInfoToNoMsg - Informacja dla osób szukających bez wiadmości od gracza - Dostępne parametry to: [UID],[NICK],[GAME]
SearchGameNoPlayers - Brak osób w tej grze
SearchGameAntyAd - Zakazane znaki rozdzielone &
SearchGameAntyAdInfo - Informacja dla gracza że jego wiadmość ma zakazane znaki
SearchGameAntySpamInfo - Informacja o zbyt częstym wysłaniu komendy
SearchGameAntySpamCd - Czas między kolejnymi wysłaniami komendy
SearchGameNameMain - Lista możliwych gier
Zawartość
SearchGameName - Nazwa gry
SearchGameId - Grupa osób szukających
SearchGamechannelId - Kanał do aktywacji zamiast pisania komendy !gram

Ranga zarządcy music bota (ask4Bot)

Ask4BotCommand - Komenda proszące o rangę dostępu do bota
Ask4BotGroup - Grupa zarządzającego botem
ShouldRemoveAtStart - Czy ma usuwać wszystkie osoby z tej grupy przy włączeniu bota
AdminsAsk - Grupy administracji nadające grupę
Ask4BotAdminInfo - Infromacja do admina - Dostępne parametry to: [UID],[NICK]
Ask4BotNoAdmins - Brak administracji do nadania bota
GiveBotCommand - Komenda nadania rangi na określony czas
GiveBotAdded - Informacja iż osoba dostała rangę
GiveBotFormat - Zły format komendy
GiveBotNotadmin - Osoba nie jest administratorem

Szpiedzy kanałowi (spyBots)

SpyBot - Czy boty szpiegujące mają być włączone - Boty te to ukryci klienci query na każdym kanale gdzie ktoś jest połączony. Zapisują one każdą wiadmość wysłaną w osobnym pliku logów.
SpyBotMain - Lista kanałów które mają określoną liczbę osób (tylko kanały publiczne np. max 4)
Zawartość
SpyBotCid - Kanał nadrzędny strefy kanałów publicznych
SpyBotLimit - Limit osób w strefie
SpyBotCids - Lista kanałów/kanałów nadrzędnych gdzie bot może być

Boty muzyczne (musicBots)

MusicBotDefaultName - Domyślna nazwa bota muzycznego
MusicBotServerIp - Ip serwera na który boty mają dołączać
AntyVpnMusicBot - Grupa antyvpn nadawana botowi
DeleteAllMusicBots - Usuwanie wszystkich botów muzycznych
ControlMusicBotGroup - Grupa admina która może kontrolować boty
SpliterForCommands - Rozdzielacz komendy
GetMusicBotCommand - Dostwanie bota muzycznego
GiveMusicBotCommand - Dawanie komuś bota muzycznego
StopMusicBotCommand - Wyłącznie bota muzycznego
RestartMusicBotCommand - Restartowanie bota muzycznego
StartMusicBotCommand - Włączenie bota muzycznego
DeleteMusicBotCommand - Usunięcie bota muzycznego
GiveMusicBotGroups - Grupy które mogą dawać boty muzyczne
GetAllMusicBotsCommand - Komenda listy musicbotów
GetAllMusicBotsText - Tekst z informacją o musicbocie - Dostępne parametry to: [UID],[ID]
AddUserToRights - Komenda dodania kogoś do adminów bota
RemoveUserFromRights - Komenda zabierająca dostęp do bota
GetMyMusicBotGroupMain - Lista grup z maksymalną ilością botów
Zawartość
GetMyMusicBotGroup - Grupa serwera która może mieć musicbota
GetMyMusicBotsLimit - Limit musicbotów

LiveHelp bot muzyczny (audiBotLivehelp)

AudioBotOnline - Czy audiobot ma być włączony
AudioBotAvatar - Link do awataru audiobota lub false by wyłączyć
AudiBotUuid - Uuid bota muzycznego grającego dźwiek - Wpisanie zamiast uuid robot sprawi że livehelp sam pobierze odpowiednie uuid
AudiBotIp - Ip do api audiobota - Domyślna wartość zwykle będzie działać
AudiBotVolume - Głośność dźwięków audiobota
AudiBotStopOnJoin - Czy na wejście kolejnej osoby audiobot ma zacząć mówić komunikaty na nowo
AudiBotAdminGroups - Grupy adminów
DelayToStart - Ile czasu zajmie botowi muzycznemu wejście na serwer - Czas wyrażony jest w milisekundach (1s = 1000ms)
AudioBotName - Nazwa bota muzycznego
ADMIN_NUMBER_0 - Nazwa muzyki na 0 osób w administracji
ADMIN_NUMBER_1 - Nazwa muzyki na 1 osobę w administracji
ADMIN_NUMBER_2 - Nazwa muzyki na 2 osoby w administracji
ADMIN_NUMBER_3 - Nazwa muzyki na 3 osoby w administracji
ADMIN_NUMBER_4 - Nazwa muzyki na 4 osoby w administracji
ADMIN_NUMBER_5 - Nazwa muzyki na 5 osób w administracji
ADMIN_NUMBER_6 - Nazwa muzyki na 6 osób w administracji
ADMIN_NUMBER_7 - Nazwa muzyki na 7 osób w administracji
ADMIN_NUMBER_8 - Nazwa muzyki na 8 osób w administracji
ADMIN_NUMBER_9 - Nazwa muzyki na 9 osób w administracji
ADMIN_NUMBER_10 - Nazwa muzyki na 10 osób w administracji
ADMIN_NUMBER_MORE - Nazwa muzyki na więcej niż 10 osób w administracji
AudiBotPlayJoinMain - Muzyka/dzwieki puszczane po wejsciu - Parametr: [ADMIN_NUMBER] - Puści informacje o ilości administracji, [ADMINS_ONLINE] - Będzie grane tylko kiedy jest więcej niż jeden administrator(Ta fraza będzie skasowana przez bota i nie można nazywać piosenki razem z nią)
Zawartość
AudiBotPlayJoin - Dokladna nazwa dzwieku z katalogu bota muzycznego np. Witaj.mp3 - Domyślnie zalecamy dać dźwieki 1. Witaj.mp3, 2. Help.mp3, 3. Dyspozycja.mp3[ADMINS_ONLINE],4. [ADMIN_NUMBER],5. Admin.mp3[ADMINS_ONLINE]