view mod_muc_adhoc_bots/README.markdown @ 5734:cef8bce2d71b

luacheck: Add new module API methods from trunk See * trunk rev 4d4f9e42bcf8 * trunk rev 65fb0d7a2312 * trunk rev c9ef35fab0b1
author Kim Alvefur <zash@zash.se>
date Mon, 27 Nov 2023 07:10:06 +0100
parents 7a4a6ded2bd6
children
line wrap: on
line source

---
labels:
- Stage-Alpha
summary: Install adhoc command bots in MUCs
---

# Introduction

This module allows you to "install" bots on a MUC service (via config for
now, via adhoc command and on just one MUC to follow). All the adhoc commands
defined on the bot become adhoc commands on the service's MUCs, and the bots
can send XEP-0356 messages to the MUC to send messages as any participant.

# Configuration

List all bots to install. You must specify full JID.

    adhoc_bots = { "some@bot.example.com/bot" }
	
And enable the module on the MUC service as usual

    modules_enabled = { "muc_adhoc_bots" }