Manuel d'utilisation du script Ruzzz

Le script Ruzzz est un outil pour le jeu Fourmizzz destiné à améliorer l'expérience de jeu, le confort, la sécurité, l'efficacité et la vie d'alliance.

Ruzzz est un script fonctionnant avec l'extension GreaseMonkey sur Firefox (ou avec TamperMonkey sur Chrome/Opera...).

L'utilisation du script ne nécessite pas de s'inscrire sur le site de Ruzzz, de plus le script n'échange aucune donnée avec le site (sauf pour le cas particulier des expatriés -joueurs qui veulent pouvoir utiliser ruzzz pour faire des convois vers leur alliance mère-, mais cette fonctionnalité requiert une démarche explicite de la part des administrateurs de l'alliance).

Les fonctionnalités de Ruzzz

• Un menu en forme de fleur
• Un traceur des échanges de terrain, des évolutions et changements d'alliances des joueurs.
• Des tableaux de récap d'infos tracées et des graphiques récapitulatifs des infos tracées
• Une map améliorée des joueurs d'une ou plusieurs ally superposables, avec les animations des convois
• Une gestion des convois de l'alliance
• Un mini-panneau multi-flood
• Des alarmes de nouveau message (courrier,rentrée de chasse, combat...), un son différent pour les rapports de combats(enveloppes rouges)
• Des pages upgradées : messages collectifs, page de membres, page forum alliance
• Un panneau de paramétrages(=options) : toutes les fonctionnalités sont en option
• Chat Alliance avec quelques options supplémentaires (alerte relayée via discord, taille de la police) et Chat Général archivable sur discord pour ne rater aucune discussion

Le fonctionnement

Ruzzz utilise 2 forums :

• Forum Convois (public)

