Software /
code /
prosody-modules
Diff
mod_muc_badge/README.markdown @ 3141:774845606d73
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 |
child | 3142:feefc29a1ef4 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_muc_badge/README.markdown Sat Jun 23 18:08:34 2018 +0200 @@ -0,0 +1,25 @@ +--- +depends: +- 'mod\_http' +- 'mod\_muc' +provides: +- http +title: 'mod\_muc\_badge' +--- + +# Introduction + +This module generates a badge, similar the one +<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.