Dla programistów
Jak klient gry rozmawia z Voidwatch. Jak zbudować własny moduł albo dodać nowy serwer.
Części
| Część | Gdzie działa | Co robi |
|---|---|---|
| moduł | w kliencie gry | zapisuje stan postaci do plików i wykonuje komendy, które dostaje |
| skrypt wysyłający | na tym samym komputerze co klient | wysyła pliki do API i zapisuje odpowiedzi |
| feed API | na naszych serwerach | przechowuje stan i odpowiada tempem zrzutów oraz czekającymi komendami |
Sam klient nie wysyła żadnych zapytań do sieci. Następna sekcja wyjaśnia dlaczego.
Dlaczego klient sam nic nie wysyła
Warstwa HTTP w OTClientV8 trzyma treść każdego wysłanego zapytania.
- W kodzie klienta (
otcv8-dev) callback wHttp::postłapie id operacji przez referencję. - Dlatego sprzątanie, które usuwa skończoną operację, ją pomija.
- Każde
HTTP.postlubg_http.postzostaje w pamięci do zamknięcia klienta. - Sprzątanie po stronie Lua przez
HTTP.operationslubHTTP.cancelnie pomaga. Treści zostają po stronie C++.
Zmierzyliśmy to na klientach gry.
| Test | Wynik |
|---|---|
Zrzuty widoku gry wysyłane przez HTTP.post, około 370 KB każdy | 2 klienty padły po około 1000 wysyłkach, z Critical lua error! w http.lua. 32-bitowemu klientowi skończyła się pamięć. |
Websocket, g_http.ws | Trzymał około jednej wiadomości na wysyłkę w 10-minutowym teście. |
| Te same zrzuty zapisywane do pliku, bez wysyłki z klienta | Jeden klient działał 4 h 26 min, z 4526 zrzutami i 0 błędami pamięci. |
Własny licznik pamięci klienta, g_platform.getMemoryUsage(), nie pokazuje tego wzrostu. Pokazuje go widok systemu operacyjnego. Dlatego moduł zapisuje pliki, a sieć obsługuje skrypt wysyłający.
Jedna pętla
Każda postać ma własny folder w folderze danych klienta. OTClientV8 nazywa folder danych folderem zapisu. Klienty na jednym komputerze często go dzielą.
| Instalacja | Folder postaci |
|---|---|
| moduł w folderze modules | voidwatch/<character>/ |
| moduł w folderze bota (Orion) | bot/_voidwatch/data/<character>/ |
Ścieżki niżej są wewnątrz folderu postaci.
- Moduł zapisuje
outbox/status.json. Robi to co 2 sekundy, gdy ktoś ogląda postać, i co 5 sekund, gdy pokazuje ją Radar drużyny. W innym razie robi to co 30 sekund. - Skrypt wysyła plik do
POST /api/v1/status. Odpowiedź zapisuje doinbox/reply.json. - Odpowiedź ustala, jak często wysyłać zrzut ekranu. To co 1–2 sekundy, gdy ktoś ogląda postać. W innym razie to raz na minutę.
- Gdy czekają komendy, skrypt pobiera je do nowego pliku
inbox/commands-<time>-<n>.json. Moduł wykonuje każdą komendę raz i pomija komendę starszą niż 60 sekund. Każdy wynik dopisuje dooutbox/results.json. - Między dwoma statusami skrypt trzyma jedno otwarte zapytanie do
GET /api/v1/wait. Zapytanie wraca, gdy ktoś otworzy postać, uruchomi się alert albo przyjdzie komenda. Klient przyspiesza wtedy w ciągu sekundy. Z włączoną exivą drużyny skrypt zamiast tego pytaGET /api/v1/wakeco 2 sekundy. Jego pliki nigdy nie czekają wtedy na długie zapytanie. Klient z exivą drużyny, który nie pyta, wysyła status co 2 sekundy. - Raz na minutę skrypt sprawdza każdy plik
minimap*.otmmklienta. Wysyła każdy zmieniony plik, najwyżej co 30 minut, z czasem jego zmiany. Strona łączy każdy plik z mapą gracza. Plik nigdy nie usuwa obszaru. Gdy odpowiedź zawieraneedMap: true, skrypt wysyła wszystkie pliki jeszcze raz. Gracze mogą to wyłączyć w ustawieniach modułu.
Parowanie
Nowy klient nie ma tokenu.
- Moduł zapisuje
outbox/pair-request.json. - Skrypt wywołuje
POST /api/v1/pair. - Odpowiedź zawiera kod i link dla gracza. Zawiera też token, który skrypt zachowuje.
Nieużyty kod wygasa po 15 minutach. Skrypt prosi wtedy o nowy kod.
Aktualizacje
Moduł nigdy nie pobiera kodu. Serwer co 5 minut pyta GitHub o najnowsze wydanie. Każda odpowiedź na status podaje tę wersję, jako latestModule. Skrypt wysyłający sam też pyta GitHub co 6 godzin. Wyższą z dwóch wersji zapisuje do latest.json.
Pliki aktualizacji są w głównym folderze danych, nie w folderze postaci. Ten folder to voidwatch/. Dla modułu w folderze bota to bot/_voidwatch/data/.
- Gracz klika Update. Moduł zapisuje
update-request.jsonz wersją i postacią. - Skrypt pobiera z GitHuba zip wydania i jego
SHA256SUMS. Sprawdza sumę kontrolną i wersję w zipie. - Skrypt kopiuje stary folder modułu do
backup/. Na jego miejsce wstawia nowy folder. - Skrypt zapisuje
update-result.json. Klient, który prosił, przeładowuje moduł. Inne klienty proponują Reload.
Roll back zapisuje rollback-request.json. Skrypt przywraca wtedy kopię zapasową.
Skrypt czyta wydania tylko z GitHuba, nigdy ze strony. Dlatego włamanie na stronę nie pozwala wysłać kodu do klientów.
Zbuduj własny
Wszystko jest otwarte, na licencji MIT:
Zachowaj układ plików, a Twój moduł zadziała z naszymi skryptami wysyłającymi. Możesz też napisać własny skrypt, w dowolnym języku.
Serwer może też dołączyć moduł do własnego klienta. Skontaktuj się z nami, a dodamy serwer jako partnera.