srgooglo
/
RemoteSoundpadBot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added readme

This commit is contained in:
srgooglo 2022-10-08 23:15:45 +02:00
parent 0f56c052ae
commit 01535ab341
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Remote Soundpad Bot
### For real soundpad users enjoyers
This is a bot for Discord that allows you to play sound from a URL to a remote machine.
## Requirements (Only tested on linux)
- NodeJS >= 14
- ffmpeg
- yt-dlp
- mpg123
## Installation
- Clone the repository
- Install the dependencies with `npm install` or `yarn install`
- Copy the `.env-example` file to `.env` and fill the fields
> You will need to create a Discord application and a bot user for it. You can find more
information about it [here](https://discordjs.guide/preparations/setting-up-a-bot-application.html).
- Run the bot with `npm start` or `yarn start`