• Forum ruzzz (caché ou restreint)

  Ce forum doit être visible uniquement par les membres du conseil et administrateurs de ruzzz -donc avec les droits cachés ou restreints -. Il comporte plusieurs topics, appelés ici fichiers :
  • Le fichier ruzzz.ini: fichier d'initialisation ruzzz.ini (nécessaire a l'utilisation de l'extension) qui comporte notamment le numero du forum de la bdd partagée et les numeros des forums de livraison bois et pommes.
  • Les archives ruzzz*.db: c'est la base de donnée de Ruzzz; il est possible d'accéder aux données via l'outil des tableaux et graphes.
  • Un fichier ruzzz.db courant: UNIQUEMENT JOUEURS AYANT LES DROITS ADMIN + DROITS DE VOIR FORUM CACHE
    ruzzz.db contient les relevés courant pouvant être faits par n'importe qui. Donc ne peut fonctionner qu'en forum ouvert ou caché (à cause des droits de modification d'un sujet de forum) pour que tous puissent y ajouter des donnees de relevés ou des nouveaux modeles de tableau.
    Ce principe permet aussi d'accéder librement aux donnees bruts sans l'extension (et un certain droit de regard de l'alliance sur les données recueillies) meme si le sujet est verrouillé pour empecher les modifications involontaires ou malveillantes. Cette transparence peut aussi être vue comme un défaut puisque chacun voit aussi toutes les infos avec les pseudos et les dates et heures de(s) mise(s) à jour constatée(s) par les autres membres. A débattre. On peut eventuellement mettre ces données en privé et réserver les relevés aux utilisateurs ayant les droits restreints...
  • Un fichier ruzzz.mtb : UNIQUEMENT JOUEURS AYANT LES DROITS ADMIN + DROITS DE VOIR FORUM CACHE
    Contient des modèles de tableau récapitulatifs modifiables et ouvert à tous les utilisateurs
  • Un fichier ruzzz.var : UNIQUEMENT JOUEURS AYANT LES DROITS ADMIN + DROITS DE VOIR FORUM CACHE
    Un peu comme des cookies de fonctionnement mais partagés par l'alliance et servant à améliorer l'efficacité de l'outil. Permet de gérer les conseillers

Ruzzz est toujours en cours de développement. Surtout signalez-moi les bugs si vous en trouvez!

Installation

sur Mozilla Firefox

1. Installer GreaseMonkey https://addons.mozilla.org/fr/firefox/addon/greasemonkey. Vérifier que GreaseMonkey est activé (par défaut c'est activé).
2. Allez sur Fourmizzz. Il faut être connecté à son compte.
   Pour lancer l'installation du script : cliquez sur le lien de la dernière version (v0.89.4) que vous trouverez sur le discord de Ruzzz (présentez-vous en arrivant : donnez votre pseudo et serveur de fourmizzz)
3. Vérifier que le script Ruzzz est activé dans GreaseMonkey (par défaut c'est activé normalement).
4. Rechargez la page de fourmizzz

sur Chrome, Opera, ...

L'installation est sensiblement la même que sur Firefox (voir ci-dessus) sauf qu'il faut télécharger TamperMonkey au lieu de GreaseMonkey.

Bug Chrome 2024 : un bug empêche TamperMonkey de fonctionner correctement à cette heure sur Chrome et donc ruzzz ne se lance pas correctement. Si vous voulez en savoir plus sur ces bugs de Chrome apparus cette année: https://github.com/Tampermonkey/tampermonkey/issues/2011. Il y a cependant une solution en 3 étapes pour faire fonctionner Tampermonkey.
- D'abord vérifiez que vous ayez la dernière version de TamperMonkey (le problème pourrait être résolu) : https://www.tampermonkey.net/index.php?browser=chrome.

- Ensuite si le bug persiste :

• aller dans la barre d'adresse et taper ou copier/coller : chrome://flags/
• dans le champs de recherche qui apparaît, chercher mutation et passer le paramètre à enabled (=autoriser)
  
• fermer et réouvrir Chrome

- Si cela ne fonctionne pas, essayez en activant également le mode developpeur (nouvelle securité de Chrome, grrr) :

• Tapez dans la barre d'adresse : chrome://extensions/
• en haut à droite normalement, activez le Mode développeur

Après normalement ça fonctionne ☺. Peut-être faut-il aussi forcer le rechargement des pages de fourmizzz ctrl+F5.

Sur téléphone Android/tablette

Apparemment il serait possible d'installer Tampermonkey sur téléphone Android ou tablette via Microsoft Edge : https://www.tampermonkey.net/index.php?browser=edge. Je n'ai pas testé et je doute que cela fonctionne vues les dernières mises à jour de Chrome mais partagez votre expérience si vous essayez via le discord de Ruzzz svp ...

Initialisation de ruzzz dans l'alliance

Lorsque Ruzzz n'est pas encore installé dans l'alliance, seul un administrateur (UNIQUEMENT JOUEURS AYANT LES DROITS ADMIN + DROITS DE VOIR FORUM CACHE) peut initialiser ruzzz.
Le menu est une fleur en bouton et l'administrateur clique sur la fleur et un menu s'ouvre proposant l'installation de ruzzz : cliquer sur le bouton Installation et suivre les instructions.

Premiers pas

Une fois ruzzz initialisé dans l'alliance :

• soit vous avez les droits admin : ruzzz fonctionne automatiquement, la fleur est épanouie.
• Soit vous n'avez pas le statut admin : le menu est une fleur en bouton et cliquer dessus permet de renseigner le numero du fichier ini. Il faudra qu'un administrateur de l'alliance vous donne le numero de ce fichier. Une fois rempli le champs du fichier ini, presser Ok. La page se recharge.

À la toute première utilisation, l'initialisation peut durer plusieurs secondes. Important : patientez jusqu'à la fin du processus d'initialisation.

Voilà, à partir de ce point, la fleur est ouverte et il y a 3 ou 4 pétales selon vos droits. Cela veut dire que tout fonctionne, vous pouvez utiliser Ruzzz :)
Parametrez vos options menu options (par défaut les fonctionalités sont éteintes)
Administrateurs, configurez les conseillers et les rangs.

Bon à savoir

Ruzzz ne s'active pas sur la page de connexion (ni ne repère vos mots de passe)
Ruzzz utilise des cookies nécéssaires à son fonctionnement et à sa configuration
Ruzzz ne consomme que quelques Mo d'espace sur le disque dur, quelle que soit la durée d'utilisation
Ruzzz ne récolte pas de données sensibles (et si cela devait arriver dans le futur, votre accord sera nécessairement demandé)

N'hésitez pas à me demander si vous rencontrez des difficultés, je vous aiderais.

Dans un premier temps, si ruzzz n'est pas installé, la fleur est en bouton. On peut accèder aux menu d'initialisation de Ruzzz.

Si ruzzz est configuré la fleur présente ses pétales. On peut alors accèder aux fonctionnalités des outils.
Par le menu, on peut accéder au traceur (UNIQUEMENT JOUEURS AYANT LES DROITS ADMIN), aux paramètrage (ou options), aux tableaux et graphes et aux maps

On peut déplacer le menu-fleur où on souhaite en le tenant par la tige. Si jamais on le perd hors écran : Alt+Entrée pour réinitialiser sa position.

Le traceur est uniquement accessible aux joueurs ayant l'outil Ruzzz + DROITS ADMIN + DROITS DE VOIR FORUM CACHE.
Il est accessible par l'icône .

Un relevé de données est fait si l’utilisateur le souhaite. Chaque relevé peut cibler une ou plusieurs alliances selon la volonté de l'utilisateur.

Il permet de noter les échanges de terrain(floods, vente de terrain,...), les évolutions et changements d'alliances des joueurs. Il fournit les données utilisées pour l'élaboration des tableaux et graphes, d'historiques mais aussi du récapitulatif des convoyeurs (pour calculer la production de bois par exemple).

Le traceur alimente la base de donnée. Celle-ci est en fait constituée de posts sur le forum de ruzzz/topic ruzzz*.db. Cela a l'avantage de ne nécessiter aucun serveur externe à Fourmizzz, en quelque sorte l'alliance a son propre serveur.

Pour un fonctionnement optimal de ruzzz, il est recommandé de faire au moins un relevé de l'alliance par jour.

Le forum Convois est créé automatiquement lors de l'initialisation de ruzzz. Il comporte un topic Demandes de bois où les joueurs font leur demande. Le 1er post de ce topic est une notice explicative à l'usage des membres de l'alliance. Le 2e post montre les demandes et leurs statuts mis à jour en temps réel.

La page Convois de Fourmizzz upgradée par ruzzz est composée de 3 onglets:

• l'onglet des demandes de convois
• l'onglet des convois en cours. Choisir un convoi dans la liste des convois en cours et poster automatiquement les convois réalisés sur forum bois en même temps qu'on lance le convoi + calculer le reste à livrer automatiquement
• l'onglet récapitulatif des convoyeurs

Les demandes de convois

Chaque joueur peut demander un convoi (même sans avoir ruzzz) en postant sa demande sur le forum Convoi/topic Demandes de bois. La demande doit comporter l'évolution et le montant.

Chaque demande est traitée par ruzzz, visible dans l'onglet des demandes et validée et mise en attente ou refusée par un administrateur.

Un convoi validé et en attente peut changer de statut vers convoi en cours. Cela créé un topic dédié où seront postés les convois de chaque convoyeur, manuellement ou automatiquement avec ruzzz lors de l'envoi du convoi.

Les convois en cours

Chaque convoi en cours a un topic dédié créé automatiquement par ruzzz dans le forum Convois lorsque le statut du convoi devient En cours.
Le nom de ce topic associé est toujours : [Taille du convoi] Nom du destinataire : montantG
(Lorsque le convoi est terminé, ruzzz ajoute Terminé au nom du topic)

Le 1er post du topic pour un convoi reprend les informations de la demande, à savoir :
date_de_la_demande : pseudo_du_destinataire : montant en G : Evolution et niveau : statut
Par exemple :
22/08/21 : ruru : 82 463.4G : Couveuse 37 : en cours

Page convois : chaque topic de convoi en cours ou terminé est listé.

Pour chaque destinataire, il y a le temps de parcours et le reste à livrer.
Au survol d'un convoi de la liste, on voit le détail des livraisons effectuées et les 20 derniers convoyeurs, heure et montant.
Également, on peut voir la moyenne des livraisons/jour sur chaque convoi en cours ainsi que la moyenne totale livraisons/jour de l'ensemble des convois en cours.
Un convoi en cours peut changer de statut : soit vers terminé, soit suspendu (cela peut être utile si le destinataire est absent par exemple).

Envoi d'un convoi

• sélectionner un convoi de la liste des convois en cours prépare ce convoi avec max de bois et le reste est calculé, le post (exemple 15G reste 250G) qui sera envoyé sur le forum du convoi correspondant est affiché
• lancer le convoi lance le convoi et poste automatiquement en même temps sur le topic du convoi concerné
• lorsque le convoi est terminé, soit il se clôt tout seul si on dispose des droits administrateur au dernier convoi (=ajout de la mention "Terminé" dans le titre + verrouillage du convoi). Sinon, il se clôturera lorsqu'un administrateur passera sur la page.

Remarques : un joueur qui ne possède pas Ruzzz ou sur telephone peut envoyer un convoi normalement. Pour être comptabilisé, il doit poster le montant du convoi dans le topic associé suivi de l'unité (M, G ou T).
Par exemple : 20.3G
Les convois sont gerés en G par défaut. C'est à dire que si on poste juste : 20.3, ruzzz interpretera cela en G.

Les soldes

Les soldes sont calculés automatiquement lorsqu'un joueur envoie un convoi à l'aide de ruzzz. Le solde est calculé est la mention : reste nG est ajoutée.

Si le solde est faux ou nécéssite d'être réajusté, il suffit de poster un message dans le topic du convoi associé : reste nG

Les exceptions

Certaines situations peuvent nécessiter l'utilisation d'exceptions afin de comptabiliser correctement les convois. Dans le topic de convoi d'un joueur, ruzzz peut reconnaitre 2 exceptions : $$de et $$autoprod.

Une exception est un post qui ne comporte qu'une seule ligne : l'exception ($$de xxx nG ou $$autoprod nG).

L'exception $$de

permet de comptabiliser un convoi, ou l'autoprod du destinataire du convoi, ou la livraison d'un autre joueur.
Exemple de post : $$de ruru 50G

L'exception $$autoprod

permet de comptabiliser l'autoproduction du destinataire du convoi.
Exemple de post : $$autoprod 500G

Astuce : un joueur en autoprod peut marquer lui-même son autoprod en inscrivant simplement le montant dans un nouveau post de son convoi sans nécessairement utiliser d'exception. Il peut par exemple marquer sa production journalière (qu'il trouvera à droite du tableau récapitulatif des convois).

Convoi terminé et archivage

Un convoi est terminé automatiquement par ruzzz dans 3 situations :

• le dernier message contient la mention : reste 0 ou reste 0G
• un admin disposant de ruzzz passe par la page convoi et le calcul automatique des restes obtient un résultat égal ou inférieur à 0
• un admin change le statut de la demande vers Terminé dans l'onglet des demandes

Lorsque le statut est changé, la demande initiale du destinataire est supprimée et le topic du convoi est marqué Terminé. Un message toast apparaît pour signaler les changements effectués.
Ensuite le convoi peut être archivé par un administrateur dans l'onglet des demandes (si un forum d'archivage a été fourni dans ruzzz.ini)

