Matrix Stickers

Dépôt regroupant les différents pack de stickers créés par les IIEns et les informations relatives aux stickers custom.

Table des matières -Utiliser les stickers d'un ami -[Avoir un meilleur sticker picker] -[Créer des packs de sticker]

Utiliser les stickers d'un ami

Si vous avez des amis ayant déjà leur propre sticker picker, il est possible de le réutiliser. Pour cela :

1. Demandez lui l'autorisation (ou non)
2. Récupérez l'adresse sur laquelle il héberge ses stickers. Cette adresse est de la forme :

https://nom.iiens.net/stickerpicker/web/?theme=$theme

3. Connectez vous à Element. Utilisez la commande /devtools
4. Cliquer sur Explorer les données du compte puis sur m.widgets (si absent, le créer)
5. Cliquer sur Modifier et remplacer tout par le code suivant en n'oubliant pas de modifier les champs "url" et "sender":

{
    "stickerpicker": {
        "content": {
            "type": "m.stickerpicker",
            "url": "https://example.com/stickerpicker/web/?theme=$theme", // TODO à remplacer par l'adresse
            // nom.iiens.net sur Arise
            "name": "Stickerpicker",
            "data": {}
        },
        "sender": "@id:homeserver", // TODO votre compte
        // nom0000:iiens.net sur Arise
        "state_key": "stickerpicker",
        "type": "m.widget",
        "id": "stickerpicker"
    }
}

Supprimer ensuite les commentaires
6. Actualiser

Avoir un meilleur sticker picker

1. Se connecter à son perso ou son site web

ssh nomArise@perso.iiens.net

2. Cloner ce dépôt.

git clone https://git.iiens.net/Tigriz/matrix-stickers.git

3. Se déplacer dans le dépôt et exécuter le script install.sh

cd matrix-stickers
./install.sh

4. Se connecter à Element. Utiliser la commande /devtools dans n'importe quel tchat.
   
5. Cliquer sur Explorer les données du compte puis sur m.widgets (si absent, le créer)
   
6. Cliquer sur Modifier et remplacer tout par le code suivant en n'oubliant pas de modifier les champs "url" et "sender" avec les infos correspondantes :

{
    "stickerpicker": {
        "content": {
            "type": "m.stickerpicker",
            "url": "https://example.com/stickerpicker/web/?theme=$theme", // TODO
            // nom.iiens.net sur Arise
            "name": "Stickerpicker",
            "data": {}
        },
        "sender": "@id:homeserver", // TODO
        // nom0000:iiens.net sur Arise
        "state_key": "stickerpicker",
        "type": "m.widget",
        "id": "stickerpicker"
    }
}

Supprimer les commentaires ensuite. (Json ne supporte pas les comments :( )

7. Actualiser Element
   Vous avez maintenant un stickerpicker pouvant envoyer des stickers privacy_pam.

Créer des packs de stickers

Un pack de stickers se résume à un fichier json dans le dossier packs possédant des informations précises sur les images téléversées. Pour créer ce ficher json et téléverser ses images, il existe deux méthodes :

Méthode automatique

Via le script matrixpack.sh
Requis : ImageMagick (sudo apt-get install imagemagick/pacman -S imagemagick).

1. Cloner ce dépôt
2. Récupérer le token de son compte en allant dans Tout les paramètres -> Aide & À propos -> Avancé. Dans la dernière ligne Jeton d'accès cliquer pour l'afficher.
3. Exécuter ./matrixpack.sh token homeserver directory...
   Note : Le (ou les) dossier cible directory correpond au dossier contenant vos images à téléverser.
   Ne le faites pas avec votre compte arise, les images pourront être supprimées aléatoirement, faites-vous un compte sur matrix.org.
   Le script crée un nouveau sous-dossier dans directory 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: affichant la prévisualisation
4. Ajouter le json des stickers téléversés (nomdupack.json) dans le dossier packs.
   Précision : si vous avez exécuté le script hors de votre perso, vous devez envoyer le ficher json par ssh.
   Pour cela faites scp nomdupack.json nom0000@perso.iiens.net:html/stickerpicker/web/packs/.
   Cela va copier le fichier nomdupack.json dans le dossier packs se trouvant dans votre perso.
5. Mettre à jour le fichier index.json en suivant le modèle de l'étape 3 (Avoir un meilleur sticker picker).

Facultatif : Vous pouvez ajouter directement le nouveau sous-dossier créé par le script dans ce dépôt et ainsi contribuer!

Tips

git clone https://git.iiens.net/Tigriz/matrix-stickers
scp matrix-stickers/packs/*/*.json nom0000@perso.iiens.net:html/stickerpicker/web/packs

Méthode manuelle

1. Téléverser une image dans un salon non-chiffré
   Ne le faites pas sur le serveur Matrix d'Arise, les admins suppriment les images pour libérer de la place (source : Nitorac)
2. Commencer votre fichier json de cette façon

{
  "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
   Exemple

   {
     "body": "boom_ni.gif",
     "info": {
       "size": 3080290,
       "mimetype": "image/gif",
       "thumbnail_info": {
         "w": 498,
         "h": 498,
         "mimetype": "image/png",
         "size": 194660
       },
       "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.
4. Répéter jusqu'à avoir tous les stickers voulu dans le pack
5. Ajouter le json à index.json