Home

Créer son premier plugin

Voilà quelques étapes à suivre, pour les débutants.

1. Télécharger assistant-template : https://github.com/Aymkdn/assistant-template/archive/master.zip

2. Décompresser le dossier que vous venez de télécharger quelque part sur votre ordinateur

3. Renommer le dossier décompressé avec le nom de votre plugin (ici on dira que le plugin s'appelle exemple, donc le dossier s'appellera assistant-exemple). Mon chemin d'accès ressemble alors à : C:\mes dossiers\assistant-exemple\

4. Dans ce dossier assistant-exemple vous devriez avoir les fichiers suivants :

   • .gitignore
   • configuration.json
   • install_template.bat
   • LICENSE
   • package.json
   • README.md
   • template.js

5. Renommer le fichier template.js en exemple.js (donc le nom de votre plugin)

6. Éditer le fichier package.json pour remplacer les 3 occurrences du mot template par exemple et on en profite pour y indiquer les bonnes informations

7. Renommer le fichier install_template.bat en install_exemple.bat, puis l'éditer pour remplacer le mot template par exemple

8. Le développement du plugin va se faire dans le fichier exemple.js, en commençant par renommer toutes les occurrences de AssistantTemplate en AssistantExemple, et on fait de même pour assistant-template qu'on remplace par assistant-exemple

9. Dans le répertoire de votre plugin assistant-exemple on va ouvrir une console de commandes pour taper :

   npm install request request-promise-native
   

   On peut aussi y ajouter les autres packages dont ce plugin pourrait avoir besoin.

10. On ajoute ensuite ce plugin dans assistant-plugins en se rendant dans le répertoire d'assistant-plugins et en tapant dans une console de commandes :

    npm install "C:\mes dossiers\assistant-exemple\"
    

11. On relance assistant-plugins pour voir si le nouveau plugin a bien été pris en compte :

D:\assistant-plugins>node index.js
[assistant] Assistant v2.0.12 : Chargement en cours...
[assistant] 3 plugins trouvés.
[assistant] Chargement du plugin 'exemple' (v2.0.0)
[assistant-exemple] Plugin chargé et prêt.  <--- Notre plugin est reconnu et chargé !
[assistant] Chargement du plugin 'freebox' (v2.0.11)
[assistant-freebox] Récupération des chaines terminée !
[assistant-freebox] Plugin chargé et prêt.
[assistant] Chargement du plugin 'notifier' (v2.1.6)
[assistant-notifier] Plugin chargé et prêt.
[assistant] Connexion au flux de PushBullet...
[assistant] (2019-02-10 15:08:22) Connecté ! Prêt à exécuter les ordres.

11. On peut maintenant coder dans le fichier exemple.js. Il suffira ensuite de relancer asssitat-plugins pour que le nouveau code soit chargé

12. Pour tester son plugin, on peut soit créer des applets IFTTT avec, dans le corps du message vers Pushbullet mettre exemple_commande, soit en utilisant une ligne de commande comme expliqué ici

13. Une fois que votre plugin vous semble satisfaisant, vous pouvez lui créer un repository sur Github. Il est possible de s'aider de l'application Github Desktop pour uploader les fichiers.

14. Une fois tout en place, contactez-moi pour soumettre votre plugin !