Stickerify

Adesivo

Bot do Telegram para converter mídias no formato necessário para serem usadas como adesivos do Telegram

Índice

• Como usar o bot
• Como criar um novo adesivo
• Como configurar o projeto
• Como executar o bot localmente
• Como iniciar o bot usando Docker
• Como contribuir com o projeto
• Hacktoberfest
• Informações úteis
• Política de Privacidade
• Licença

Como usar o bot

Você pode usar o bot aqui: inicie-o e agora você pode enviar as mídias que precisa converter.

Com base no que você enviar, o Stickerify responderá o seguinte:

• a mídia convertida, se você enviou um arquivo compatível (imagens, gifs, vídeos e adesivos existentes do Telegram são suportados) que precisava de conversão
• nenhum arquivo, se você enviou uma mídia já atendendo aos requisitos do Telegram
• uma mensagem de erro, se você enviou um arquivo incompatível ou corrompido
• uma mensagem informativa para qualquer mensagem sem arquivo

 fluxograma LR
    A[Usuário] -->|Mensagem| B([Stickerificar])
    B -->|A solicitação contém um arquivo| C{O arquivo é compatível?}
    clique em B "https://t.me/StickerifyImageBot" _em branco
    preenchimento estilo B: #2889ba, traço: #e0e0e0, cor: #e0e0e0
    C -->|Sim| D{O arquivo precisa de conversão?}
    C -->|Não| E(Mensagem de erro)
    B -->|A solicitação possui apenas texto| F{É ajuda ou comando de início?}
    F -->|Sim| G(Mostrar uso do bot)
    F -->|Não| H(Sobre a mensagem)
    D -->|Sim| J(Converter arquivo)
    D -->|Não| K(Sem conversão)

Como criar um novo adesivo

1. Converse com adesivos e use-os para criar um pacote de adesivos
2. Peça aos adesivos para adicionar um novo adesivo
3. Use o Stickerify para criar o arquivo adequado para o seu adesivo
4. Encaminhar mensagem do Stickerify para Stickers
5. Escolha um emoji que represente seu adesivo

E está feito!

Como configurar o projeto

1. Instale o JDK 23 (ou superior)
2. Clone o projeto e vá para sua pasta
3. Execute o comando ./gradlew build -x test
4. Importe o projeto dentro do seu IDE como um projeto Gradle
5. Certifique-se de que seu IDE esteja configurado corretamente para usar um JDK Java 23 (ou superior)

Como executar o bot localmente

Depois de configurar o projeto com sucesso, você terá que seguir as seguintes etapas:

1. Converse com BotFather e peça para criar um novo bot
2. Copie o token fornecido e:
   • defina-o como o valor de uma nova variável de ambiente chamada STICKERIFY_TOKEN
   • use-o como o valor passado para o construtor super(botToken) dentro da classe Stickerify
3. Instale o FFmpeg
4. Execute a classe Main para iniciar o bot, agora ele poderá responder mensagens no Telegram

Como iniciar o bot usando Docker

1. Instale o Docker

2. Prepare a imagem do Docker:

   • indo para a pasta do projeto e construindo a imagem com o comando:

     docker build -t rob93c/stickerify .

   • puxando a imagem do Docker Hub:

     docker pull rob93c/stickerify

3. Agora você só precisa executar a imagem Docker passando o token ( {{TOKEN}} ) recuperado do BotFather:

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

Como contribuir com o projeto

Dê uma olhada nas diretrizes de contribuição deste projeto aqui.

Tem alguma dúvida? Considere abrir uma nova discussão.

Hacktoberfest

Hacktoberfest é um evento que visa incentivar as pessoas a contribuir para projetos de código aberto todo mês de outubro. Este projeto adere a esta iniciativa e acolhe qualquer melhoria relacionada ao hacktoberfest!

Se você gostaria de melhorar o Stickerify como parte deste evento, primeiro leia as diretrizes de contribuição e depois considere abrir um novo problema e/ou pull request.

Se o seu pull request representar uma contribuição válida para o projeto, ele será marcado como hacktoberfest-accepted , contando portanto para a meta de 4 contribuições.

Informações úteis

• O bot está implantado na Railway
• A documentação oficial da API Telegram Bot pode ser encontrada aqui
• A biblioteca usada pelo bot para trabalhar com o Telegram é Java Telegram Bot API
• A conversão de vídeo usa FFmpeg e JAVE2
• A conversão de imagem usa Scriimage, ImageIO e TwelveMonkeys
• Validação de adesivos animados usa Gson
• A análise do tipo MIME é realizada usando Apache Tika

política de Privacidade

A política de privacidade pode ser encontrada aqui .

Licença

Consulte o arquivo LICENSE para direitos e limitações de licença (MIT).