Software /
code /
prosody-modules
File
mod_muc_bot/README.markdown @ 4886:cbe71ecb4677
mod_bookmarks: Add a stub that loads mod_bookmarks2
This has a magic meta marker that prevents loading on latest trunk as of
rev 7adfd5d29576 or nightly build 1616
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 05 Feb 2022 01:11:22 +0100 |
parent | 4569:9cbdb60e21f2 |
child | 5011:55cf7f063af6 |
line wrap: on
line source
--- summary: Module for improving the life of bot authors --- This module makes it easier to write MUC bots by removing the requirement that the bot be online and joined to the room. All the bot needs to do is send a message and this module handles the rest. # Configuration Example configuration in Prosody: ```lua Component "muc.example.com" "muc" modules_enabled = { "muc_bot", } known_bots = { "bot@example.com" } bots_get_messages = false ignore_bot_errors = true ``` # Sending messages Simply send a stanza like this from your bot: ```xml <message type="groupchat" to="channel@muc.example.com"> <body>Beep boop, I'm a bot!</body> <nick xmlns="http://jabber.org/protocol/nick">Botty</nick> </message> ``` ## Use with mod_rest Using [mod_rest] to interact with MUC suffers from the same need to join with an online resource, so this module helps with that as well! ```bash curl https://xmpp.example.com/rest/message/groupchat/room@muc.example.com \ -d body="beep boop" \ -d nick="Botty" ``` # Compatibility Prosody **trunk** required.