Skip to content
Extraits de code Groupes Projets
Valider db691522 rédigé par salixor's avatar salixor
Parcourir les fichiers

Updates to README (badges, links, move some info to description, out of date stpkg produced files)

parent 39aea643
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
# Matrix Stickers # Matrix Stickers
`matrix-stickers` est un dépôt créé pour regrouper les pack de stickers créés par les IIEns. [![Matrix room](https://img.shields.io/badge/matrix-%23stickers%3Abaguette.party-715bc1)
](https://matrix.to/#/#stickers:baguette.party)
[![Prévisualiser tous les stickers](https://img.shields.io/badge/Pr%C3%A9visualiser%20tous%20les%20stickers-5b5a5e)](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) - [Utiliser le stickerpicker d'un ami](#user-content-utiliser-le-stickerpicker-dun-ami)
- [Installation](#user-content-installation) - [Installation](#user-content-installation)
- [Utiliser un pack de sticker du dépôt](#user-content-utiliser-un-pack-de-sticker) - [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 : ...@@ -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. 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 1. Ajouter `stpkg` à son `PATH` (export PATH=$PATH:~/matrix-stickers)
```bash 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`
git clone https://git.iiens.net/Elliu/matrix-stickers.git 3. Utiliser la commande `stpkg pack [nomdupack] folder`
```
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:
```bash ```bash
# En stockant l'access token dans une variable de votre shell # En stockant l'access token dans une variable de votre shell
read ACCESS_TOKEN # coller l'acces token puis faire "entrer" 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 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> 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 : 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>.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** - `.<nomdupack>.checksums` : permet à `stpkg` de faire la différence si on souhaite ajouter / supprimer des stickers
- `README.md`: affiche la prévisualisation (pour Gitlab notamment)
### Méthode intermédiaire ### Méthode intermédiaire (Dépréciée)
En utilisant le [`matrixpack.sh <token> <homeserver> <directory>`](/matrixpack.sh). En utilisant le [`matrixpack.sh <token> <homeserver> <directory>`](/matrixpack.sh).
...@@ -147,15 +138,15 @@ En utilisant le [`matrixpack.sh <token> <homeserver> <directory>`](/matrixpack.s ...@@ -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 4. Le bloc de JSON doit ressembler à ceci, avec le `id` et le `msgtype` modifié par vos soins
```json ```json
{ {
"body": "boom_ni.gif", // vous pouvez changer cette valeur "body": "image.png", // vous pouvez changer cette valeur
"info": { "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 "w": 498, // vous pouvez changer cette valeur
"h": 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" "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 "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 ...@@ -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`). 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 ### Utilisation basique
Après avoir utilisé `stpkg -install`, vous pouvez placer le script `stpkg` 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. dans votre path ou créer un alias pour l'exécuter facilement.
......
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter