Bonnes pratiques pour les outils Vlm

Cette page est un draft qui demande à être complété.

Gestion du multi-boat

• Les outils peuvent manipuler plusieurs bateaux.
  • Il est demandé aux développeurs de limiter le nombre de bateaux gérés à 5.
  • Il est également demandé aux développeurs de demander au joueur si c'est "son" boat qu'il paramètre ou celui "d'un autre", sans qu'il y ait actuellement d'impact vis à vis de Vlm. Cela peut simplement permettre d'alerter le joueur quand il a deux bateaux à lui sur la même course. Et ça servira ultérieurement quand Vlm intègrera la notion de boat-sitting

Utilisation des ressources Vlm

• De manière générale, il faut être respectueux de la bande de passante et de la charge des serveurs. En particulier :
  • pas plus d'une requête automatique pour récupèrer les boatinfo par vac.
  • en l'absence d'action de l'utilisateur pendant 20min, arrêter la récupération automatique
  • mettre en cache les drapeaux (au sens image)
  • mettre en cache les raceinfo, mais pouvoir les rafraichir manuellement. Cela veut dire : ne pas les rafraichir automatiquement quand les données sont présentes dans le cache.
• Ne pas gérer plus de traces que ne l'autorise Vlm.
• Utiliser les calques séparés si vous récupérez les maps de vlm.

Faciliter la vie des développeurs de VLM

• Essayez de vous tenir au courant des évolutions des interfaces (web-services) mis à dispo, afin que VLM ne soit pas obligé de maintenir des vieilles méthodes pour votre programme.
  • En particulier, merci d'utiliser les urls qui sont dans /ws/ en json, qui est le format pérenne de Vlm. Cela veut dire utiliser /ws/boatinfo.php à la place de /getinfo.php
• Faites vous connaitre !
  • La meilleure façon d'épargner à tous de l'énergie est de référencer votre programme dans ce wiki.
  • Publiez votre code (par exemple en demandant un accès à VlmTools). C'est conforme à l'esprit de Vlm, et ça peut permettre de détecter plus rapidement si un disfonctionnement provient de votre programme ou de Vlm lui-même.