File

mod_csi_muc_priorities/README.markdown @ 4563:30f2d7c3f946

mod_muc_bot: Attempt at module easing creation of stateless bots
author Kim Alvefur <zash@zash.se>
date Thu, 01 Apr 2021 13:15:05 +0200
parent 3639:562d3b219876
line wrap: on
line source

# Introduction

This module lets users specify which of the group chats they are in are
less important. This influences when
[mod_csi_simple][doc:modules:mod_csi_simple] decides to send
stanzas vs waiting until there is more to send. Users in many large
public channels might benefit from this.

# Configuration

The module is configured via ad-hoc an command called *Configure group
chat priorities* that should appear in the menus of compatible clients.

The command presents a form that accepts a list of XMPP addresses.
Currently there is a single priority, *Lower priority*, which is
suitable for e.g. noisy public channels. mod_csi_simple considers
groupchat messages important by default on the assumptions that smaller
and more important private chats are more common among most users.

A message of type groupchat from an address in this list will not be
considered important enough to send it to an inactive client, unless it
is from the current user or mentions of their nickname. **Note** that
mention support require the separate module [mod_track_muc_joins]
to also be loaded.

``` {.lua}
modules_enabled = {
    -- other modules etc

    "csi_simple",
    "csi_muc_priorities",
    "track_muc_joins", -- optional
}
```