Desenvolvedores

Como um cliente do jogo conversa com o Voidwatch. Como criar seu próprio módulo ou adicionar um novo servidor.

As partes

ParteOnde rodaO que faz
módulodentro do cliente do jogograva o estado do personagem em arquivos e executa os comandos que recebe
script de enviono mesmo computador que o clienteenvia os arquivos para a API e grava as respostas de volta
feed APInos nossos servidoresguarda o estado e responde com a frequência das capturas e os comandos pendentes

O próprio cliente não faz requisições web. A próxima seção explica por quê.

Por que o cliente não envia nada sozinho

A camada HTTP do OTClientV8 guarda o corpo de cada requisição que envia.

  • O código-fonte do cliente é o otcv8-dev. Nele, o callback dentro de Http::post captura o id da operação por referência.
  • Por isso, a limpeza que apaga uma operação terminada não encontra essa operação.
  • Cada HTTP.post ou g_http.post fica na memória até o cliente fechar.
  • Uma limpeza do lado Lua com HTTP.operations ou HTTP.cancel não ajuda. Os corpos ficam do lado C++.

Medimos isso em clientes do jogo.

TesteResultado
Capturas da visão do jogo, enviadas com HTTP.post, cerca de 370 KB cada2 clientes caíram depois de cerca de 1.000 envios, com Critical lua error! em http.lua. O cliente de 32 bits ficou sem memória.
O websocket, g_http.wsEle guardou cerca de uma mensagem por envio num teste de 10 minutos.
As mesmas capturas, gravadas em arquivo, sem envio pelo clienteUm cliente rodou 4 h 26 min, com 4.526 capturas e 0 erros de memória.

A medida de memória do cliente, g_platform.getMemoryUsage(), não mostra esse crescimento. A visão do sistema operacional mostra. Por isso o módulo grava arquivos, e o script de envio cuida da rede.

Um ciclo

Cada personagem tem a própria pasta dentro da pasta de dados do cliente. O OTClientV8 chama a pasta de dados de "write folder". Clientes no mesmo computador muitas vezes dividem essa pasta.

InstalaçãoPasta do personagem
módulo na pasta modulesvoidwatch/<character>/
módulo na pasta do bot, no Orionbot/_voidwatch/data/<character>/

Os caminhos abaixo ficam dentro da pasta do personagem.

  1. O módulo grava outbox/status.json. Ele grava a cada 2 segundos enquanto alguém acompanha o personagem, e a cada 5 segundos enquanto o Radar da equipe o mostra. No resto do tempo, ele grava a cada 30 segundos.
  2. O script envia o arquivo para POST /api/v1/status. Ele grava a resposta em inbox/reply.json.
  3. A resposta define com que frequência enviar uma captura de tela. É a cada 1–2 segundos enquanto alguém acompanha o personagem. No resto do tempo, é uma vez por minuto.
  4. Quando há comandos esperando, o script os busca para um arquivo novo, inbox/commands-<time>-<n>.json. O módulo executa cada comando uma vez e pula comandos com mais de 60 segundos. Ele adiciona cada resultado a outbox/results.json.
  5. Entre dois status, o script mantém uma requisição aberta para GET /api/v1/wait. A requisição volta quando alguém abre o personagem, um alerta dispara ou chega um comando. O cliente então acelera em até um segundo. Com a exiva em equipe ligada, o script pergunta GET /api/v1/wake a cada 2 segundos em vez disso. Os arquivos dele nunca esperam por uma requisição longa. Um cliente com exiva em equipe que não pergunta envia o status a cada 2 segundos.
  6. Uma vez por minuto, o script confere cada arquivo minimap*.otmm do cliente. Ele envia cada arquivo que mudou, com a hora da mudança. Cada arquivo vai no máximo a cada 30 minutos. O site junta cada arquivo ao mapa do jogador. Um arquivo nunca remove uma área. Quando a resposta traz needMap: true, o script envia todos os arquivos de novo. Os jogadores podem desligar isso nas configurações do módulo.

Pareamento

Um cliente novo não tem token.

  1. O módulo grava outbox/pair-request.json.
  2. O script chama POST /api/v1/pair.
  3. A resposta traz um código e um link para o jogador. Ela também traz o token, que o script guarda.

Um código que ninguém usa expira depois de 15 minutos. O script então pede um código novo.

Atualizações

O módulo nunca baixa código. O servidor pergunta ao GitHub pela versão mais nova a cada 5 minutos. Cada resposta ao status passa essa versão adiante, como latestModule. O script de envio também pergunta ao GitHub sozinho a cada 6 horas. Ele grava a maior das duas versões em latest.json.

Os arquivos de atualização ficam na raiz de dados, não na pasta de um personagem. A raiz de dados é voidwatch/. Para um módulo na pasta do bot, ela é bot/_voidwatch/data/.

  1. O jogador clica em Update. O módulo grava update-request.json com a versão e o personagem.
  2. O script baixa do GitHub o zip da versão e o SHA256SUMS dele. Ele confere a soma de verificação e a versão dentro do zip.
  3. O script copia a pasta antiga do módulo para backup/. Ele coloca a pasta nova no lugar.
  4. O script grava update-result.json. O cliente que pediu recarrega o módulo. Os outros clientes oferecem Reload.

Roll back grava rollback-request.json. O script então põe a cópia de segurança de volta.

O script lê versões só do GitHub, nunca do site. Assim, quem invadir o site não consegue mandar código para os clientes.

Faça o seu

Tudo é aberto, com a licença MIT:

Mantenha a estrutura de arquivos, e seu módulo funciona com nossos scripts de envio. Você também pode escrever o seu próprio programa de envio, em qualquer linguagem.

Um servidor também pode incluir o módulo no próprio cliente. Fale conosco, e listamos o servidor como parceiro.