Merge pull request #182 from geotribu/feature/qchat

feature: qchat

README.md

@@ -17,3 +17,5 @@ Plugin pour QGIS > 3.28
 Inutile au travail donc forcément indispensable.
 
 :book: :fr: [Voir la documentation](https://geotribu.github.io/qtribu/)
+
+:sound: Audio sounds come from [pixabay.com](https://pixabay.com) (see [terms of license](https://pixabay.com/service/license-summary/))

docs/installation.md

@@ -1,19 +1,41 @@
 # Installation
 
-## Depuis le projet Github
+## Dépendances
+
+Certaines fonctionnalités du plugin reposent sur des dépendances logicielles tierces non incluses dans le packaging de QGIS sur certaines plateformes :
+
+- QGISChat: (Py)QtMutimedia, (Py)QtWebEngine, (Py)QtWebSockets,
+
+### Linux
+
+> Par exemple sur Ubuntu 22.04. Adapter à votre distribution.
+
+Ouvrir un terminal et exécuter la commande suivante :
+
+```sh
+sudo apt install python3-pyqt5.qtmultimedia python3-pyqt5.qtwebengine python3-pyqt5.qtwebsockets
+```
+
+----
+
+## Version stable (recommandée)
+
+Le plugin est publié sur le dépôt officiel des extensions de QGIS : <https://plugins.qgis.org/plugins/qtribu/>.
+
+## Version stable depuis le projet Github (alternative)
 
 En plus d'être publié dans le dépôt officiel de plugins de QGIS, QTribu est également disponible via son propre dépôt personnalisé. Dans QGIS :
 
 1. Menu `Extensions` > `Installer/Gérer des extensions`
 2. Onglet `Paramètres`
 3. Sous la liste des dépôts, cliquer sur `Ajouter...` et renseigner :
-    * Nom :
+    - Nom :
 
         ```txt
         Dépôt personnalisé du plugin QTribu
         ```
 
-    * URL :  
+    - URL :  
 
     ```html
     https://github.com/geotribu/qtribu/releases/latest/download/plugins.xml
@@ -31,14 +53,40 @@ Selon votre configuration, redémarrer QGIS peut être nécessaire, le gestionna
 
 ----
 
+## Version en développement
+
+### Depuis une branche
+
+1. S'identifier sur Github.com
+1. Se rendre sur la page correspondant au workflow GitHub Actions "📦 Packaging & 🚀 Release" : [cliquer ici](https://github.com/geotribu/qtribu/actions/workflows/packager.yml)
+1. Filtrer sur la branche souhaitée
+
+    ![Github - Workflow run listing](./static/github_actions_workflow_packaging_listing.webp)
+
+1. Sélectionner la dernière exécution qui a fonctionné (avec une coche verte)
+1. En bas de la page _Summary_, télécharger l'artefact du plugin packagé :
+
+    ![Github - Workflow run summary](./static/github_actions_workflow_packaging_summary_annotated_artefact.webp)
+
+1. Décompresser le fichier ZIP.
+1. Ajouter le zip depuis le menu de QGIS ([voir la doc officielle](https://docs.qgis.org/3.34/fr/docs/user_manual/plugins/plugins.html#the-install-from-zip-tab) pour cette étape si besoin)
+
+:::{note}
+Il est aussi possible d'accéder à la page depuis l'onglet `Checks` de la Pull Request correspondante :
+
+![Github - PR Checks tab](./static/github_pr_checks_tab_annotated_packaging.webp)
+:::
+
+----
+
 ## Intégration dans QGIS
 
 Une fois installé, le plugin s'intègre :
 
-* dans le menu `Internet` :
+- dans le menu `Internet` :
 
 ![Menu QTribu](https://cdn.geotribu.fr/img/projets-geotribu/plugin_qtribu/qtribu_menu_plugin.png "Menu QTribu")
 
-* dans la barre d'outils sous forme d'une simple icône :
+- dans la barre d'outils :
 
 ![Toolbar QTribu](https://cdn.geotribu.fr/img/projets-geotribu/plugin_qtribu/qtribu_toolbar.png "Toolbar QTribu")

qtribu/constants.py

@@ -190,3 +190,25 @@ def local_path(self, base_path: Path = Path().home() / ".geotribu/cdn/") -> Path
         description="icône globe pointillisme",
     ),
 )
+
+# QChat
+QCHAT_NICKNAME_MINLENGTH = 3
+ADMIN_MESSAGES_NICKNAME = "admin"
+ADMIN_MESSAGES_AVATAR = "mIconWarning.svg"
+ERROR_MESSAGES_COLOR = "#ff0000"
+INTERNAL_MESSAGE_AUTHOR = "internal"
+
+# QChat cheatcodes
+CHEATCODE_DIZZY = "givemesomecheese"
+CHEATCODE_DONTCRYBABY = "dontcrybaby"
+CHEATCODE_IAMAROBOT = "iamarobot"
+CHEATCODE_10OCLOCK = "its10oclock"
+CHEATCODE_QGIS_PRO_LICENSE = "qgisprolicense"
+
+CHEATCODES = [
+    CHEATCODE_DIZZY,
+    CHEATCODE_DONTCRYBABY,
+    CHEATCODE_IAMAROBOT,
+    CHEATCODE_10OCLOCK,
+    CHEATCODE_QGIS_PRO_LICENSE,
+]