diff --git a/README.md b/README.md index a4f1a8e5e541ea481e56114a6935cae59b5ff7af..42425f3e25f0e5d336a6e17dc52aa8a0bdf00dfe 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,29 @@ # Maunium sticker picker + A fast and simple Matrix sticker picker widget. Tested on Element Web, Android & iOS. ## 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) +- [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. ## Comparison with other sticker pickers -* 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. +- 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. | Feature | Scalar | Dimension | Maunium sticker picker | -|---------------------------------|--------|-----------|------------------------| +| ------------------------------- | ------ | --------- | ---------------------- | | Free software | ⌠| âœ”ï¸ | âœ”ï¸ | | Custom sticker packs | ⌠| âœ”ï¸ | âœ”ï¸ | | Telegram import | ⌠| âœ”ï¸ | âœ”ï¸ | @@ -31,11 +34,18 @@ 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 Android - +| 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 : -### Element iOS (dark theme) - +- `?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 diff --git a/images/preview-element-android.png b/images/preview-element-android.png new file mode 100644 index 0000000000000000000000000000000000000000..0a7e720eaeb8ff8b2c9fe1f2fb4fd19ab1e427c4 Binary files /dev/null and b/images/preview-element-android.png differ diff --git a/images/preview-element-ios.png b/images/preview-element-ios.png new file mode 100644 index 0000000000000000000000000000000000000000..dc3a44ef46b2a6a78058f67c908defe4085ce5ee Binary files /dev/null and b/images/preview-element-ios.png differ diff --git a/preview-element-web.png b/images/preview-element-web.png similarity index 100% rename from preview-element-web.png rename to images/preview-element-web.png diff --git a/preview-element-android.png b/preview-element-android.png deleted file mode 100644 index 18575b142dd79bae861b134d064b423038681279..0000000000000000000000000000000000000000 Binary files a/preview-element-android.png and /dev/null differ diff --git a/preview-element-ios.png b/preview-element-ios.png deleted file mode 100644 index 6576dfb152b6fe18bd327d449210b6ac177eb57d..0000000000000000000000000000000000000000 Binary files a/preview-element-ios.png and /dev/null differ