Sticker messages (m.sticker) #1158

rxl881 · 2018-03-14T15:02:27Z

No description provided.

richvdh

This looks great, really clear!

a few niggles below

richvdh · 2018-03-14T17:55:40Z

specification/modules/stickers.rst

+
+.. _module:stickers:
+
+This module allows users to send sticker messages in to rooms or direct messaging sessions.


please could you wrap at 80 cols as per https://github.com/matrix-org/matrix-doc/blob/master/meta/documentation_style.rst#line-widths?

Ahh, sorry for missing that. Now wrapped.

richvdh · 2018-03-14T17:58:53Z

specification/modules/stickers.rst

+
+This module allows users to send sticker messages in to rooms or direct messaging sessions.
+
+Sticker messages are specialised image messages that are displayed without controls (e.g. no "download" link, or light-box view on click, as would be displayed for for m.room.message#m.image events).


might be nice to link to the m.image definition. I think something as simple as `m.image`_ might work.

richvdh · 2018-03-14T18:01:52Z

specification/modules/stickers.rst

+
+Clients supporting this message type should display the image content from the event URL directly in the timeline.
+
+A thumbnail image should be provided in the message info. object. This is largely intended as a fallback for clients that do not fully support the m.sticker event type. Im most cases it is fine to set the thumbnail URL to the same URL as the main event content.


I think just ``info`` (rather than 'message info.') here.

double-backticks around m.sticker.

s/Im/In/

richvdh · 2018-03-14T18:02:08Z

specification/modules/stickers.rst

+
+A thumbnail image should be provided in the message info. object. This is largely intended as a fallback for clients that do not fully support the m.sticker event type. Im most cases it is fine to set the thumbnail URL to the same URL as the main event content.
+
+It is recommended that sticker image content should be approximately 400x400 pixels in size (or smaller). The image dimensions specified in the info. object of the message should be half of the original image dimensions in order to display correctly on retina displays.


info as above

I'm failing to grok the idea behind the retina display thing tbh

This is intended as a way of ensuring that the images are displayed as crisply as possible on high resolution displays. If the physical image is double the size of the event dimensions metadata it will be scaled down on normal resolution screens (by displaying every second pixel). On 2x (retina screens) the full resolution of the image will be used, resulting in a crisper image on displays that support it. - This was @ara4n's suggestion originally, as a short-term solution. However in the longer term we probably need to improve this by getting the media server to be able to render content for different DPI devices, or by specifying alternate display content in the sticker metadata.

turt2live · 2018-03-14T18:04:56Z

specification/modules/stickers.rst

+
+A thumbnail image should be provided in the message info. object. This is largely intended as a fallback for clients that do not fully support the m.sticker event type. Im most cases it is fine to set the thumbnail URL to the same URL as the main event content.
+
+It is recommended that sticker image content should be approximately 400x400 pixels in size (or smaller). The image dimensions specified in the info. object of the message should be half of the original image dimensions in order to display correctly on retina displays.


just for compatibility with telegram, can we bump the recommendation to 512x512?

Sure. Updated.

rxl881 · 2018-03-15T10:29:39Z

Thanks @richvdh, @turt2live - All of that feedback should be incorporated now.

@ara4n - Anything else (or are we good to merge)?

ara4n · 2018-03-15T10:33:00Z

the only thing that worries me here is whether we're doing m.sticker (which implies that it should be using whatever the final event format proposal is) or m.room.sticker. I think I'm tempted slightly towards m.room.sticker for now given it's more consistent with the other stuff currently and we haven't decided on the final prefix strategy going forwards.

ara4n · 2018-03-15T10:47:57Z

apparently i explicitly asked rick to s/m.room.sticker/m.sticker/g in some flu-riddled malaise last week, so let's stick with it. it may end up being an odd one out, but sobeit.

turt2live · 2018-03-15T15:14:58Z

specification/modules/stickers.rst

+same URL as the main event content.
+
+It is recommended that sticker image content should be approximately 512x512
+pixels in size (or smaller). The image dimensions specified in the info. object


the full stop in ...in the info. object... is making this somewhat hard to read. Maybe make info styled as info instead (without a full stop)?

As for suggested wording re: retina, how does this sound?

It is recommended that stickers be 512x512 pixels or smaller. The image dimensions specified in the image info should be half of the real dimensions (eg: 256x256) to assist rendering on higher DPI screens.

(incorporates some of the explanation from the lost thread in this area)

I've updated 'info.' to info (to match the other occurrence in the previous paragraph).

I have also incorporated your suggested wording with some minor tweaks.

heitorPB · 2018-03-18T15:33:52Z

In Telegram and Facebook Messenger, the stickers are organized inside packs (Sticker Packs), when you want to "install" an sticker in your device, you have to install the entire pack. This puts the stickers in "categories", in a similar way to the emojis. Ans this is consistent in all clients of these apps (web, desktop, mobile). Maybe this should be addressed here?

rxl881 · 2018-03-20T09:37:21Z

Hi @heitorPB - Thanks for the question.

As you suggest, our intention is to organise stickers in to "Sticker packs" - it's certainly how we're going to be doing it in Scalar (the New Vector integration manager).

We'll be releasing our implementation of stickers / stickerpacks soon, which should serve as an example of how others might want to implements stickerpacks. However, I am a little reluctant to put details of organising stickers into stickerpacks in to the spec. as that is really up to the integration manager to decide how they want to organise and distribute stickers.

maxidorius · 2018-03-20T12:04:55Z

I am a little reluctant to put details of organising stickers into stickerpacks in to the spec. as that is really up to the integration manager to decide how they want to organise and distribute stickers.

@rxl881 Could you expand on the above? How is a sticker pack, which is a client-side item, can be present on an integration manager?
It suddenly feels like there is much more to this than just being an fixed size image...

ara4n · 2018-03-20T13:00:30Z

the point is that an m.sticker is just a fixed sized image. the widget (or client or integration mgr or whatever) that you use to organise them and emit them is left undefined for maximum flexibility, at least for now or until we see how folks use them.

heitorPB · 2018-03-20T15:28:46Z

A small description about stickers in Telegram is here:
https://telegram.org/blog/stickers

In Telegram, anyone can create a sticker pack. After you create a sticker pack, only you can edit it (add new stickers, remove, reorder, ...). This approach allows some kind of 'organization' for the stickers: if you have a pack named "animals" you dont't expect it to have flags of countries there. Also, in Telegram the stickers have a maximum image size (512x512) and are PNGs, animated stickers are not allowed at the moment.

It makes no sense to have huge images as stickers, as they don't fit a mobile screen and their purpose is not to show an image on the screen. And it would be very nice to have the possibility of animated stickers :)

richvdh · 2018-03-23T10:10:39Z

specification/modules/stickers.rst


 {{m_sticker_event}}

 Client behaviour
 ----------------

-Clients supporting this message type should display the image content from the event URL directly in the timeline.
+Clients supporting this message type should display the image content from the
+event URL directly in the timeline.


we might want to have some warning about sanitising URLs?

As discussed, hopefully clarifying that we expect these to be valid MXC URIs should be enough(?)

richvdh · 2018-03-23T10:14:56Z

specification/modules/stickers.rst

-It is recommended that sticker image content should be approximately 400x400 pixels in size (or smaller). The image dimensions specified in the info. object of the message should be half of the original image dimensions in order to display correctly on retina displays.
+It is recommended that sticker image content should be 512x512 pixels in size
+or smaller. The image dimensions specified in the ``info`` object of the
+message should be half of the original image dimensions in order to assist


as per https://matrix.to/#/!HCXfdvrfksxuYnIFiJ:matrix.org/$1521800047436EfeUZ:sw1v.org, I am still WTFing at this

ok I think convo there has clarified my confusion; however i would make two changes:

Clarify (presumably in the ImageInfo schema) that the dimensions given are the intended display size, as opposed to the intrinsic size of the image file.

To me, your description "info should be half the image dimensions" is backwards and it would seem more logical to me to phrase it as "the image should be twice the intended display size given in info" or words to that effect.

richvdh · 2018-03-23T10:43:11Z

sorry for sitting on this for days btw

turt2live

GitHub mobile doesn't let me do line comments on their own.

event-schemas/schema/core-event-schema/msgtype_infos/image_info.yaml

rxl881 · 2018-03-23T14:37:32Z

@richvdh -- Do the latest updates address your concerns / comments?

richvdh · 2018-03-23T16:33:05Z

event-schemas/schema/m.sticker

@@ -18,7 +18,8 @@ properties:
          Metadata about the image referred to in ``url`` including a thumbnail
          representation.
      url:
-        description: The URL to the sticker image.
+        description: |-
+          The URL to the sticker image. This must be a valid ``mxc://`` URI.


well, if we're expecting clients to check this, we should probably say so.

richvdh

\o/ lgtm

…g#1158) * Fix unintentional stateres change added in matrix-org#1042 * Changelog

rxl881 added 5 commits March 14, 2018 11:26

Example m.sticker event

a87cd82

Very basic m.sticker description.

2989406

m.sticker event definition.

91f1834

Additional event structure detail.

c471f48

Update m.sticker description with more detail.

0f8e34d

rxl881 assigned ara4n Mar 14, 2018

richvdh reviewed Mar 14, 2018

View reviewed changes

turt2live reviewed Mar 14, 2018

View reviewed changes

rxl881 added 4 commits March 15, 2018 10:09

Wrap lines at 80 cols.

f421337

Add backlink to m.image event definition.

c59b879

Update sticker resolution recommendation.

250ada7

Misc fixes.

a1fdecc

Fix grammar (slightly).

8dd7bd5

turt2live reviewed Mar 15, 2018

View reviewed changes

rxl881 added 2 commits March 15, 2018 18:03

Fix formatting.

1d9de28

Improve wording.

43d9543

rxl881 mentioned this pull request Mar 19, 2018

Render sticker events in the timeline element-hq/riot-meta#146

Closed

rxl881 assigned richvdh and unassigned ara4n Mar 22, 2018

richvdh reviewed Mar 23, 2018

View reviewed changes

richvdh removed their assignment Mar 23, 2018

richvdh assigned rxl881 Mar 23, 2018

rxl881 added 5 commits March 23, 2018 12:11

Specify that the url key should point to a valid MXC URI

90d9960

Clarify image sizing guidelines.

eb7bbcf

Move MXC requirement to schema.

618096e

Fix multiline formatting.

114e9e2

Fix errant comma.

761ad98

turt2live reviewed Mar 23, 2018

View reviewed changes

event-schemas/schema/core-event-schema/msgtype_infos/image_info.yaml Show resolved Hide resolved

richvdh reviewed Mar 23, 2018

View reviewed changes

rxl881 added 2 commits March 23, 2018 17:23

Improve thumbnail dimension descriptions.

56dc295

Update changelog.

02c5afb

rxl881 assigned richvdh and unassigned rxl881 Mar 26, 2018

richvdh approved these changes Mar 27, 2018

View reviewed changes

richvdh merged commit 8d05f80 into master Mar 27, 2018

RiotTranslateBot pushed a commit to RiotTranslateBot/matrix-doc that referenced this pull request Aug 22, 2023

Fix unintentional stateres change added in matrix-org#1042 (matrix-or…

cc7cc4a

…g#1158) * Fix unintentional stateres change added in matrix-org#1042 * Changelog

jplatte mentioned this pull request Nov 5, 2023

Stickers have incomplete / invalid documentation around encryption matrix-org/matrix-spec#1667

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sticker messages (m.sticker) #1158

Sticker messages (m.sticker) #1158

rxl881 commented Mar 14, 2018

richvdh left a comment

richvdh Mar 14, 2018

rxl881 Mar 15, 2018

richvdh Mar 14, 2018

richvdh Mar 14, 2018

richvdh Mar 14, 2018

richvdh Mar 14, 2018

rxl881 Mar 15, 2018

turt2live Mar 14, 2018

rxl881 Mar 15, 2018

rxl881 commented Mar 15, 2018

ara4n commented Mar 15, 2018

ara4n commented Mar 15, 2018

turt2live Mar 15, 2018

rxl881 Mar 15, 2018

heitorPB commented Mar 18, 2018

rxl881 commented Mar 20, 2018

maxidorius commented Mar 20, 2018

ara4n commented Mar 20, 2018 •

edited

heitorPB commented Mar 20, 2018

richvdh Mar 23, 2018

rxl881 Mar 23, 2018

richvdh Mar 23, 2018

richvdh Mar 23, 2018

richvdh commented Mar 23, 2018

turt2live left a comment

rxl881 commented Mar 23, 2018

richvdh Mar 23, 2018

richvdh left a comment


		.. _module:stickers:

		This module allows users to send sticker messages in to rooms or direct messaging sessions.


		This module allows users to send sticker messages in to rooms or direct messaging sessions.

		Sticker messages are specialised image messages that are displayed without controls (e.g. no "download" link, or light-box view on click, as would be displayed for for m.room.message#m.image events).


		Clients supporting this message type should display the image content from the event URL directly in the timeline.

		A thumbnail image should be provided in the message info. object. This is largely intended as a fallback for clients that do not fully support the m.sticker event type. Im most cases it is fine to set the thumbnail URL to the same URL as the main event content.


		A thumbnail image should be provided in the message info. object. This is largely intended as a fallback for clients that do not fully support the m.sticker event type. Im most cases it is fine to set the thumbnail URL to the same URL as the main event content.

		It is recommended that sticker image content should be approximately 400x400 pixels in size (or smaller). The image dimensions specified in the info. object of the message should be half of the original image dimensions in order to display correctly on retina displays.

Sticker messages (m.sticker) #1158

Sticker messages (m.sticker) #1158

Conversation

rxl881 commented Mar 14, 2018

richvdh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rxl881 commented Mar 15, 2018

ara4n commented Mar 15, 2018

ara4n commented Mar 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heitorPB commented Mar 18, 2018

rxl881 commented Mar 20, 2018

maxidorius commented Mar 20, 2018

ara4n commented Mar 20, 2018 • edited

heitorPB commented Mar 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh commented Mar 23, 2018

turt2live left a comment

Choose a reason for hiding this comment

rxl881 commented Mar 23, 2018

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

ara4n commented Mar 20, 2018 •

edited