Stickerify

貼紙化

Telegram 機器人可將媒體轉換為 Telegram 貼紙所需的格式

目錄

• 如何使用機器人
• 如何建立新貼紙
• 如何設定項目
• 如何在本地運行機器人
• 如何使用 Docker 啟動機器人
• 如何為該專案做出貢獻
• 黑客啤酒節
• 有用的信息
• 隱私權政策
• 執照

如何使用機器人

您可以在此處使用機器人：啟動它，現在您可以向它發送您需要轉換的媒體。

根據您發送的內容，Stickerify 將回答以下問題：

• 轉換後的媒體，如果您發送了需要轉換的支援文件（支援圖像、GIF、影片和現有 Telegram 貼紙）
• 沒有文件，如果您發送的媒體已經符合 Telegram 的要求
• 如果您發送了不支援或損壞的文件，則會出現錯誤訊息
• 任何沒有文件的訊息的資訊性訊息

 流程圖LR
    A[用戶] -->|留言| B([貼紙])
    B -->|請求包含一個檔案| C{是否支援文件？
    點選 B“https://t.me/StickerifyImageBot”_blank
    樣式 B 填滿：#2889ba，描邊：#e0e0e0，顏色：#e0e0e0
    C -->|是| D{文件需要轉換嗎？
    C -->|否| E(錯誤訊息)
    B -->|請求只有文字| F{是幫助還是啟動指令？
    F -->|是| G（顯示機器人使用情況）
    F -->|否| H(關於留言)
    D -->|是| J(轉換檔)
    D -->|否| K(無換算)

如何建立新貼紙

1. 與貼紙聊天，並用它來創建貼紙包
2. 請貼紙添加新貼紙
3. 使用 Stickerify 為您的貼圖建立正確的文件
4. 將 Stickerify 的訊息轉發到 Stickers
5. 選擇代表您的貼紙的表情符號

完成了！

如何設定項目

1. 安裝 JDK 23（或更高版本）
2. 克隆項目並移至其資料夾中
3. 運行命令./gradlew build -x test
4. 將專案以 Gradle 專案導入 IDE 中
5. 確保您的 IDE 已正確配置為使用 Java 23（或更高版本）JDK

如何在本地運行機器人

成功設定專案後，您必須執行以下步驟：

1. 與 BotFather 聊天並要求其創建一個新機器人
2. 複製它為您提供的令牌，然後：
   • 將其設定為名為STICKERIFY_TOKEN的新環境變數的值
   • 使用它作為傳遞給類別Stickerify內的super(botToken)建構函數的值
3. 安裝 FFmpeg
4. 運行Main類來啟動機器人，它現在可以在 Telegram 中回覆訊息

如何使用 Docker 啟動機器人

1. 安裝 Docker

2. 準備 Docker 映像：

   • 進入專案資料夾並使用以下命令建立映像：

     docker build -t rob93c/stickerify .

   • 從 Docker Hub 拉取鏡像：

     docker pull rob93c/stickerify

3. 現在您只需執行 Docker 映像並傳遞從 BotFather 擷取到的令牌 ( {{TOKEN}} )：

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

如何為該專案做出貢獻

在這裡查看該專案的貢獻指南。

有什麼問題嗎？考慮開啟新的討論。

黑客啤酒節

Hacktoberfest 是一項旨在鼓勵人們每年十月為開源專案做出貢獻的活動。該項目堅持這一舉措，並歡迎任何與 hacktoberfest 相關的改進！

如果您想在本次活動中改進 Stickerify，請先閱讀貢獻指南，然後考慮提出新問題和/或拉取請求。

如果您的拉取請求代表對專案的有效貢獻，它將被標記為hacktoberfest-accepted ，因此計入 4 個貢獻目標。

有用的信息

• 該機器人部署在鐵路上
• Telegram Bot API 的官方文件可以在這裡找到
• 機器人與 Telegram 配合使用的函式庫是 Java Telegram Bot API
• 影片轉換使用FFmpeg和JAVE2
• 影像轉換使用 Scrimage、ImageIO 和 TwelveMonkeys
• 動畫貼圖驗證使用 Gson
• 使用 Apache Tika 執行 MIME 類型分析

隱私權政策

隱私權政策可在此處找到。

執照

有關許可權利和限制 (MIT)，請參閱LICENSE文件。