Bonnes pratiques pour les outils Vlm : Différence entre versions

De VlmWiki
Ligne 7 : Ligne 7 :
 
** 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
 
** 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 =
+
= Utilisation des ressources Vlm - Règles 2.x =
  
 
* De manière générale, il faut être respectueux de la bande de passante et de la charge des serveurs. En particulier :
 
* 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. Ou pas de requête automatique du tout ;)
+
** pas plus d'une requête automatique pour récupèrer les boatinfo par vac. Ou pas de requête automatique du tout ;) '''Règle 2.1.'''
 
** en l'absence d'action de l'utilisateur pendant 20min, arrêter la récupération automatique
 
** 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 drapeaux (au sens image) '''Règle 2.2.'''
 
** 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.
 
** 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.
+
* Ne pas gérer plus de traces que ne l'autorise Vlm. '''Règle 2.3.'''
* Utiliser les calques séparés si vous récupérez les maps de vlm.
+
* Utiliser les calques séparés si vous récupérez les maps de {{V}}. '''Règle 2.4.'''
  
 
= Faciliter la vie des développeurs de {{V}} =
 
= Faciliter la vie des développeurs de {{V}} =

Version du 15 mars 2010 à 19:38

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. Règle 1.
    • 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 - Règles 2.x

  • 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. Ou pas de requête automatique du tout ;) Règle 2.1.
    • 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) Règle 2.2.
    • 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. Règle 2.3.
  • Utiliser les calques séparés si vous récupérez les maps de Virtual Loup de Mer. Règle 2.4.

Faciliter la vie des développeurs de Virtual Loup de Mer

  • 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
    • N'hésitez pas à solliciter les développeurs de Virtual Loup de Mer
  • 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 Virtual Loup de Mer, et ça peut permettre de détecter plus rapidement si un disfonctionnement provient de votre programme ou de Virtual Loup de Mer lui-même.