Browse Source

add simple guide on how to add more stickers

pull/96/head
Michael Brusegard 11 months ago
parent
commit
728585ff5a
No known key found for this signature in database GPG Key ID: 895FB8CD416FF235
  1. 27
      README.md

27
README.md

@ -1,17 +1,38 @@
# Maunium sticker picker
A fast and simple Matrix sticker picker widget. Tested on Element Web, Android & iOS.
## Hackerspace How-to
First make sure you have python 3.6 or later installed. Then run the following commands:
```bash
pip install .
```
Now you can put the stickers in a pack in the packs directory. You can either use the hackerspace pack or create your own. Remember to add the number of the sticker in the starts of the file name. It should look liks this `01-name.png`. You can use either png, jpg or gif files.
Then to install the pack run the following command:
```bash
sticker-pack <pack directory> --add-to-index web/packs/
```
When you push the repo the pack will be deployed to be used by the Hackerspace Matrix.
## Discussion
Matrix room: [`#stickerpicker:maunium.net`](https://matrix.to/#/#stickerpicker:maunium.net)
## Instructions
For setup and usage instructions, please visit the [wiki](https://github.com/maunium/stickerpicker/wiki):
* [Creating packs](https://github.com/maunium/stickerpicker/wiki/Creating-packs)
* [Enabling the widget](https://github.com/maunium/stickerpicker/wiki/Enabling-the-widget)
* [Hosting on GitHub pages](https://github.com/maunium/stickerpicker/wiki/Hosting-on-GitHub-pages)
If you prefer video tutorials, [Brodie Robertson](https://www.youtube.com/c/BrodieRobertson) has made a great video on setting up the picker and creating some packs: https://youtu.be/Yz3H6KJTEI0.
If you prefer video tutorials, [Brodie Robertson](https://www.youtube.com/c/BrodieRobertson) has made a great video on setting up the picker and creating some packs: <https://youtu.be/Yz3H6KJTEI0>.
## Comparison with other sticker pickers
@ -31,11 +52,15 @@ If you prefer video tutorials, [Brodie Robertson](https://www.youtube.com/c/Brod
[#7]: https://github.com/maunium/stickerpicker/issues/7
## Preview
### Element Web
![Element Web](preview-element-web.png)
### Element Android
![Element Android](preview-element-android.png)
### Element iOS (dark theme)
![Element iOS](preview-element-ios.png)
Loading…
Cancel
Save