Le récapitulatif des convoyeurs

Est considéré comme convoyeur tout joueur ayant récolté au minimum 50G sur le mois, ou ayant actuellement un tdc supérieur à 100 000 000cm², ou ayant fait 1 convoi dans le mois. Les membres VIP (qui ont le mot "vip" dans le nom du rang) ne sont jamais considérés comme convoyeurs et ne sont pas inclus dans les stats de récolte de l'alliance.

Pour que les calculs de production de bois soient assez précis, il est conseillé de faire au moins un relevé (traçage) par jour de l'alliance ou des alliances participants au convoyage à l'aide du traceur.

Le panneau est visible sur chaque page de Fourmizzz si l'option est cochée dans les options.

Note : pour gérer les rangs et l'ordre de la chaîne, veuillez consulter Les rangs

3 Modes de floods rapides et optimisés sont proposés :

• M : MultiFlood
• F : Flood (chaîne)
• Fλ : Flood (tous)

Multiflood (MF)

Le meilleur enchaînement de floods possible en respectant l'ordre de la chaine

Flood chaîne (F)

Tous les floods optimisés qui respectent l'ordre de la chaine.

Flood tous (Fλ)

Tous les floods optimisés possibles, y compris hors chaîne.

Les graphes, tableaux (et maps) sont accessibles par l'icône

