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文件。