Simple-Matrix-Bot-Lib
latest

Getting Started

  • Quickstart
  • Examples
  • Usage with Docker

Reference

  • Manual
Simple-Matrix-Bot-Lib
  • »
  • Welcome to Simple-Matrix-Bot-Lib’s documentation!
  • Edit on GitHub

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

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
    • 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
  • 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
    • Usage of Creds class
    • Usage of Config class
    • Usage of Bot class
    • Usage of Listener class
    • Usage of Match and MessageMatch classes
    • Usage of the Api class
Next

© Copyright 2021, KrazyKirby99999. Revision 1c1773f6.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
seo
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds