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

Updated readme to point to new setup guide

This commit is contained in:
TheEssem 2020-12-08 09:59:57 -06:00
parent 8df322ae04
commit df5ed094a8
1 changed files with 1 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
readme.md
View File

@ -11,25 +11,7 @@ You can invite the bot to your server using this link: https://projectlounge.pw/
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, 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
```
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`.
If you need any help with setting up the bot locally, feel free to ask in the #self-hosting channel on the [esmBot Support server](https://discord.gg/vfFM7YT).
If you want to self-host the bot, a guide can be found [here](https://github.com/esmBot/esmBot/wiki/Setup).
## Credits
Icon by [Stellio](https://twitter.com/SteelStellio).