Skip to content

Commit

Permalink
更新README
Browse files Browse the repository at this point in the history
  • Loading branch information
rroy233 committed Oct 22, 2023
1 parent 2f4d938 commit 3f2a78a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,19 @@

### 功能

* 发送表情、表情链接给bot,bot为您转换为便于保存的gif文件
* 转发gif图给bot,bot会以文件形式发送回给你以便保存。
* 下载单个表情
* 下载整个表情包
* 发送表情、表情链接给bot,bot为您转换为便于保存的gif文件.
* 支持将Telegram官方出品的表情(tgs)格式转换为gif.
* 转发gif图给bot,bot会以文件形式发送回给你以便保存.
* 下载单个表情.
* 下载整个表情包.

![cover](docs/demo.gif)

### 运行要求

- Redis
- ffmpeg
- [lottie2gif](https://github.com/rroy233/lottie2gif) (可选)

### 使用方法

Expand Down Expand Up @@ -113,7 +115,16 @@ redis:

下载对应平台的[ffmpeg](https://ffmpeg.org/)的可执行文件,命名格式为`ffmpeg-{GOOS}-{GOARCH}`,复制到`./ffmpeg`文件夹。

#### 运行程序
#### lottie2gif集成

若需要支持tgs格式表情转换,需要为StickerDownloader集成[lottie2gif](https://github.com/rroy233/lottie2gif).

并更改配置文件:

```yaml
support_tgs_file: true
```
#### 后台运行脚本
```shell
Expand Down
10 changes: 10 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
### Feature

* Send stickers or sticker links to the bot, and it will convert them into easily savable GIF files for you.
* Supports the conversion of Telegram's official stickers (tgs) to GIFs.
* Forward GIFs to the bot, and it will send them back to you in file form for easy saving.
* Download single sticker.
* Download whole sticker set.
Expand All @@ -34,6 +35,7 @@

- Redis
- ffmpeg
- [lottie2gif](https://github.com/rroy233/lottie2gif) (Optional)

### Usage

Expand Down Expand Up @@ -112,6 +114,14 @@ If ffmpeg is already installed, you can skip this step.

Download ffmpeg from [official website](https://ffmpeg.org/), rename it to `ffmpeg-{GOOS}-{GOARCH}`, and put it into `./ffmpeg` folder.

#### Integrate lottie2gif

If you wish to enable the conversion of TGS format stickers, you will need to integrate [lottie2gif](https://github.com/rroy233/lottie2gif) into the StickerDownloader and make the following changes to the configuration file:

```yaml
support_tgs_file: true
```
#### Launch Script
```shell
Expand Down

0 comments on commit 3f2a78a

Please sign in to comment.