ircv3.github.io/_data/metadata_registry.yml at 7ecde6262a80ff50492e13858e132754273c2cac · ircv3/ircv3.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
- 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
      description: Avatar that graphical clients can show alongside the user'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: bot
      description: >-
        Lets bot runners provide the name of their bot software. Setting this key
        identifies the client as a bot.
      format: Any string
      examples: |-
        PacketBot v1.2
        JitiBot
        melo3
    - key: color
      description: >-
        A color to associate with a user. Client designers may decide which UI elements use this color (for example avatar placeholders, nicknames or whole messages).
      format: HTML-style 6 hexadecimal digits
      examples: |-
        #800040
        #0a00ff
    - key: display-name
      description: >-
        Alternative name to use instead of a nick for display purposes. Useful for gateways
        to chat services that allow spaces and other characters in nicks. A nick is
        required for standard protocol level stuff but can be less prominent in the UI.
        May contain emoji.
      format: Any string
      examples: |-
        James Wheare
        Posiden
        ダニエル
        Борис
    - key: homepage
      description: >-
        URL of a webpage that contains more information about the user/bot themselves,
        or bot software in use.
      format: Valid URL
      examples: |-
        https://example.com/bot-info.html
    - key: pronouns
      description: >-
        Text that can be displayed in a user's profile so that others know how to refer to them.

        Should not be parsed or localized.
      format: Any string
      examples: |-
        they/them
        she/her (妳/她)
    - key: status
      description: Status text that can be shown for users without making them 'away'
      format: Any string
      examples: |-
        Working from home