aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1d5453a9192bb12863b0c6186b47658f8cb1f672 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
![stikman](stikman.png)

stikman brings platform independent stickers for the desktop


## Showcase (using telegram and element/matrix)
![stikman.gif](stikman.gif)

## Why
Generally you can only use a given set of stickers within the app they were made for. This is an attempt to make it easy to use the same sticker set across multiple chat apps. one of the other reason i created stikman was lack of proper support for stickers in chat platforms like element/matrix, its a lot of work and you need a self hosted server, stikman makes it easy. now that matrix basically have bridges for every other chat platform  when i asked whats holding people back from switching to it in couple of rooms all of them basically said this, stikman comes with all the features you would expect from it sticker sharing, creation etc... .now its one less thing to worry about when choosing your preferred chat program

## Notes

apply [this](https://gitlab.com/sinanmohd/stikman/-/blob/master/nout-sxiv.patch) patch to sxiv or use the patched version [here](https://gitlab.com/sinanmohd/nsxiv) for a more seamless experience, it'll automatically quit sxiv after sticker selection

## Installation
```
git clone https://gitlab/sinanmohd/stikman
cd stikman
sudo make install
```

## Usage

* launch stikman using a key binding daemon like [sxhkd](https://wiki.archlinux.org/title/Sxhkd) and select a sticker using `m` or right click. additionally quit using `q` if you didint apply the [nout sxiv patch](https://gitlab.com/sinanmohd/stikman/-/blob/master/nout-sxiv.patch)

```
stikman install <pack.zip>      install sticker pack
stikman rm                      remove sticker pack
stikman view                    view sticker pack
stikman add     <image file>    add a new item to sticker pack 
stikman share                   get a shareable link for sticker pack
stikman rename                  rename a sticker pack
stikman fetch   <link>          install pack from a link 
stikman create  <directory>     make pack from images inside the directory
stikman help                    print this menu 
```

## Dependencies

* [`sxiv`](https://codeberg.org/nsxiv/nsxiv)
* [`dmenu`](https://tools.suckless.org/dmenu/)
* [`imagemagick`](https://imagemagick.org/index.php)
* [`xclip`](https://github.com/astrand/xclip)
* [`xdotool`](https://github.com/jordansissel/xdotool)

## Optional dependencies

* [`curl`](https://github.com/curl/curl) (for sharing and downloading sticker packs)
* [`zip`](http://www.info-zip.org/Zip.html) (for sharing sticker packs)
* [`unzip`](http://infozip.sourceforge.net/UnZip.html) (for installing sticker packs)

## FAQ

* how do i import telegram stickers ?

send telegram sticker link to any sticker downloader bot (eg: [@downloader_sticker_bot](https://t.me/downloader_sticker_bot), [@DownloadStickersBot](https://t.me/DownloadStickersBot)), download the zip file and install them using `stikman install file.zip`