diff --git a/README.md b/README.md index 64d21f0..6e29c24 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,12 @@ supposed to be. # features +## greet new users on joining a room + +configure your bot to send a custom greeting to users whenever they join a room! configuration file provides a greeting +map (define multiple greetings each with an identifier) and then a configuration of which rooms to greet users in, and +which greeting message the bot should send them. + ## activity tracking and reporting tracks the last message timestamp of a user across any room that the bot is in, and generates a simple report. intended @@ -52,6 +58,4 @@ to manage room admins. the bot will also invite other users to these new rooms a install this like any other maubot plugin: zip the contents of this repo into a file and upload via the web interface, or use the `mbc` utility to package and upload to your maubot server. -be sure to give your bot permission to kick people from all rooms, otherwise management features will not work! for -more robust management, check out the [welcome](https://github.com/williamkray/maubot-welcome), -[join](https://github.com/williamkray/maubot-join) plugins as well. +be sure to give your bot permission to kick people from all rooms, otherwise management features will not work! diff --git a/base-config.yaml b/base-config.yaml index d57d0e0..61872e0 100644 --- a/base-config.yaml +++ b/base-config.yaml @@ -44,7 +44,7 @@ greetings: 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' +# you've assigned, e.g. 'generic' or 'encrypted'. you must use the room ID here. greeting_rooms: '!someroomid:server.tld': generic '!someotherroom:server.tld': generic diff --git a/maubot.yaml b/maubot.yaml index 51dc571..c54d19b 100644 --- a/maubot.yaml +++ b/maubot.yaml @@ -1,6 +1,6 @@ maubot: 0.1.0 id: org.jobmachine.communitybot -version: 0.0.2 +version: 0.1.0 license: MIT modules: - community