murm/mrmBot-Matrix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fixed up readme

Browse source
This commit is contained in:
murm 2023-03-17 02:29:12 -04:00
parent 7d45de0ee3
commit 6068facdfd
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,29 +1,25 @@
# <img src="https://gitdab.com/murm/mrmBot-matrix/raw/master/docs/assets/mrmbot.gif" width="128"> esmBot
[![esmBot Support](https://discordapp.com/api/guilds/592399417676529688/embed.png)](https://discord.gg/esmbot) ![GitHub license](https://img.shields.io/github/license/esmBot/esmBot.svg)
# <img src="https://gitdab.com/murm/mrmBot-matrix/raw/master/docs/assets/mrmbot.gif" width="128"> mrmBot-matrix
esmBot is a free and open-source Discord bot designed to entertain your server. It's made using [Oceanic](https://oceanic.ws) and comes with image, music, and utility commands out of the box.
mrmBot-matrix is a free and open-source Matrix bot designed to entertain your server. It's made using [matrix-js-sdk](https://github.com/matrix-org/matrix-js-sdk) and comes with image and utility commands out of the box.
## Features
- Powerful, efficient, and performant image processing powered by [libvips](https://github.com/libvips/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
- Music and sound playback from many different configurable sources via [Lavalink](https://github.com/freyacodes/Lavalink)
- Server tags system for saving/retrieving content
- Low RAM and CPU usage when idle
- Support for slash/application commands and classic, prefix-based message commands
- Support for multiple database backends (PostgreSQL and SQLite backends included)
- [PM2](https://pm2.keymetrics.io)-based cluster/shard handling
- Flexible command handler allowing you to create new commands by adding script files
## Usage
You can invite the main instance of esmBot to your server using this link: https://esmbot.net/invite
At the present moment you need to self-host mrmBot-matrix if you wish to use it in your matrix rooms.
A command list can be found [here](https://esmbot.net/help.html).
A command list for esmBot (which is the base for mrmBot-matrix) can be found [here](https://esmbot.net/help.html).
If you want to self-host the bot, a guide can be found [here](https://docs.esmbot.net/setup).
If you want to self-host the bot, a guide for esmBot (which is the base for mrmBot-matrix) can be found [here](https://docs.esmbot.net/setup).
## Credits
Icon by [Steel](https://twitter.com/MintBurrow).
Icon by [pastarru](https://twitter.com/pastarru).
All images, sounds, and fonts are copyright of their respective owners.