prosody-modules
750d64c47ec6
mod_muc_hats_adhoc/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_muc_hats_adhoc/README.md @ 6211:750d64c47ec6 draft default tip

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:31:36 +0700
parent 6003:fe081789f7b5
comparison
equal deleted inserted replaced
6210:24316a399978 6211:750d64c47ec6
1 ---
2 summary: Ad-hoc commands for managing MUC hats
3 ---
4
5 # Introduction
6
7 This module provides an internal API (i.e. to other modules) to manage
8 'hats' for users in MUC rooms.
9
10 Hats (first defined in [XEP-0317], currently deferred) are additional identifiers
11 that can be attached to users in a group chat. For example in an educational
12 context, you may have a 'Teacher' hat that allows students to identify their
13 teachers.
14
15 Hats consist of a machine-readable unique identifier (a URI), and optionally
16 a human-readable label.
17
18 This module provides ad-hoc commands for MUC service admins to add/remove hats
19 to/from users in MUC rooms. It depends (automatically) on mod_muc_hats_api.
20
21 ## Configuration
22
23 ```
24 Component "conference.example.com" "muc"
25 modules_enabled = { "muc_hats_adhoc" }
26 ```
27
28 ## Usage
29
30 To successfully use the module you will need to use an XMPP client that is
31 capable of sending commands to a specific host (e.g. via the service discovery
32 browser in Gajim, Psi/Psi+ and other clients), and you'll find the commands
33 on the MUC host.
34
35 Also note that the display of hats in clients is currently non-existent, but
36 will hopefully improve after [XEP-0317] is resurrected or replaced.
37