diff --git a/README.md b/README.md index f89969bd69a86d192a20d3a405088cbdc0f3e617..8c56772a728f672a9e6aa43322c4c85b221f389c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ # Matrix Stickers -`matrix-stickers` est un dépôt créé pour regrouper les pack de stickers créés par les IIEns. +[ +](https://matrix.to/#/#stickers:baguette.party) +[](https://goyard.iiens.net/sticker-picker-display/web/) -**Un aperçu de tous les packs sur master, mis à jour automatiquement à chaque commit, est présent [ici.](https://goyard.iiens.net/sticker-picker-display/web/)** -Il propose aussi plusieurs tutoriels afin d'installer un meilleur sélecteur de stickers (*stickerpicker*) que celui fournit par défaut sur Element, d'utiliser ces packs de stickers, ainsi que de les créer soi-même. +## Table des matières -**Salon dédié : [https://matrix.to/#/##sticker:iiens.net](##sticker:iiens.net)** - -**Table des matières** - [Utiliser le stickerpicker d'un ami](#user-content-utiliser-le-stickerpicker-dun-ami) - [Installation](#user-content-installation) - [Utiliser un pack de sticker du dépôt](#user-content-utiliser-un-pack-de-sticker) @@ -102,31 +100,24 @@ Avant de commencer, deux points pour les utilisateurs Arise : Ce script suppose que vous avez déjà créé le/les dossiers regroupant les images que vous souhaitez utiliser. -1. Cloner ce dépôt -```bash -git clone https://git.iiens.net/Elliu/matrix-stickers.git -``` - -2. Ajouter `stpkg` à son `PATH` (export PATH=$PATH:~/matrix-stickers) -3. Se connecter à Element, et récupérer le jeton d'accès de son compte en allant dans `Tous les paramètres -> Aide & À propos -> Avancé -> Jeton d'accès` -4. Utiliser la commande `stpkg pack [nomdupack] folder` -Note : Pour celles et ceux qui préfèrent stocker leur jeton d'accès dans une variable d'environnement, suivez les actions suivantes: +1. Ajouter `stpkg` à son `PATH` (export PATH=$PATH:~/matrix-stickers) +2. Se connecter à Element, et récupérer le jeton d'accès de son compte en allant dans `Tous les paramètres -> Aide & À propos -> Avancé -> Jeton d'accès` +3. Utiliser la commande `stpkg pack [nomdupack] folder` ```bash # En stockant l'access token dans une variable de votre shell read ACCESS_TOKEN # coller l'acces token puis faire "entrer" stpkg pack -t $ACCESS_TOKEN [name] <directory> # si [name] n'est pas fourni, le nom du pack sera le nom du dossier par défaut -# Sans stocker l'access token dans une variable de votre shell +# Sans stocker l'access token dans une variable de votre shell (car déja fourni dans votre config) stpkg pack [name] <directory> ``` -5. Activer le pack créé avec la commande `stpkg add <nom du pack>` +4. Activer le pack créé avec la commande `stpkg add <nom du pack>` -Le script `stpkg` va créer un dossier dans le dossier `packs` du dépôt contenant trois fichiers : -- `nomdupack.json` : le `.json` des stickers téléversés, rognés, de taille 128x128, sans palette indexée (qui casse la transparence) -- `preview.png` : une prévisualisation des images en mosaïque avec **ImageMagick** -- `README.md`: affiche la prévisualisation (pour Gitlab notamment) +Le script `stpkg` va créer un sous-dossier "nomdupack" dans le dossier `packs` du dépôt contenant trois fichiers : +- `<nomdupack>.json` : le `.json` des stickers téléversés, rognés, de taille 128x128, sans palette indexée (qui casse la transparence) +- `.<nomdupack>.checksums` : permet à `stpkg` de faire la différence si on souhaite ajouter / supprimer des stickers -### Méthode intermédiaire +### Méthode intermédiaire (Dépréciée) En utilisant le [`matrixpack.sh <token> <homeserver> <directory>`](/matrixpack.sh). @@ -147,15 +138,15 @@ En utilisant le [`matrixpack.sh <token> <homeserver> <directory>`](/matrixpack.s 4. Le bloc de JSON doit ressembler à ceci, avec le `id` et le `msgtype` modifié par vos soins ```json { - "body": "boom_ni.gif", // vous pouvez changer cette valeur + "body": "image.png", // vous pouvez changer cette valeur "info": { - "mimetype": "image/gif", // dépend du type d'image envoyée + "mimetype": "image/png", // dépend du type d'image envoyée "w": 498, // vous pouvez changer cette valeur "h": 498, // vous pouvez changer cette valeur - "thumbnail_url": "mxc://tedomum.net/LyJmspAoLIOBPHUzqwwEBzmH" + "thumbnail_url": <un path mxc://> // auto-généré }, "msgtype": "m.image", // à remplacer en "m.sticker" - "url": "mxc://tedomum.net/LSJhWayzyrbIkntHxnThICKQ", + "url": <un path mxc://>, // auto-généré "id": "une valeur à définir par vous même" // à définir par vous-même } ``` @@ -174,6 +165,7 @@ Pensez à demander l'accès à un fork déjà existant, plutôt que de créer le La commande `stpkg` a besoin des executables `egrep` (ou `grep` si indisponible), `sponge` et `jq`. Il faut donc les installer ou les recompiler sur votre machine (`apt install moreutils jq grep`). ### Utilisation basique + Après avoir utilisé `stpkg -install`, vous pouvez placer le script `stpkg` dans votre path ou créer un alias pour l'exécuter facilement.