mrmBot-Matrix/README.md
2023-03-17 02:33:57 -04:00

1.5 KiB

mrmBot-matrix

mrmBot-matrix is a free and open-source Matrix bot designed to entertain your server. It's made using matrix-js-sdk and comes with image and utility commands out of the box.

Features

  • Powerful, efficient, and performant image processing powered by libvips
  • Lots of image manipulation and processing commands out of the box
  • Handling of output images larger than 8MB via a local web server
  • Optional WebSocket/HTTP-based external image API with load balancing
  • Server tags system for saving/retrieving content
  • Low RAM and CPU usage when idle
  • Support for multiple database backends (PostgreSQL and SQLite backends included)
  • PM2-based cluster/shard handling
  • Flexible command handler allowing you to create new commands by adding script files

Usage

At the present moment you need to self-host mrmBot-matrix if you wish to use it in your matrix rooms.

A command list for esmBot (which is the base for mrmBot-matrix) can be found here.

If you want to self-host the bot, a guide for esmBot (which is the base for mrmBot-matrix) can be found here.

Credits

esmBot by Essem Icon by pastarru. All images, sounds, and fonts are copyright of their respective owners.