include welcome module with multi-room message-mapping support

base-config.yaml

@@ -29,3 +29,31 @@ admins:
 invitees:
 - "@mybot:server.tld"
 - "@secondaryadmin:server.tld"
+
+# auto-greet users in rooms with these messages
+# map greeting messages to a room
+# you can use {user} to reference the joining user in this message using a
+# matrix.to link (rendered as a "pill" in element clients)
+# html formatting is supported
+greetings:
+  generic: |
+    Welcome {user}! Please be sure to read the topic for helpful links and information.
+    Use <a href="https://google.com">Google</a> for all other queries ;)
+  encrypted: |
+    welcome {user}, this is an encrypted room, so you may not be able to see messages previously sent here. don't be
+    alarmed.
+
+# which of the above greetings should be used in which rooms? use the exact name of each greeting
+# you've assigned, e.g. 'generic' or 'encrypted'
+greeting_rooms:
+  '!someroomid:server.tld': generic
+  '!someotherroom:server.tld': generic
+  '!myencryptedroomid:server.tld': encrypted
+
+# add a room ID here to send a message to when someone joins the above rooms
+# (optional)
+notification_room: 
+
+# message to send to the notification room when someone joins one of the above rooms:
+join_notification_message: |
+  User <code>{user}</code> has joined <code>{room}</code>.