Les graphes, tableaux et maps personnalisés sont créables, modifiables et consultables par n'importe quel membre de l'alliance ayant l'outil Ruzzz (même s'il ne fait pas de relevés). Cependant seuls les membres ayant les droits admin peuvent sauvegarder les modèles. Notez que les modèles sauvegardés sont accessibles à tous.

Le paramétrage de modèle

Le panneau de paramètrage s'affiche et l'on peut charger un modèle ou en créer un nouveau en ajoutant des paramètres.

L'affichage du modèle

Une fois choisi le modèle, afficher ou actualiser le résultat en cliquant sur une des 3 icones de vue suivantes :

Le résultat s'affiche, par exemple des graphiques.

Remarque : les pointillés représentent des périodes où aucun tracage n'a été fait.

Les maps (=cartes) sont accessibles par l'icône . Plus précisement, par défaut c'est la map de l'alliance qui est ouverte.

Le bouton Éditer modèle permet d'accéder au panneau de paramètrage, de modifier ou charger un modèle.

Votre position est indiquée par un petit triangle. La taille du cercle couleur de l'alliance d'un joueur représente le terrain de chasse proportionnellement.
Les cercles bleus et rouges montrent les joueurs attaquables et défendables selon le joueur que vous incarnez (il est possible de le changer en cliquant sur un pseudo de la carte).

