diff --git a/README.md b/README.md index e7221afbc3b529f4c43f764fb6a0b7c42017f227..3c5ada540fd90bff57484d7c86ba8807adac6573 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # Matrix Stickers -Dépôt regroupant les différents pack de stickers créés par les IIEns et les informations relatives aux stickers custom. +Matrix-stickers est un dépôt créé pour regrouper les pack de stickers créés par les IIEns. +Il propose aussi plusieurs tutoriels afin d'installer un meilleur "stickerpicker", d'ajouter des packs de sticker +ainsi que de les créer soi-même. **Table des matières** -- [Utiliser les stickers d'un ami](#user-content-utiliser-les-stickers-dun-ami) -- [Avoir un meilleur sticker picker](#user-content-avoir-un-meilleur-sticker-picker) -- [Créer des packs de sticker](#user-content-creer-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. +- [Utiliser le stickerpicker d'un ami](#user-content-utiliser-le-stickerpicker-dun-ami) +- [Avoir un meilleur stickerpicker](#user-content-avoir-un-meilleur-stickerpicker) +- [Ajouter un pack de sticker du dépôt](#user-content-ajouter-un-pack-de-sticker) +- [Créer des packs de sticker](#user-content-créer-des-packs-de-sticker) + +## Utiliser le stickerpicker d'un ami +Si vous avez des amis ayant déjà leur propre stickerpicker, 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 : @@ -22,8 +26,7 @@ Pour cela : "stickerpicker": { "content": { "type": "m.stickerpicker", - "url": "https://example.com/stickerpicker/web/?theme=$theme", // TODO à remplacer par l'adresse - // nom.iiens.net sur Arise + "url": "https://example.com/stickerpicker/web/?theme=$theme", // TODO à remplacer par l'adresse du pote "name": "Stickerpicker", "data": {} }, @@ -38,7 +41,10 @@ Pour cela : Supprimer ensuite les commentaires 6. Actualiser -## Avoir un meilleur sticker picker +## Avoir un meilleur stickerpicker +Le stickerpicker de base ne permet pas d'utiliser des stickers personnalisés. +Il faut donc installer notre propre stickerpicker qui pourra les utiliser. +Pour cela: 1. Se connecter à son perso ou son site web ```bash ssh nomArise@perso.iiens.net @@ -81,29 +87,50 @@ Pour cela : 7. Actualiser Element Vous avez maintenant un stickerpicker pouvant envoyer des stickers privacy\_pam. +## Ajouter un pack de sticker +Dans le dossier `pack` de ce dépôt sont regroupés tout les packs de sticker créé par des IIens. +[!Tutoriel](https://git.iiens.net/Tigriz/matrix-stickers/-/tree/master/packs) + ## 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 : +Un pack de stickers se résume à un fichier json 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`). +Ce script suppose que vous avez déjà créer un ou plusieurs dossiers regroupant les images que vous souhaitez utiliser en sticker. +Le nom du dossier définira le nom du pack, et les images s'y trouvant deviendront les stickers du pack. 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. + ```bash + git clone https://git.iiens.net/Tigriz/matrix-stickers.git + ``` +2. Se connecter à Element et 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 le script matrixpack.sh + ```bash + cd matrix-stickers + ./matrixpack.sh token homeserver directory1 directory2... + ``` +- 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 + - README.md: Permet d'afficher les stickers du pack dans git 4. Ajouter le json des stickers téléversés (nomdupack.json) dans le dossier `packs`. + ```bash + cp nomdupack.json ~/html/stickerpicker/web/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/`. + ```bash + scp nomdupack.json nomArise@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). +5. Mettre à jour le fichier `index.json` se trouvant dans `~/html/stickerpicker/web/packs`. **Facultatif :** -Vous pouvez ajouter directement le nouveau sous-dossier créé par le script dans ce dépôt et ainsi contribuer! +Vous pouvez aussi ajouter directement le nouveau sous-dossier créé par le script dans ce dépôt et ainsi contribuer! + **Tips** ```bash