Mercurial > prosody-modules
view mod_muc_bot/README.markdown @ 5389:d872a1cd8c1d
mod_http_oauth2: Specify that 'contacts' items are emails in client registration
Not enforced, but good for documentation.
> Array of strings representing ways to contact people responsible for
> this client, typically email addresses.
"typically" isn't a great word in a specification, so one could persume
this may be e.g. URLs like https://example.com/contact-us or so as well.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 30 Apr 2023 15:20:05 +0200 |
parents | 55cf7f063af6 |
children |
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 Works with Prosody 0.12 or later.