Browse Source

Update README file with query parameters

pull/70/head
Kévin Cocchi 1 year ago
parent
commit
4e801832e4
No known key found for this signature in database GPG Key ID: E3F3FFBE2818518D
  1. 36
      README.md
  2. BIN
      images/preview-element-android.png
  3. BIN
      images/preview-element-ios.png
  4. 0
      images/preview-element-web.png
  5. BIN
      preview-element-android.png
  6. BIN
      preview-element-ios.png

36
README.md

@ -1,26 +1,29 @@
# Maunium sticker picker # Maunium sticker picker
A fast and simple Matrix sticker picker widget. Tested on Element Web, Android & iOS. A fast and simple Matrix sticker picker widget. Tested on Element Web, Android & iOS.
## Discussion ## Discussion
Matrix room: [`#stickerpicker:maunium.net`](https://matrix.to/#/#stickerpicker:maunium.net) Matrix room: [`#stickerpicker:maunium.net`](https://matrix.to/#/#stickerpicker:maunium.net)
## Instructions ## Instructions
For setup and usage instructions, please visit the [wiki](https://github.com/maunium/stickerpicker/wiki): 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. 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 ## 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 | | Feature | Scalar | Dimension | Maunium sticker picker |
|---------------------------------|--------|-----------|------------------------|
| ------------------------------- | ------ | --------- | ---------------------- |
| Free software | ❌ | ✔️ | ✔️ | | Free software | ❌ | ✔️ | ✔️ |
| Custom sticker packs | ❌ | ✔️ | ✔️ | | Custom sticker packs | ❌ | ✔️ | ✔️ |
| Telegram import | ❌ | ✔️ | ✔️ | | 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 [#7]: https://github.com/maunium/stickerpicker/issues/7
## Preview ## Preview
### Element Web
![Element Web](preview-element-web.png)
### Element Android
![Element Android](preview-element-android.png)
| Web / Desktop | Android | iOS (Dark theme) |
| ---------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------- |
| ![Element Web](images/preview-element-web.png) | ![Element Android](images/preview-element-android.png) | ![Element iOS](images/preview-element-ios.png) |
## 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)
![Element iOS](preview-element-ios.png)
- `?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

BIN
images/preview-element-android.png

After

Width: 540  |  Height: 576  |  Size: 250 KiB

BIN
images/preview-element-ios.png

After

Width: 621  |  Height: 576  |  Size: 216 KiB

0
preview-element-web.png → images/preview-element-web.png

Before

Width: 315  |  Height: 363  |  Size: 86 KiB

After

Width: 315  |  Height: 363  |  Size: 86 KiB

BIN
preview-element-android.png

Before

Width: 540  |  Height: 1079  |  Size: 545 KiB

BIN
preview-element-ios.png

Before

Width: 621  |  Height: 1074  |  Size: 442 KiB

Loading…
Cancel
Save