Mercurial > prosody-modules

view mod_muc_notifications/README.markdown @ 4579:b305814bd930

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_dicebot: A thing to roll dice Do you see what happens, Jitsi? Do you see what happens when you make it hard for me to use a proper bot? This is what happens, Jitsi. This is what happens when you meet a stranger in the alps! Ahem. In all seriousness, this is more of a quick hack than anything else. It will look for `.r` in MUC messages and if it finds it, it'll interpret it as an instruction to roll a few dice. Injects the results in the body of the message. Eats the message alive if it is malformed.
author Jonas Schäfer <jonas@wielicki.name>
date Sat, 29 May 2021 15:17:05 +0200
parents 69219097aa85
children
line wrap: on
line source

---
labels:
- 'Stage-alpha'
summary: 'Notify of MUC messages to not present members'
...

Introduction
============

This module listens to MUC messages and sends a notification to the
MUC members not present in the MUC at that moment.

By default, the notification will be a message with a simple text as body.

By sending this "out-of-MUC" notification, not-joined members will be able to
know that new messages are available.

Usage
=====

First copy the module to the prosody plugins directory.

Then add "muc\_notifications" to your modules\_enabled list in your
MUC component:

```{.lua}
Component "conference.example.org" "muc"
modules_enabled = {
	"muc_notifications",
}
```

You may also want to enable "offline\_hints" module so the notification messages
sent by this module are not added to the offline storage for later delivery.

Configuration
=============

  Option                      Description
  --------------------------- ----------------------------------------------------------------------------------------------
  muc\_notification\_invite   If set to `true`, the notification sent will take the form of a MUC invite. (default: `false`)