Skip to content

Commit

Permalink
Define 'avatar' and 'display-name' channel metadata keys (#495)
Browse files Browse the repository at this point in the history
They are pretty uncontroversial, and will allow testing implementations without
going through the trouble of un-vendoring names later
  • Loading branch information
progval committed Jul 1, 2024
1 parent 0d5f3d5 commit c1a7b21
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion _data/metadata_registry.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
# User Metadata
- name: Channel Metadata
values:
- key: avatar
description: Avatar that graphical clients can show alongside the channel's name
format: URL with an optional `{size}` substitution denoting the size to load in pixels
examples: https://example.com/avatar/16/asdf.jpg
- key: display-name
description: >-
Alternative name to use instead of a channel for display purposes. Useful for gateways
to chat services that allow spaces and other characters in nicks. A channel name is
required for standard protocol level stuff but can be less prominent in the UI.
May contain emoji.
format: Any string
examples: |-
IRCv3 HQ
General Support Channel
- name: User Metadata
values:
- key: avatar
Expand Down

0 comments on commit c1a7b21

Please sign in to comment.