Stickerify

Etiquetar

Bot de Telegram para convertir medios en el formato requerido para usarse como stickers de Telegram

Tabla de contenido

• Cómo usar el robot
• Cómo crear una nueva pegatina
• Cómo configurar el proyecto
• Cómo ejecutar el bot localmente
• Cómo iniciar el bot usando Docker
• Cómo contribuir al proyecto
• Hacktoberfest
• Información útil
• Política de privacidad
• Licencia

Cómo usar el robot

Puede usar el bot desde aquí: inícielo y ahora podrá enviarle los medios que necesita convertir.

Según lo que envíes, Stickerify responderá lo siguiente:

• los medios convertidos, si envió un archivo compatible (se admiten imágenes, gifs, videos y pegatinas de Telegram existentes) que necesitaba conversión
• No hay archivo, si enviaste un medio que ya cumple con los requisitos de Telegram.
• un mensaje de error, si envió un archivo no compatible o dañado
• un mensaje informativo para cualquier mensaje sin archivo

 diagrama de flujo LR
    A[Usuario] -->|Mensaje| B([Adhesivo])
    B -->|La solicitud contiene un archivo| C{¿Se admite el archivo?}
    haga clic en B "https://t.me/StickerifyImageBot" _blank
    relleno de estilo B: #2889ba, trazo: #e0e0e0, color: #e0e0e0
    C -->|Sí| D{¿El archivo necesita conversión?}
    C -->|No| E(mensaje de error)
    B -->|La solicitud solo tiene texto| F{¿Es el comando de ayuda o de inicio?}
    F -->|Sí| G(Mostrar uso del bot)
    F -->|No| H (Acerca del mensaje)
    D -->|Sí| J(Convertir archivo)
    D -->|No| K(Sin conversión)

Cómo crear una nueva pegatina

1. Chatea con stickers y úsalos para crear un paquete de stickers
2. Pide a Stickers que agreguen una nueva pegatina
3. Utilice Stickerify para crear el archivo adecuado para su pegatina
4. Reenviar el mensaje de Stickerify a Stickers
5. Elige un emoji que represente tu pegatina

¡Y listo!

Cómo configurar el proyecto

1. Instale JDK 23 (o superior)
2. Clona el proyecto y muévete a su carpeta.
3. Ejecute el comando ./gradlew build -x test
4. Importe el proyecto dentro de su IDE como un proyecto Gradle
5. Asegúrese de que su IDE esté configurado correctamente para usar un JDK de Java 23 (o superior)

Cómo ejecutar el bot localmente

Después de configurar correctamente el proyecto, deberá seguir los siguientes pasos:

1. Chatea con BotFather y pídele que cree un nuevo bot.
2. Copie el token que le proporcionó y:
   • configúrelo como el valor de una nueva variable de entorno llamada STICKERIFY_TOKEN
   • Úselo como el valor pasado al constructor super(botToken) dentro de la clase Stickerify
3. Instalar FFmpeg
4. Ejecute la clase Main para iniciar el bot, ahora podrá responder mensajes en Telegram

Cómo iniciar el bot usando Docker

1. Instalar ventana acoplable

2. Prepare la imagen de Docker:

   • moviéndose a la carpeta del proyecto y construyendo la imagen con el comando:

     docker build -t rob93c/stickerify .

   • extrayendo la imagen de Docker Hub:

     docker pull rob93c/stickerify

3. Ahora solo necesitas ejecutar la imagen de Docker pasando el token ( {{TOKEN}} ) recuperado de BotFather:

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

Cómo contribuir al proyecto

Eche un vistazo a las pautas de contribución de este proyecto aquí.

¿Tiene alguna pregunta? Considere abrir una nueva discusión.

Hacktoberfest

Hacktoberfest es un evento que tiene como objetivo alentar a las personas a contribuir a proyectos de código abierto cada octubre. ¡Este proyecto se adhiere a esta iniciativa y agradece cualquier mejora relacionada con el hacktoberfest!

Si desea mejorar Stickerify como parte de este evento, primero lea las pautas de contribución y luego considere abrir una nueva edición y/o solicitud de extracción.

Si su solicitud de extracción representa una contribución válida al proyecto, se marcará como hacktoberfest-accepted y, por lo tanto, contará para el objetivo de 4 contribuciones.

Información útil

• El bot está desplegado en Railway.
• La documentación oficial de la API de Telegram Bot se puede encontrar aquí
• La biblioteca utilizada por el bot para trabajar con Telegram es Java Telegram Bot API
• La conversión de vídeo utiliza FFmpeg y JAVE2
• La conversión de imágenes utiliza Scrimage, ImageIO y TwelveMonkeys
• La validación de pegatinas animadas utiliza Gson
• El análisis de tipo MIME se realiza utilizando Apache Tika

política de privacidad

La política de privacidad se puede encontrar aquí .

Licencia

Consulte el archivo LICENCIA para conocer los derechos y limitaciones de la licencia (MIT).