Stickerify

Autocollantifier

Bot Telegram pour convertir les médias dans le format requis pour être utilisé comme autocollants Telegram

Table des matières

• Comment utiliser le bot
• Comment créer un nouvel autocollant
• Comment monter le projet
• Comment exécuter le bot localement
• Comment lancer le bot à l'aide de Docker
• Comment contribuer au projet
• Fête de la bière
• Informations utiles
• Politique de confidentialité
• Licence

Comment utiliser le bot

Vous pouvez utiliser le bot ici : démarrez-le, et vous pourrez maintenant lui envoyer les médias que vous devez convertir.

En fonction de ce que vous envoyez, Stickerify répondra aux questions suivantes :

• le média converti, si vous avez envoyé un fichier pris en charge (les images, les gifs, les vidéos et les autocollants Telegram existants sont pris en charge) qui nécessitait une conversion
• pas de fichier, si vous avez envoyé un média répondant déjà aux exigences de Telegram
• un message d'erreur, si vous avez envoyé un fichier non pris en charge ou corrompu
• un message informatif pour tout message sans fichier

 organigramme LR
    Un[Utilisateur] -->|Message| B([Stickerifier])
    B -->|La requête contient un fichier| C{Le fichier est-il pris en charge ?}
    cliquez sur B "https://t.me/StickerifyImageBot" _blank
    Remplissage style B : #2889ba, trait : #e0e0e0, couleur : #e0e0e0
    C -->|Oui| D{Le fichier doit-il être converti ?}
    C -->|Non| E(Message d'erreur)
    B -->|La requête ne contient que du texte| F{Est-ce que l'aide ou la commande de démarrage ?}
    F -->|Oui| G (Afficher l'utilisation du bot)
    F -->|Non| H (à propos du message)
    D -->|Oui| J (Convertir le fichier)
    D -->|Non| K(Aucune conversion)

Comment créer un nouvel autocollant

1. Discutez avec des autocollants et utilisez-le pour créer un pack d'autocollants
2. Demandez à Stickers d’ajouter un nouvel autocollant
3. Utilisez Stickerify pour créer le fichier approprié pour votre autocollant
4. Transférer le message de Stickerify à Stickers
5. Choisissez un emoji représentant votre sticker

Et c'est fait !

Comment monter le projet

1. Installez JDK 23 (ou supérieur)
2. Clonez le projet et déplacez-le dans son dossier
3. Exécutez la commande ./gradlew build -x test
4. Importez le projet dans votre IDE en tant que projet Gradle
5. Assurez-vous que votre IDE est correctement configuré pour utiliser un JDK Java 23 (ou supérieur)

Comment exécuter le bot localement

Après avoir mis en place avec succès le projet, vous devrez suivre les étapes suivantes :

1. Discutez avec BotFather et demandez-lui de créer un nouveau bot
2. Copiez le jeton qu'il vous a fourni et soit :
   • définissez-le comme valeur d'une nouvelle variable d'environnement nommée STICKERIFY_TOKEN
   • utilisez-le comme valeur transmise au constructeur super(botToken) à l'intérieur de la classe Stickerify
3. Installer FFmpeg
4. Exécutez la classe Main pour démarrer le bot, il pourra désormais répondre aux messages dans Telegram

Comment lancer le bot à l'aide de Docker

1. Installer Docker

2. Préparez l'image Docker soit :

   • en vous déplaçant dans le dossier du projet et en construisant l'image avec la commande :

     docker build -t rob93c/stickerify .

   • extraire l'image de Docker Hub :

     docker pull rob93c/stickerify

3. Il ne vous reste plus qu'à exécuter l'image Docker en passant le jeton ( {{TOKEN}} ) récupéré de BotFather :

   docker run -e " STICKERIFY_TOKEN={{TOKEN}} " rob93c/stickerify

Comment contribuer au projet

Jetez un œil aux lignes directrices de contribution de ce projet ici.

Vous avez des questions ? Pensez à ouvrir une nouvelle discussion.

Fête de la bière

Le Hacktoberfest est un événement visant à encourager les gens à contribuer à des projets open source chaque mois d'octobre. Ce projet adhère à cette initiative et accueille toute amélioration liée au hacktoberfest !

Si vous souhaitez améliorer Stickerify dans le cadre de cet événement, lisez d'abord les directives de contribution, puis envisagez d'ouvrir un nouveau numéro et/ou une pull request.

Si votre pull request représente une contribution valide au projet, elle sera marquée comme hacktoberfest-accepted , comptant donc pour l'objectif de 4 contributions.

Informations utiles

• Le bot est déployé sur Railway
• La documentation officielle de l'API Telegram Bot peut être trouvée ici
• La bibliothèque utilisée par le bot pour travailler avec Telegram est l'API Java Telegram Bot.
• La conversion vidéo utilise FFmpeg et JAVE2
• La conversion d'image utilise Scrimage, ImageIO et TwelveMonkeys
• La validation des autocollants animés utilise Gson
• L'analyse de type MIME est effectuée à l'aide d'Apache Tika

politique de confidentialité

La politique de confidentialité peut être trouvée ici .

Licence

Consultez le fichier LICENSE pour connaître les droits et limitations de licence (MIT).