Software / code / prosody-modules
Annotate
mod_muc_bot/README.markdown @ 4813:0a257d1402c3
mod_muc_rtbl: Optimize case with zero hashes
On the assumption that during quiet times between torrents of spam,
the hash set would be empty. There would be no point in doing the
operations and hashes to check for a match in that case.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 06 Dec 2021 18:19:19 +0100 |
| parent | 4569:9cbdb60e21f2 |
| child | 5011:55cf7f063af6 |
| rev | line source |
|---|---|
| 4568 | 1 --- |
| 2 summary: Module for improving the life of bot authors | |
| 3 --- | |
| 4 | |
| 5 This module makes it easier to write MUC bots by removing the | |
| 6 requirement that the bot be online and joined to the room. | |
| 7 | |
| 8 All the bot needs to do is send a message and this module handles the | |
| 9 rest. | |
| 10 | |
| 11 # Configuration | |
| 12 | |
| 13 Example configuration in Prosody: | |
| 14 | |
| 15 ```lua | |
| 16 Component "muc.example.com" "muc" | |
| 17 | |
| 18 modules_enabled = { | |
| 19 "muc_bot", | |
| 20 } | |
| 21 known_bots = { "bot@example.com" } | |
| 22 bots_get_messages = false | |
| 23 ignore_bot_errors = true | |
| 24 ``` | |
| 25 | |
| 26 # Sending messages | |
| 27 | |
| 28 Simply send a stanza like this from your bot: | |
| 29 | |
| 30 ```xml | |
| 31 <message type="groupchat" to="channel@muc.example.com"> | |
| 32 <body>Beep boop, I'm a bot!</body> | |
| 33 <nick xmlns="http://jabber.org/protocol/nick">Botty</nick> | |
| 34 </message> | |
| 35 ``` | |
| 36 | |
| 37 ## Use with mod_rest | |
| 38 | |
| 39 Using [mod_rest] to interact with MUC suffers from the same need to join | |
| 40 with an online resource, so this module helps with that as well! | |
| 41 | |
| 42 ```bash | |
| 43 curl https://xmpp.example.com/rest/message/groupchat/room@muc.example.com \ | |
| 44 -d body="beep boop" \ | |
| 45 -d nick="Botty" | |
| 46 ``` | |
| 47 | |
|
4569
9cbdb60e21f2
mod_muc_bot: Add Compatibility section to README
Kim Alvefur <zash@zash.se>
parents:
4568
diff
changeset
|
48 # Compatibility |
|
9cbdb60e21f2
mod_muc_bot: Add Compatibility section to README
Kim Alvefur <zash@zash.se>
parents:
4568
diff
changeset
|
49 |
|
9cbdb60e21f2
mod_muc_bot: Add Compatibility section to README
Kim Alvefur <zash@zash.se>
parents:
4568
diff
changeset
|
50 Prosody **trunk** required. |
