mrmBot-Matrix/readme.md

# <img src="https://github.com/esmBot/esmBot/raw/master/esmbot.png" width="128"> esmBot
[![esmBot Support](https://discordapp.com/api/guilds/592399417676529688/embed.png)](https://discord.gg/vfFM7YT) ![GitHub license](https://img.shields.io/github/license/esmBot/esmBot.svg)


esmBot is an easily-extendable, multipurpose, and entertainment-focused Discord bot made using [Eris](https://abal.moe/Eris/) with image, music, and utility commands, alongside many others.

[![Top.gg](https://top.gg/api/widget/429305856241172480.svg)](https://top.gg/bot/429305856241172480)

## Usage
You can invite the bot to your server using this link: https://projectlounge.pw/invite

A command list can be found [here](https://projectlounge.pw/esmBot/help.html).

The bot is only supported on Linux/Unix-like operating systems. If you want to run it locally for testing purposes, you should install ImageMagick (version >=7), FFmpeg, MongoDB, libstb and the Microsoft core fonts:

```shell
# On most Debian/Ubuntu-based distros you will need to build ImageMagick from source instead of installing from apt/similar package managers.
# Instructions to do so can be found here: https://imagemagick.org/script/install-source.php
sudo apt-get install imagemagick ffmpeg mongodb ttf-mscorefonts-installer libstb-dev
```
You'll also need to build and install [zxing-cpp](https://github.com/nu-book/zxing-cpp) from source.

After that, you should install the rest of the dependencies using npm:

```shell
npm install
```

And set up Lavalink: https://github.com/Frederikam/Lavalink#server-configuration

Finally, fill in the info inside `.env.example`, rename it to `.env`, and run `app.js`.

## Credits
Icon by [Stellio](https://twitter.com/SteelStellio).
All images, sounds, and fonts are copyright of their respective owners.
Preliminary DM support, update URLs to point to new repo link 2020-09-01 22:10:19 +00:00			`# <img src="https://github.com/esmBot/esmBot/raw/master/esmbot.png" width="128"> esmBot`
			`[![esmBot Support](https://discordapp.com/api/guilds/592399417676529688/embed.png)](https://discord.gg/vfFM7YT) ![GitHub license](https://img.shields.io/github/license/esmBot/esmBot.svg)`
Initial commit 2019-09-13 20:02:41 +00:00

A bit of cleanup 2020-07-28 14:38:55 +00:00			`esmBot is an easily-extendable, multipurpose, and entertainment-focused Discord bot made using [Eris](https://abal.moe/Eris/) with image, music, and utility commands, alongside many others.`
Initial commit 2019-09-13 20:02:41 +00:00
Updated readme, check if bot has permissions to send messages 2019-12-16 23:14:29 +00:00			`[![Top.gg](https://top.gg/api/widget/429305856241172480.svg)](https://top.gg/bot/429305856241172480)`

Initial commit 2019-09-13 20:02:41 +00:00			`## Usage`
Updated readme, check if bot has permissions to send messages 2019-12-16 23:14:29 +00:00			`You can invite the bot to your server using this link: https://projectlounge.pw/invite`
Initial commit 2019-09-13 20:02:41 +00:00
Added homebrew and emote, added command params to help and a help webpage generator, updated packages/readme 2019-12-05 16:58:46 +00:00			`A command list can be found [here](https://projectlounge.pw/esmBot/help.html).`
Initial commit 2019-09-13 20:02:41 +00:00
Change readme to reflect switch back to MongoDB 2020-08-13 13:51:18 +00:00			`The bot is only supported on Linux/Unix-like operating systems. If you want to run it locally for testing purposes, you should install ImageMagick (version >=7), FFmpeg, MongoDB, libstb and the Microsoft core fonts:`
Initial commit 2019-09-13 20:02:41 +00:00
			```shell
Updated readme to include mscorefonts 2020-06-06 20:51:45 +00:00			`# On most Debian/Ubuntu-based distros you will need to build ImageMagick from source instead of installing from apt/similar package managers.`
Upgraded to ImageMagick 7, modified many commands to use fx operators instead of identify 2020-03-03 21:20:03 +00:00			`# Instructions to do so can be found here: https://imagemagick.org/script/install-source.php`
Change readme to reflect switch back to MongoDB 2020-08-13 13:51:18 +00:00			`sudo apt-get install imagemagick ffmpeg mongodb ttf-mscorefonts-installer libstb-dev`
Initial commit 2019-09-13 20:02:41 +00:00			```
Update installation instructions It appears libstb and zxing-cpp are required (for the QR module), but were not included in the dependencies. 2020-08-13 01:34:20 +00:00			`You'll also need to build and install [zxing-cpp](https://github.com/nu-book/zxing-cpp) from source.`
Initial commit 2019-09-13 20:02:41 +00:00
			`After that, you should install the rest of the dependencies using npm:`

			```shell
			`npm install`
			```

Huge sound player overhaul using Lavalink, added boom, removed prunejuice, boat, and bus, re-encoded audio files with ffmpeg 2020-06-27 17:18:26 +00:00			`And set up Lavalink: https://github.com/Frederikam/Lavalink#server-configuration`

Added basic twitter bot and spin, updated readme, other various changes 2019-11-15 16:59:50 +00:00			Finally, fill in the info inside `.env.example`, rename it to `.env`, and run `app.js`.

Initial commit 2019-09-13 20:02:41 +00:00			`## Credits`
Fix sanitization with homebrew, changed links to point to the new help link 2019-12-06 14:55:30 +00:00			`Icon by [Stellio](https://twitter.com/SteelStellio).`
Added homebrew and emote, added command params to help and a help webpage generator, updated packages/readme 2019-12-05 16:58:46 +00:00			`All images, sounds, and fonts are copyright of their respective owners.`