Mods

Fichiers concernés :

• fichiers dans mods/
• available-mods.json

---

Dans le jargon d'ItsBetter, les mods sont des fonctionnalités modulables ajoutées à l'extension à l'aide de fichiers CSS et JS.

Déclaration d'un mod

Pour que le service worker de l'extension détecte le mod et l'ajoute à la liste de ceux disponibles pour l'utilisateur, celui-ci doit être décléré dans le fichier available-mods.json.
Un mod se présente sous la forme suivante dans available-mods.json:

{
    "id": "mod-float-perso-menu",
    "title": "Menu personnel flottant",
    "desc": "Transforme le menu personnel en menu flottant et unifie son apparence",
    "frame": "main",
    "default-state": true,
    "files": ["/mods/float-perso-menu.css"],
    "matches": ["https://*.itslearning.com/*"],
    "version": "v1.0",
    "hidden": false
}

• id : identifiant unique utilisé par le script de l'extension pour identifier votre mod
• title : titre de votre mod affiché dans le popup de l'extension
• desc : description de votre mod affichée dans le popup de l'extension
• frame : main pour que vos fichiers soient injectés dans la frame principale uniquement ou all pour qu'ils soient injectés dans toutes les frames (iframes)
• default-state : true pour que votre mod soit activé par défaut quand l'utilisateur installe l'extension ou la met à jour, ou au contraire false
• files : liste des chemins des fichiers CSS et/ou JS mélangés nécessaires pour faire fonctionner votre mod ; un chemin est de la forme /mods/votre-fichier
  Note : le / initial n'est pas obligatoire
• Facultatif (non implémenté pour l'instant) matches : la ou les URL pour lesquelles votre mod sera appliqué
• version : la version de votre mod affichée dans le popup de l'extension
• hidden : true pour que votre mod soit affiché dans le popup de l'extension, ou au contraire false