From f6d2b364f31506c7321c29833fcd063a412d98b7 Mon Sep 17 00:00:00 2001
From: Tigriz <tigriz@nigge.rs>
Date: Sun, 13 Sep 2020 01:40:26 +0200
Subject: [PATCH] README and script
---
README.md | 71 +++++++++++++++++++++++++++++----------------------
matrixpack.sh | 4 +--
2 files changed, 42 insertions(+), 33 deletions(-)
diff --git a/README.md b/README.md
index c31ab3b..3e3b2ea 100644
--- a/README.md
+++ b/README.md
@@ -7,38 +7,48 @@ Repo regroupant les informations relatives aux stickers custom et différents pa
3. Créer un fichier index.json avec un contenu de cette forme :
```json
{
- "homeserver_url": "https://example.com", //vous pouvez mettre matrix.org ou matrix.iiens.net peu importe
+ "homeserver_url": "https://example.com", // Vous pouvez mettre matrix.org ou matrix.iiens.net
"packs": [
- "nom_des_packs.json", //vous pouvez donc ne pas mettre un pack qui est dans le dossier pack
+ "nom_des_packs.json", // Vous pouvez donc ne pas mettre un pack qui est dans le dossier packs
"another_telegram_imported_pack.json"
]
}
```
-4. Sur element web/bureau : /devtools (dans un tchat) → explorer les données du compte → m.widget (si pas présent, le créer) → entrer :
+4. Sur Element web/bureau `/devtools` (dans un tchat)
+5. `Explorer les données du compte`
+6. `m.widget` (si absent, le créer)
+7. Entrer
```json
{
"stickerpicker": {
"content": {
"type": "m.stickerpicker",
- "url": "https://nomdefamille.iiens.net/dossier/web/?theme=$theme",
+ "url": "https://nomdefamille.iiens.net/dossier/web/?theme=$theme", // TODO
"name": "Stickerpicker",
"data": {}
},
- "sender": "@ariseID:serveur.d'accueil",
+ "sender": "@id:homeserver", // TODO
"state_key": "stickerpicker",
"type": "m.widget",
"id": "stickerpicker"
}
}
```
-5. Relancer/Actualiser element.
+8. Actualiser Element
## Créer des packs de sticker
-Pour créer un pack de sticker, il suffit de créer un fichier .json dans le dossier pack et d'y indiquer les informations nécessaires.
+Pour créer un pack de sticker, il suffit de créer un fichier .json dans le dossier `packs` et d'y indiquer les informations nécessaires.
+
### Méthode automatique
-**Via le script matrixpack.sh**
-Le dossier courant doit être celui des stickers, le nom du pack sera celui du folder
-`./matrixpack.sh token` en récupérant le token de son compte dans Help & About -> Advanced, à la dernière ligne
+**Via le script matrixpack.sh**
+Le dossier courant doit être celui des stickers, le nom du pack sera celui du folder.
+`./matrixpack.sh token homeserver` en récupérant le **token** de son compte dans **Help & About -> Advanced**, à la dernière ligne.
+Le script donne un nouveau sous-dossier contenant :
+- le json des stickers téléversés
+- une prévisualisation des images en mosaïque avec ImageMagick
+- un README.md affichant la prévisualisation
+
+Vous pouvez donc ajoutez directement le dossier de sortie du script dans ce repo !
### Méthode manuelle
1. Téléverser une image dans un salon non-chiffré
@@ -46,39 +56,38 @@ Le dossier courant doit être celui des stickers, le nom du pack sera celui du f
2. Commencer votre fichier .json de cette façon
```json
{
- "title": "Titre du pack",
+ "title": "Titre du pack", // TODO
"id": "Ce que vous voulez",
"stickers": [
...
]
}
```
-3. Cliquer sur les ... du message -> voir source -> copier le code correspondant à celui ci-dessous et le coller entre les crochets du fichier .json
+3. Cliquer sur les ... du message, `Voir source`, copier le code correspondant à celui ci-dessous et le coller entre les crochets du fichier .json
+*Exemple*
```json
- {
- "body": "boom_ni.gif",
- "info": {
- "size": 3080290,
- "mimetype": "image/gif",
- "thumbnail_info": {
- "w": 498,
- "h": 498,
- "mimetype": "image/png",
- "size": 194660
- },
+{
+ "body": "boom_ni.gif",
+ "info": {
+ "size": 3080290,
+ "mimetype": "image/gif",
+ "thumbnail_info": {
"w": 498,
"h": 498,
- "thumbnail_url": "mxc://tedomum.net/LyJmspAoLIOBPHUzqwwEBzmH"
+ "mimetype": "image/png",
+ "size": 194660
},
- "msgtype": "m.image",
- "url": "mxc://tedomum.net/LSJhWayzyrbIkntHxnThICKQ"
- }
+ "w": 498,
+ "h": 498,
+ "thumbnail_url": "mxc://tedomum.net/LyJmspAoLIOBPHUzqwwEBzmH"
+ },
+ "msgtype": "m.image",
+ "url": "mxc://tedomum.net/LSJhWayzyrbIkntHxnThICKQ"
+}
```
**Attention ajouter :**
-`"id" : "Ce que vous voulez"`
-après le champ url. Il est important de ne pas l'oublier sinon les stickers de s'enverront pas
-
+`"id" : "Ce que vous voulez"` après le champ `url`. Il est important de ne pas l'oublier sinon les stickers de s'enverront pas.
4. Répéter jusqu'à avoir tous les stickers voulu dans le pack
-5. ajouter le .json à index.json
+5. Ajouter le .json à index.json
diff --git a/matrixpack.sh b/matrixpack.sh
index ad1ebcc..d135c0b 100755
--- a/matrixpack.sh
+++ b/matrixpack.sh
@@ -4,10 +4,10 @@
#
# pack name is the folder name
# sticker name is the file name
-# /!\ token is sensible information
+# /!\ token is sensitive information
if test $# != 2 ; then
- echo 1>&2 "$0:FATAL: $# invalid argument number (expected 1)"
+ echo 1>&2 "$0:FATAL: $# invalid argument number (expected 2)"
exit 1
fi
--
GitLab