Mercurial > prosody-modules
view mod_muc_badge/README.markdown @ 3265:d4207ab8ccc1
mod_pubsub_github: Remove unused import [luacheck]
Use of formdecode was removed in 754d97ba333d
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 24 Aug 2018 18:05:52 +0200 |
parents | a3afab416271 |
children | 4a77c9c2a1cd |
line wrap: on
line source
--- depends: - 'mod\_http' - 'mod\_muc' provides: - http title: 'mod\_muc\_badge' --- # Introduction This module generates a badge for MUC rooms at a HTTP URL like `https://example.com:5281/muc_badge/room@conference.example.org` containing the number of occupants. Inspiration : <https://opkode.com/blog/xmpp-chat-badge/> # Configuration Option Type Default ------------------ -------- -------------------------- `badge_label` string `"Chatroom"` `badge_count` string `"%d online"` `badge_template` string A SVG image (see source) The template must be valid XML. If it contains `{label}` then this is replaced by `badge_label`, similarly, `{count}` is substituted by `badge_count` with `%d` changed to the number of occupants. Details of the HTTP URL is determined by [standard Prosody HTTP server configuration][doc:http]. # TODO - Maybe use the room name instead of a fixed label. Would need dynamic resizing.