Mercurial > prosody-modules

comparison mod_muc_badge/README.markdown @ 3141:774845606d73

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
author Kim Alvefur <zash@zash.se>
date Sat, 23 Jun 2018 18:08:34 +0200
parents
children feefc29a1ef4
comparison
equal deleted inserted replaced
3140:11087a72990b 3141:774845606d73
1 ---
2 depends:
3 - 'mod\_http'
4 - 'mod\_muc'
5 provides:
6 - http
7 title: 'mod\_muc\_badge'
8 ---
9
10 # Introduction
11
12 This module generates a badge, similar the one
13 <https://opkode.com/blog/xmpp-chat-badge/>
14
15 # Configuration
16
17 Option Type Default
18 ------------------ -------- --------------------------
19 `badge_label` string `"Chatroom"`
20 `badge_count` string `"%d online"`
21 `badge_template` string A SVG image (see source)
22
23 The template must be valid XML. If it contains `{label}` then this is
24 replaced by `badge_label`, similarly, `{count}` is substituted by
25 `badge_count` with `%d` changed to the number of occupants.