Welcome to Simple-Matrix-Bot-Lib’s documentation!

Warning! This documentation is currently unmaintained and may be out of date. Updated documentation coming soon with simplematrixbotlib version 3. Simple-Matrix-Bot-Lib is a Python 3 library for quickly building Matrix bots. It is based on the matrix-nio Python library. To begin using Simple-Matrix-Bot-Lib, check out the quickstart.

Getting Started

• Quickstart
  • Install the simplematrixbotlib package
  • Obtain Matrix login credentials
  • Create the bot
• Examples
  • A Basic Echo Bot
  • An Echo Bot with Encryption and Verification Support
  • A “High-Five” Bot
  • A Rock Paper Scissors Bot
  • A Reaction Echo Bot
  • Echo Bot within a Docker Container
  • Echo Bot using Config Files
  • Echo Bot with Allow/Blocklist Config File
  • Using Allow/Blocklist Interactively + Config File
  • Bot using Custom Option Config File
• Usage with Docker
  • Install Docker
  • Prepare the bot code
  • Write the Dockerfile
  • Build the Docker container
  • Create and run Docker image

Reference

• Manual
  • Installation
  • Importing
  • E2E Encryption
  • Usage of Creds class
  • Usage of Config class
  • Usage of Bot class
  • Usage of Listener class
  • Usage of Match and MessageMatch classes
  • Usage of Api class