On peut localiser et centrer la map sur un joueur en cliquant sur son pseudo dans la liste des joueurs sous la map. Il sera détouré d'un cercle à tirets larges gris.
On peut se mettre dans la peau de n'importe quel joueur en cliquant sur le pseudo sur la map. Il sera détouré d'un cercle à tirets larges bleus. Si la VA de ce joueur est renseignée, survoler un autre joueur affichera le temps de trajet vers ce joueur. Cela peut être utile pour essayer de trouver la VA d'un joueur à partir de rapports de combats.

Survoler un joueur 2 secondes permet de lire et afficher un résumé des données fournies sur sa page membre en temps réel.
Il est possible d'aller directement sur la page Membre d'un joueur -pour attaque, flood, convoi, message,...- : maj+clic sur le nom dans la map (cela ferme la map), ctrl+maj+clic pour ouvrir dans un nouvel onglet

Une tirette (en-bas à droite de la map) permet de modifier la visibilité des joueurs qui ne sont pas à portée.

Multi-alliances

Il est possible d'ajouter plusieurs alliances et/ou joueurs sur une même carte. Dans ce cas, chaque alliance a sa couleur. Chaque alliance peut être vue ou cachée, éditée (liste des joueurs).

Map avec animation des convois

Si on est dans l'onglet de récapitulatif des convois et qu'on clique sur l'icone de map de la fleur de ruzzz, la map de l'alliance est chargée et les convois du mois sont affichés et animés.

Les alarmes sont activables via les options. Si activées, l'arrivée des messages et le chat sont vérifiés 1 fois par minute.

Quelle que soit la page de Fourmizzz ou vous vous trouvez, vous serez averti de l'arrivée d'un message dans votre messagerie ou sur le chat alliance.

Messages

Un son de cloche vous prévient de l'arrivée d'un message.
Un son différent (genre guerriers) vous prévient de l'arrivée d'un message concernant la chasse ou la guerre.

Chat

Un son de cloche vous prévient de l'arrivée d'un message dans le chat.
Une fenêtre au bas de l'écran (appelé toast) montre l'état du chat-alliance ou le nouveau message entrant selon le contenu que vous connaisez déjà.

Retour de troupes

Une alerte est également programmable par un bouton en bas de l'écran lorsque vous rappelez des troupes (décolonisation).

Les alertes sur le chat

Il est possible de signaler une alerte -une urgence- sur le chat en cliquant sur 🔴ALERTE🔴.

De plus, si les administrateurs ont configuré le lien vers discord dans le fichier ini, une alerte ainsi créée sera transmise immédiatement au salon discord associé, ainsi que texte contenu entre les balises de l'alerte.

Accédez aux options par l'icone

Par défaut, toutes les fonctionalités sont éteintes!

Note aux administrateurs

Si vous disposez des droits d'admin, le panneau des options fournit en plus :

• le numéro du fichier ini. Ce numéro est à transmettre aux nouveaux utilisateurs de ruzzz qui ne disposent pas des droits administrateur
• une case à cocher Son au traçage qui permet de ponctuer éventuellement le début d'un traçage

La page d'envoi de message collectif est aussi améliorée : ruzzz permet d'envoyer un message collectif à un rang particuliers, ou à plusieurs rang, ou au conseil grâce à des boutons associés.

Notes :

• pour gérer les membres du conseil, veuillez consulter Les conseillers
• pour gérer les rangs, veuillez consulter Les rangs

La page des membres est upgradée : visibilité les droits accordés à chaque joueur en un clin d'oeil grâce à des petites leds affichées sous le pseudo.

La couleur des leds vert, jaune, rouge correspond à la sensibilité d'un droit activé. Si la led est grise : le droit n'est pas activé.
Au survol d'une led, le nom du droit correspondant apparaît.
De gauche à droite il y a : Voir les candidatures, Gérer les candidatures, Envoyer des messages collectif, Gérer la diplomatie, Voir les forums cachés, Voir les forums restreints, Administrer le forum, Administrer l'alliance.

Si l'option est cochée dans les options, le forum est upgradé.

• les boutons sont colorés.
• Un forum dont le nom commence par --- ou ___ sera invisible (aux utilisateurs de ruzzz). Cela permet d'insérer un espace de séparation entre différents groupes de forums pour une meilleure lecture de la page.

Note : déconseillé aux daltoniens.

Les conseillers

Les rangs