mrmBot-Matrix/README.md

30 lines
1.7 KiB
Markdown
Raw Normal View History

2022-07-26 18:48:37 +00:00
# <img src="https://github.com/esmBot/esmBot/raw/master/docs/assets/esmbot.png" width="128"> esmBot
2022-09-07 02:54:15 +00:00
[![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)
2019-09-13 20:02:41 +00:00
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.
2019-09-13 20:02:41 +00:00
## 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
2019-09-13 20:02:41 +00:00
## Usage
You can invite the main instance of esmBot to your server using this link: https://esmbot.net/invite
2019-09-13 20:02:41 +00:00
A command list can be found [here](https://esmbot.net/help.html).
2019-09-13 20:02:41 +00:00
If you want to self-host the bot, a guide can be found [here](https://docs.esmbot.net/setup).
2020-09-01 22:23:43 +00:00
2019-09-13 20:02:41 +00:00
## Credits
Icon by [Steel](https://twitter.com/MintBurrow).
All images, sounds, and fonts are copyright of their respective owners.