What is MountyZilla ?

MountyZilla is a Firefox add-on providing extra features for the on-line game MountyHall. This game is avaliable in French only (actually, in Belgian only), and the whole community around it is French speaking. So sorry but the rest of this ReadMe file, as well as every single file in this repo, will be in French.

Notes à l'intention des développeurs

Fonctionnement général de l'extension

MountyZilla est constitué d'un module interne (add-on Firefox), ainsi que d'une série de scripts distants.

Le module interne doit être une simple base de travail, qui doit être la plus fixe possible, tout en contenant tout ce qui est nécessaire au bon fonctionnement des scripts distants.

L'élément le plus susceptible de changer dans le module interne est le script maître : c'est lui qui décide, en fonction de la page chargée dans le navigateur, à quel script distant il doit confier le post-traitement de la page.

Les scripts distants sont hébergés sur un serveur dédié, et contiennent les actions à effectuer sur chaque page. En général, chaque script n'est appelé que sur la page pour laquelle il a été spécifiquement conçu. (À quelques exceptions près : la bibliothèque de fonctions libs_FF.js est par exemple appelée sur toutes les pages.)

Environnement de travail pour le développement

Codage ponctuel : créez votre propre script maître.

Le plus simple, si vous êtes un codeur occasionnel, est de commenter les lignes du script maître associées aux pages sur lesquelles vous travaillez, et d'ajouter votre script comme un script complémentaire. Simple et efficace.

Codage avancé : recréer un MountyHall local

Si vous souhaitez vous investir davantage dans le développement, il vous faudra probablement faire de très nombreux tests sur de très nombreuses pages : impossible dès lors de tester en live sur MountyHall. Le plus simple dans ce cas est de monter un serveur local pour simuler le jeu et y faire vos tests. Créez-vous un serveur dédié, et déposez-y une batterie de pages Mountyhall modifiables à l'envi pour vos tests.

Quelques consignes avant de contribuer

Pour le moment, sont disponibles en ligne uniquement les scripts distants. Voici quelques consignes que je tente de respecter lorsque je code. Ce ne sont pas des règles absolues, mais tant qu'à faire si on peut harmoniser la syntaxe, c'est pas plus mal...

1. Soyez patient. MountyZilla est un agglomérat de participations de codeurs d'origine et de niveaux divers et variés. Vous n'aurez donc pas affaire à un code suroptimisé écrit par des professionnels du javascript. Préparez-vous, vous n'êtes pas à l'abri de portions de code perdurant depuis l'ère des dinosaures...
2. Faites simple. Ne cherchez pas à produire un code diaboliquement intelligent. Il deviendra illisible et la moindre modification ultérieure demandera de réécrire la totalité de votre contribution.
3. Commentez. Même si la notation pdcdlcopf est très claire pour vous (portée-de-la-charge-dans-le-cas-où-il-n'y-a-pas-de-fatigue`), dites-vous bien que ce ne sera pas le cas pour tout le monde. Au besoin, créez une doc externe.
4. Faites compact. Pas de ligne de 200 caractères impossible à afficher et à décrypter. Les règles de développement chez Mozilla sont :

• des lignes de 80 caractères maximum,
• avec des tabulations équivalant à 2 caractères. Ce sont me semble-t-il des choix de limites raisonnables à se fixer.

5. Codez en javascript. Le langage Javascript, en particulier celui embarqué par les navigateurs, fourmille d'un million de façons différentes d'effectuer une même action. Si vous devez choisir entre diverses méthodes, efforcez-vous de donner priorité à la syntaxe javascript.

Licence

MountyZilla est distribué sous Licence GNU GPLv2. Si vous comptiez en tirer profit, la sortie est par là --> [].