2020-09-05 02:31:34 +03:00
# Maunium sticker picker
2023-09-30 14:49:50 +02:00
2020-09-05 18:52:44 +03:00
A fast and simple Matrix sticker picker widget. Tested on Element Web, Android & iOS.
2020-09-05 02:31:34 +03:00
2020-09-05 14:56:35 +03:00
## Discussion
2023-09-30 14:49:50 +02:00
2020-09-13 14:27:37 +03:00
Matrix room: [`#stickerpicker:maunium.net` ](https://matrix.to/#/#stickerpicker:maunium.net )
2020-09-05 14:56:35 +03:00
2020-09-17 14:09:44 +03:00
## Instructions
2023-09-30 14:49:50 +02:00
2020-09-17 14:09:44 +03:00
For setup and usage instructions, please visit the [wiki ](https://github.com/maunium/stickerpicker/wiki ):
2020-09-13 03:56:28 +03:00
2023-09-30 14:49:50 +02:00
- [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 )
2020-09-05 02:36:31 +03:00
2021-01-24 13:14:59 +02:00
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.
2020-10-07 00:36:55 +03:00
## Comparison with other sticker pickers
2023-09-30 14:49:50 +02:00
- Scalar is the default integration manager in Element, which can't be self-hosted and only supports predefined sticker packs.
- [Dimension ](https://github.com/turt2live/matrix-dimension ) is an alternate integration manager. It can be self-hosted, but it's more difficult than Maunium sticker picker.
- Maunium sticker picker is just a sticker picker rather than a full integration manager. It's much simpler than integration managers, but currently has to be set up manually per-user.
2021-01-24 13:14:59 +02:00
2020-10-30 22:28:09 +02:00
| Feature | Scalar | Dimension | Maunium sticker picker |
2023-09-30 14:49:50 +02:00
| ------------------------------- | ------ | --------- | ---------------------- |
2020-10-30 22:28:09 +02:00
| Free software | ❌ | ✔️ | ✔️ |
| Custom sticker packs | ❌ | ✔️ | ✔️ |
| Telegram import | ❌ | ✔️ | ✔️ |
| Works on Element mobiles | ✔️ | ❌ | ✔️ |
| Easy multi-user setup | ✔️ | ✔️ | ❌< sup > [#7 ][#7 ]</ sup > |
| Frequently used stickers at top | ❌ | ❌ | ✔️ |
[#7 ]: https://github.com/maunium/stickerpicker/issues/7
2020-10-07 00:36:55 +03:00
2020-09-05 02:36:31 +03:00
## Preview
2023-09-30 14:49:50 +02:00
| Web / Desktop | Android | iOS (Dark theme) |
| ---------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------- |
|  |  |  |
## Additional configuration
On an hosted instance of the sticker picker, it is possible to provide optional URL params for extended configuration :
2020-09-13 18:01:17 +03:00
2023-09-30 14:49:50 +02:00
- `?config=<link to an index.json file>`
- allows to use an external `index.json` file (see [packs/README.md ](packs/README.md ))
- this overrides the `web/packs/index.json` file
- `?theme=[$theme|default|light|black|dark]`
- provides the theme to use for the sticker picker
- `$theme` matches the theme of your Element client
