Mercurial > prosody-modules
diff mod_muc_slow_mode/README.markdown @ 5947:22effe87fed2
mod_muc_slow_mode: adding more context in the README.
author | John Livingston <git@john-livingston.fr> |
---|---|
date | Mon, 29 Jul 2024 23:07:09 +0200 |
parents | 83787415fc8d |
children |
line wrap: on
line diff
--- a/mod_muc_slow_mode/README.markdown Mon Jul 29 13:26:55 2024 +0200 +++ b/mod_muc_slow_mode/README.markdown Mon Jul 29 23:07:09 2024 +0200 @@ -8,7 +8,17 @@ This module is under AGPL-3.0 license. -There will probably be a XEP proposal for this module behaviour. When done, this module will be published in the prosody-modules repository. +There will probably be a XEP proposal for this module behaviour. + +## Slow mode definition + +There are some contexts in which you want to be able to rate limit MUC messages. This could have multiple motivations: avoid flooding, garantee a better readability of the room when there are hundreds of active users, … + +This module propose a new option for MUC rooms, allowing room owners to fix a duration that users must wait between two messages. + +There is a draft XEP for this feature, that you can find here: https://github.com/JohnXLivingston/xeps/blob/xep-slow-mode/xep-slow-mode.xml + +There is a more human-readable version of this XEP here: https://livingston.frama.io/peertube-plugin-livechat/technical/slow_mode/ ## Configuration