Stickerify

Наклейка

Бот Telegram для конвертации медиафайлов в формат, необходимый для использования в качестве стикеров Telegram.

Оглавление

• Как использовать бота
• Как создать новую наклейку
• Как настроить проект
• Как запустить бота локально
• Как запустить бота с помощью Docker
• Как внести свой вклад в проект
• Хактоберфест
• Полезная информация
• Политика конфиденциальности
• Лицензия

Как использовать бота

Вы можете использовать бота здесь: запустите его, и теперь вы можете отправлять ему медиафайлы, которые необходимо преобразовать.

В зависимости от того, что вы отправляете, Stickify ответит на следующее:

• конвертированные медиафайлы, если вы отправили поддерживаемый файл (поддерживаются изображения, GIF-файлы, видео и существующие стикеры Telegram), требующий конвертации.
• нет файла, если вы отправили носитель, уже соответствующий требованиям Telegram
• сообщение об ошибке, если вы отправили неподдерживаемый или поврежденный файл
• информативное сообщение для любого сообщения без файла

 блок-схема LR
    A[Пользователь] -->|Сообщение| B([Наклейка])
    B -->|Запрос содержит файл| C{Поддерживается ли файл?}
    нажмите B «https://t.me/StickerifyImageBot» _blank
    заливка стиля B: #2889ba, обводка: #e0e0e0, цвет: #e0e0e0
    C -->|Да| D{Нужно ли конвертировать файл?}
    С -->|Нет| E (сообщение об ошибке)
    B -->|Запрос содержит только текст| F{Это помощь или команда запуска?}
    Ф -->|Да| G (Показать использование бота)
    Ф -->|Нет| H(О сообщении)
    D -->|Да| J (конвертировать файл)
    Д -->|Нет| К (без преобразования)

Как создать новую наклейку

1. Общайтесь со стикерами и используйте его для создания набора стикеров.
2. Попросите стикеров добавить новую наклейку
3. Используйте Stickerify, чтобы создать подходящий файл для вашей наклейки.
4. Переслать сообщение от Stickerify в стикеры
5. Выберите смайлик, представляющий вашу наклейку.

И дело сделано!

Как настроить проект

1. Установите JDK 23 (или выше)
2. Клонируйте проект и переместите в его папку.
3. Запустите команду ./gradlew build -x test
4. Импортируйте проект в свою IDE как проект Gradle.
5. Убедитесь, что ваша IDE правильно настроена для использования JDK Java 23 (или более поздней версии).

Как запустить бота локально

После успешной настройки проекта вам придется пройти следующие шаги:

1. Пообщайтесь с BotFather и попросите его создать нового бота.
2. Скопируйте предоставленный вам токен и либо:
   • установите его как значение новой переменной среды с именем STICKERIFY_TOKEN
   • используйте его как значение, передаваемое конструктору super(botToken) внутри класса Stickerify
3. Установить FFmpeg
4. Запустите класс Main , чтобы запустить бота, теперь он сможет отвечать на сообщения в Telegram.

Как запустить бота с помощью Docker

1. Установить Докер

2. Подготовьте образ Docker:

   • переходим в папку проекта и собираем образ командой:

     docker build -t rob93c/stickerify .

   • извлекаем образ из Docker Hub:

     docker pull rob93c/stickerify

3. Теперь вам просто нужно запустить образ Docker, передав токен ( {{TOKEN}} ), полученный от BotFather:

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

Как внести свой вклад в проект

Ознакомьтесь с рекомендациями по участию в этом проекте здесь.

Есть вопросы? Рассмотрите возможность открытия нового обсуждения.

Хактоберфест

Hacktoberfest — это мероприятие, целью которого является поощрение людей к участию в проектах с открытым исходным кодом каждый октябрь. Этот проект придерживается этой инициативы и приветствует любые улучшения, связанные с хактоберфестом!

Если вы хотите улучшить Stickicify в рамках этого мероприятия, сначала прочтите рекомендации по участию, а затем рассмотрите возможность создания новой задачи и/или запроса на включение.

Если ваш запрос на включение представляет собой действительный вклад в проект, он будет помечен как hacktoberfest-accepted , что будет учитываться при достижении цели в 4 вклада.

Полезная информация

• Бот развернут на железной дороге
• Официальную документацию Telegram Bot API можно найти здесь.
• Библиотека, используемая ботом для работы с Telegram, — Java Telegram Bot API.
• Конвертация видео использует FFmpeg и JAVE2.
• Преобразование изображений использует Scrimage, ImageIO и TwelveMonkeys.
• Проверка анимированных стикеров использует Gson
• Анализ типов MIME выполняется с помощью Apache Tika.

политика конфиденциальности

Политику конфиденциальности можно найти здесь .

Лицензия

Лицензионные права и ограничения см. в файле LICENSE (MIT).