From a1f5deaa1cc5553c6973fcba87fe6599bd3fdba8 Mon Sep 17 00:00:00 2001
From: Eric COLONIA-TARAZONA <colonia2017@tom.iiens.net>
Date: Sun, 22 May 2022 23:11:34 +0200
Subject: [PATCH] Fix stpkg, update EREADME and packs/README
---
README.md | 27 ++++++++++++++++++---------
packs/README.md | 10 ++++++----
stpkg | 22 +++++++++++-----------
3 files changed, 35 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
index b4b6944..4e8f436 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ Il propose aussi plusieurs tutoriels afin d'installer un meilleur sélecteur de
**Table des matières**
- [Utiliser le stickerpicker d'un ami](#user-content-utiliser-le-stickerpicker-dun-ami)
-- [Avoir un meilleur stickerpicker](#user-content-avoir-un-meilleur-stickerpicker)
+- [Installation](#user-content-installation)
- [Utiliser un pack de sticker du dépôt](#user-content-utiliser-un-pack-de-sticker)
- [Créer des packs de stickers](#user-content-créer-des-packs-de-stickers)
- [Utilisation de stpkg](#utilisation-de-stpkg)
@@ -49,13 +49,15 @@ Si vous avez des amis ayant déjà leur propre stickerpicker, il est possible de
}
```
-## Avoir un meilleur stickerpicker
+## Installation
Le stickerpicker de base fournit par Element ne permet pas d'utiliser des stickers personnalisés. Il faut donc installer notre propre stickerpicker qui pourra les utiliser. On l'hébergera ici sur votre perso Arise, mais il est bien évidemment possible de l'héberger ailleurs.
+Note : Dans le tutoriel, le stickerpicker est nommé 'stickerpicker'
+
1. Se connecter à son perso (ou son site web)
```bash
-ssh identifiantArise@perso.iiens.net
+ssh identifiantArise@perso3.iiens.net
```
2. Cloner le dépôt
```bash
@@ -64,18 +66,23 @@ git clone https://git.iiens.net/Tigriz/matrix-stickers.git
3. Se déplacer dans le dossier du dépôt et exécuter le script `stpkg`
```bash
cd matrix-stickers
-./stpkg -install
+./stpkg -install ~/html/stickerpicker
+
# ou pour une installation avec sshfs (cf "Utilisation de stpkg")
./stpkg -install -sshfs nomAAAA@perso.iiens.net -local ~/mnt/perso
```
+4. Configurer le fichier `~/.config/stpkg.sh` en renseignant son serveur d'accueil et le jeton d'accès Matrix.
+Le jeton d'accès de son compte est récupérable en allant dans `Tous les paramètres -> Aide & À propos -> Avancé -> Jeton d'accès`
+
+Vous avez maintenant hébergé votre propre stickerpicker. Pour créer un pack de stickers avec stpkg, se référer au paragraphe [méthode automatique]() !
+Pour utiliser un pack de sticker déjà créer, se réferer au paragraphe [Utiliser un pack de sticker](#Utiliser-un-pack-de-sticker).
-Vous avez maintenant hébergé votre propre stickerpicker. Pour l'utiliser, se référer au [paragraphe précédent](#user-content-utiliser-le-stickerpicker-dun-ami) !
## Utiliser un pack de sticker
Dans le dossier `packs` de ce dépôt sont regroupés tous les packs de stickers créés ou compilés par des IIEns.
-La sélection des packs que vous voulez utiliser nécessite d'[héberger soi-même]((#user-content-avoir-un-meilleur-stickerpicker)) son propre stickerpicker (sinon, vous êtes limités aux choix de la personne qui l'héberge).
+La sélection des packs que vous voulez utiliser nécessite d'[héberger soi-même]((#user-content-installation)) son propre stickerpicker (sinon, vous êtes limités aux choix de la personne qui l'héberge).
Plus d'informations dans le [dossier en question](/packs).
@@ -96,10 +103,12 @@ Ce script suppose que vous avez déjà créé le/les dossiers regroupant les ima
1. Cloner ce dépôt
```bash
git clone https://git.iiens.net/Tigriz/matrix-stickers.git
-```
-2. Ajouter `stpkg` Ã son `PATH` (Optionnel)
+```
+
+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`
+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
# En stockant l'access token dans une variable de votre shell
read ACCESS_TOKEN # coller l'acces token puis faire "entrer"
diff --git a/packs/README.md b/packs/README.md
index e5bc10f..3ec29a8 100644
--- a/packs/README.md
+++ b/packs/README.md
@@ -4,16 +4,18 @@ Il est possible de visualiser les stickers en allant dans le dossier d'un des pa
# Utiliser un pack de sticker
Vous pouvez utiliser n'importe quel pack disponible ici.
Pour cela:
-1. Télecharger le fichier nomdupack.json du pack de sticker.
-2. Ajouter-le au dossier pack de votre stickerpicker
+1. Ajouter le pack au dossier `/web/packs` de votre stickerpicker
```bash
cp nomdupack.json ~/html/stickerpicker/web/packs
```
-3. Mettre à jour le fichier index.json se trouvant dans le dossier packs de votre stickerpicker.
+3. Executer la commande
+ ```bash
+ stpkg add nomdupack
+ ```
# Déposer un pack de sticker
Déposez vos packs ici, vous pouvez faire une pull request.
-Il est conseillé de mettre un README avec un aperçu tel que produit par le script `matrixpack.sh`.
+Il est conseillé de mettre un README avec un aperçu tel que produit par le script `matrixpack.sh`. (OLD)
# Bonus : Générer une prévisualisation des packs
Pour obtenir une prévisualisation de l'ensemble des packs :
diff --git a/stpkg b/stpkg
index bdbf62e..5e3170e 100755
--- a/stpkg
+++ b/stpkg
@@ -47,18 +47,18 @@ die() {
REQUIREMENTS=""
require() {
for CMD in $*; do
- local __cmd=`which $1`
- [ $? -ne 0 ] && die "Failed to find the '$1' command"
+ local __cmd=`which $CMD`
+ [ -z $__cmd ] && die "Failed to find the '$CMD' command"
REQUIREMENTS="$CMD $REQUIREMENTS"
done
}
require \
- md5sum mktemp column uuidgen convert montage identify python curl \
+ md5sum mktemp column uuidgen convert montage identify python3 curl \
sed tr git sponge ls find jq chmod cat expr iconv
__grep=`which egrep`
-if [ $? -ne 0 ]; then
+if [ -z $__grep ]; then
__grep=`which grep`
- [ $? -ne 0 ] && die "Failed to find 'grep' or 'egrep'"
+ [ -z $__grep ] && die "Failed to find 'grep' or 'egrep'"
warn "Cound not find 'egrep', will use 'grep' instead." \
"Please, note that some functionalities may not work with regular expressions."
fi
@@ -150,13 +150,13 @@ validate_token_internal() {
validate_token() {
local RES=`validate_token_internal`
[ "x$RES" = "xM_UNKNOWN_TOKEN" ] && die "The token is incorrect or doesn't exist on '$STPKG_HOMESERV'"
- [ ! "x$RES" = "xM_UNKNOWN" ] && die "Got an 'yet implemented' error"
- info "Token is valid on homeserv '$STPKG_HOMESERV'"
+ [ ! "x$RES" = "xM_UNKNOWN" ] && die "Got an 'yet implemented' error in Token Validation"
+ info "Token is valid on homeserver '$STPKG_HOMESERV'"
}
validate_homeserv() {
curl "https://$STPKG_HOMESERV" >/dev/null 2>&1
- [ $? -ne 0 ] && die "Homeserv '$STPKG_HOMESERV' doesn't exist or is inaxessible"
+ [ $? -ne 0 ] && die "Homeserver '$STPKG_HOMESERV' doesn't exist or is inacessible"
}
file_get_width() {
@@ -260,8 +260,8 @@ __install() {
esac
done
- # Create the ~/config/stpkg.sh
- [ ! -d ~/config ] && mkdir ~/config
+ # Create the ~/.config/stpkg.sh
+ [ ! -d ~/.config ] && mkdir ~/.config
cat > $STPKG_CONF_FILE << EOF
# Please, only modify the 'STPKG_TOKEN'
if [ ! "x\$INSTALL" = "xyes" ]; then
@@ -349,7 +349,7 @@ if [ ! -d "$STPKG_INSTALL" ]; then
error "STPKG_INSTALL folder ($STPKG_INSTALL) doesn't exist. Did you use the install script?"
usage
fi
-info "Use STPKG_INSTALL: $STPKG_INSTALL`[ "x$STPKG_SSHFS" = "xyes" ] && echo ' (this is an sshfs install)'`"
+info "Using STPKG_INSTALL: $STPKG_INSTALL`[ "x$STPKG_SSHFS" = "xyes" ] && echo ' (this is an sshfs install)'`"
[ "x$STPKG_BASE" = "x" ] && die \
"The STPKG_BASE env var is mendatory, it must point to the sticker repo. It should have been given by the install script"
--
GitLab