Skip to content

Commit

Permalink
- Add Get help in GUI
Browse files Browse the repository at this point in the history
- Tidying up README
- Changing appicon
- Update screenshot
  • Loading branch information
laggykiller committed Dec 16, 2022
1 parent 1ab3f7c commit a72461f
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 22 deletions.
50 changes: 28 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
# sticker-convert
A python script for creating, downloading, converting+compressing and uploading stickers from multiple instant messaging applications.

With GUI and CLI that runs on Windows, MacOS and Linux

[Pre-compiled releases available](https://github.com/laggykiller/sticker-convert/releases) for Windows and MacOS.

[Docker image is available](https://hub.docker.com/r/laggykiller/sticker-convert) for Linux version, which could be used for running CLI

You may [try this repo out in Google Colab](https://colab.research.google.com/github/laggykiller/sticker-convert/blob/master/sticker_convert_colab.ipynb) (Requires Google account), which you can run the code on cloud (without downloading) and get the result from Google Drive. However, it maybe slower than running on your computer.

Currently supports Signal, Telegram, WhatsApp (Create .wastickers), Line (Download only), Kakao (Download only)

Supports static and animated stickers, with transparency support
![sticker_convert/icon/appicon.png](sticker_convert/icon/appicon.png)
- A python script for creating, downloading, converting+compressing and uploading stickers from multiple instant messaging applications.
- With GUI and CLI that runs on Windows, MacOS and Linux
- Currently supports Signal, Telegram, WhatsApp (Create .wastickers), Line (Download only), Kakao (Download only)
- Supports static and animated stickers, with transparency support

## Downloads
- [Pre-compiled releases](https://github.com/laggykiller/sticker-convert/releases) for Windows and MacOS. (Unzip the downloaded file and run `sticker-convert`)
- [Docker image](https://hub.docker.com/r/laggykiller/sticker-convert) for Linux version, which could be used for running CLI.
- [Try in Google Colab without downloading](https://colab.research.google.com/github/laggykiller/sticker-convert/blob/master/sticker_convert_colab.ipynb) (Requires Google account), which runs the code on Google server and get the result from Google Drive. However, it maybe slower than running on your computer.

## Table of contents
- [Compatibility](#compatibility)
- [How to use (GUI)](#how-to-use-gui)
- [How to use (CLI)](#how-to-use-cli)
- [How to use (Docker)](#how-to-use-docker)
- [Running python script directly & Compiling](#running-python-script-directly--compiling)
- [FAQ](#faq)
- [Getting signal uuid and password](#getting-signal-uuid-and-password)
- [Getting telegram bot token](#getting-telegram-bot-token)
- [Importing .wastickers into WhatsApp](#importing-wastickers-into-whatsapp)
- [I want to upload stickers that are in stickers_output that have not been uploaded yet](#i-want-to-upload-stickers-that-are-in-stickers_output-that-have-not-been-uploaded-yet)
- [Credits](#credits)
- [DISCLAIMER](#disclaimer)

## Compatibility
- Signal
Expand All @@ -37,11 +48,6 @@ Supports static and animated stickers, with transparency support
- Download: Supported (e.g. https://e.kakao.com/t/xxxxx)
- Upload: Not supported. You need to manually submit sticker pack for approval before you can use in app.

## Pre-compiled releases
Pre-compiled releases available for Windows, MacOS. Unzip the downloaded file and run `sticker-convert`

If you do not trust those, you may follow 'Running python script directly' section to run the python script directly. However, you will need to install multiple dependencies.

## How to use (GUI)
![imgs/screenshot](imgs/screenshot.png)

Expand Down Expand Up @@ -162,10 +168,7 @@ Convert local files to a custom format

`sticker-convert --fps-min 3 --fps-max 30 --quality-min 30 --quality-max 90 --res-min 512 --res-max 512 --steps 10 --vid-size-max 500000 --img-size-max 500000 --vid-format .apng --img-format .png`

## Running python script directly & Compiling
See [COMPILING.md](COMPILING.md)

## Docker
## How to use (Docker)

Running
```
Expand All @@ -182,6 +185,9 @@ Building
docker build . -t sticker-convert
```

## Running python script directly & Compiling
See [COMPILING.md](COMPILING.md)

## FAQ

### Getting signal uuid and password
Expand Down
Binary file modified imgs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions sticker_convert/gui.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import shutil
import multiprocessing
from threading import Thread
import webbrowser
from utils.converter import StickerConvert
from utils.format_verify import FormatVerify
from downloaders.download_line import DownloadLine
Expand Down Expand Up @@ -250,6 +251,8 @@ def __init__(self):
self.telegram_userid_var = StringVar(self.root)
self.telegram_userid_entry = Entry(self.frame_cred, textvariable=self.telegram_userid_var, width=60)

self.cred_help = Button(self.frame_cred, text='Get help', command=self.callback_cred_help)

self.signal_uuid_lbl.grid(column=0, row=0, sticky='w')
self.signal_uuid_entry.grid(column=1, row=0, columnspan=2, sticky='w')
self.signal_password_lbl.grid(column=0, row=1, sticky='w')
Expand All @@ -258,6 +261,7 @@ def __init__(self):
self.telegram_token_entry.grid(column=1, row=2, columnspan=2, sticky='w')
self.telegram_userid_lbl.grid(column=0, row=3, sticky='w')
self.telegram_userid_entry.grid(column=1, row=3, columnspan=2, sticky='w')
self.cred_help.grid(column=0, row=4, columnspan=2, sticky='w')

# Progress frame
self.progress_box = scrolledtext.ScrolledText(self.frame_progress, width=60, height=10, wrap='word')
Expand Down Expand Up @@ -378,6 +382,9 @@ def callback_nocompress(self, *args):

def callback_update_progress_bar(self, *args):
self.progress_bar['value'] += 100 / self.items

def callback_cred_help(self, *args):
webbrowser.open('https://github.com/laggykiller/sticker-convert#faq')

def update_progress_box(self, message):
self.progress_box.config(state='normal')
Expand Down
Binary file modified sticker_convert/icon/appicon.icns
Binary file not shown.
Binary file modified sticker_convert/icon/appicon.ico
Binary file not shown.
Binary file modified sticker_convert/icon/appicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a72461f

Please sign in to comment.