You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

51 lines
3.0 KiB

4 years ago
4 years ago
4 years ago
4 years ago
  1. # Maunium sticker picker
  2. A fast and simple Matrix sticker picker widget. Tested on Element Web, Android & iOS.
  3. ## Discussion
  4. Matrix room: [`#stickerpicker:maunium.net`](https://matrix.to/#/#stickerpicker:maunium.net)
  5. ## Instructions
  6. For setup and usage instructions, please visit the [wiki](https://github.com/maunium/stickerpicker/wiki):
  7. - [Creating packs](https://github.com/maunium/stickerpicker/wiki/Creating-packs)
  8. - [Enabling the widget](https://github.com/maunium/stickerpicker/wiki/Enabling-the-widget)
  9. - [Hosting on GitHub pages](https://github.com/maunium/stickerpicker/wiki/Hosting-on-GitHub-pages)
  10. 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.
  11. ## Comparison with other sticker pickers
  12. - Scalar is the default integration manager in Element, which can't be self-hosted and only supports predefined sticker packs.
  13. - [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.
  14. - 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.
  15. | Feature | Scalar | Dimension | Maunium sticker picker |
  16. | ------------------------------- | ------ | --------- | ---------------------- |
  17. | Free software | ❌ | ✔️ | ✔️ |
  18. | Custom sticker packs | ❌ | ✔️ | ✔️ |
  19. | Telegram import | ❌ | ✔️ | ✔️ |
  20. | Works on Element mobiles | ✔️ | ❌ | ✔️ |
  21. | Easy multi-user setup | ✔️ | ✔️ | ❌<sup>[#7][#7]</sup> |
  22. | Frequently used stickers at top | ❌ | ❌ | ✔️ |
  23. [#7]: https://github.com/maunium/stickerpicker/issues/7
  24. ## Preview
  25. | Web / Desktop | Android | iOS (Dark theme) |
  26. | ---------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------- |
  27. | ![Element Web](images/preview-element-web.png) | ![Element Android](images/preview-element-android.png) | ![Element iOS](images/preview-element-ios.png) |
  28. ## Additional configuration
  29. On an hosted instance of the sticker picker, it is possible to provide optional URL params for extended configuration :
  30. - `?config=<link to an index.json file>`
  31. - allows to use an external `index.json` file (see [packs/README.md](packs/README.md))
  32. - this overrides the `web/packs/index.json` file
  33. - `?theme=[$theme|default|light|black|dark]`
  34. - provides the theme to use for the sticker picker
  35. - `$theme` matches the theme of your Element client