Update hello world example and add config example

example-plugin/build.sh

@@ -1,2 +0,0 @@
-#!/bin/bash
-zip -9r helloworld.mbp  maubot.yaml helloworld.py

examples/README.md

@@ -0,0 +1,6 @@
+# Maubot examples
+All examples are published under the [MIT license](LICENSE).
+
+* [Hello World](helloworld/) - Very basic event handling bot that responds "Hello, World!" to all messages.
+* [Echo bot](https://github.com/maubot/echo) - Basic command handling bot with !echo and !ping commands
+* [Config example](config/) - Simple example of using a config file

examples/config/base-config.yaml

@@ -0,0 +1,2 @@
+# Message to send when user sends !getmessage
+message: Default configuration active

examples/config/configurablebot.py

@@ -0,0 +1,25 @@
+from typing import Type
+
+from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper
+from maubot import Plugin, MessageEvent
+from maubot.handlers import command
+
+
+class Config(BaseProxyConfig):
+    def do_update(self, helper: ConfigUpdateHelper) -> None:
+        helper.copy("message")
+
+
+class DatabaseBot(Plugin):
+    async def start(self) -> None:
+        await super().start()
+        self.config.load_and_update()
+
+    @classmethod
+    def get_config_class(cls) -> Type[BaseProxyConfig]:
+        return Config
+
+    @command.new("getmessage")
+    async def handler(self, event: MessageEvent) -> None:
+        if event.sender != self.client.mxid:
+            await event.reply(self.config["message"])

examples/config/maubot.yaml

@@ -0,0 +1,12 @@
+maubot: 0.1.0
+id: xyz.maubot.databasebot
+version: 1.0.0
+license: MIT
+modules:
+- configurablebot
+main_class: ConfigurableBot
+database: false
+
+# Instruct the build tool to include the base config.
+extra_files:
+- base-config.yaml

examples/helloworld/helloworld.py

@@ -1,14 +1,10 @@
-from maubot import Plugin, MessageEvent
 from mautrix.types import EventType
+from maubot import Plugin, MessageEvent
+from maubot.handlers import event
 
 
 class HelloWorldBot(Plugin):
-    async def start(self) -> None:
+    @event.on(EventType.ROOM_MESSAGE)
-        self.client.add_event_handler(self.handler, EventType.ROOM_MESSAGE)
-
-    async def stop(self) -> None:
-        self.client.remove_event_handler(self.handler, EventType.ROOM_MESSAGE)
-
     async def handler(self, event: MessageEvent) -> None:
         if event.sender != self.client.mxid:
             await event.reply("Hello, World!")

examples/helloworld/maubot.yaml

@@ -5,7 +5,7 @@
 maubot: 0.1.0
 
 # The unique ID for the plugin. Java package naming style. (i.e. use your own domain, not xyz.maubot)
-id: xyz.maubot.example
+id: xyz.maubot.helloworld
 
 # A PEP 440 compliant version string.
 version: 1.0.0