diff mod_muc_adhoc_bots/README.markdown @ 5652:eade7ff9f52c

mod_muc_adhoc_bots: add module
author Stephen Paul Weber <singpolyma@singpolyma.net>
date Mon, 18 Sep 2023 08:22:07 -0500
parents
children 7a4a6ded2bd6
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_adhoc_bots/README.markdown	Mon Sep 18 08:22:07 2023 -0500
@@ -0,0 +1,22 @@
+---
+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" }