SquadMusicBot/README.md

23 lines
583 B
Markdown
Raw Normal View History

2023-01-07 00:23:48 +00:00
# SquadMusicbot
Spaghetti code music bot to replace the garbage that's SinusBot.
## Requirements
- Node.js v19
2023-01-11 20:40:11 +00:00
- Node.js v18 LTS should work as well, but it was developed on v19.
2023-01-07 00:23:48 +00:00
- npm
- TypeScript
2023-01-07 15:34:57 +00:00
- `npm install -g typescript`
- ffmpeg
- Debian/Ubuntu: `sudo apt install ffmpeg`
2023-01-07 00:23:48 +00:00
## Setup
1. Clone the repository
2023-01-07 15:34:57 +00:00
2. Copy `config.sample.js` to `config.js` and fill in the values
3. Run `npm install`
4. Run `npm run start`
2023-01-11 20:40:11 +00:00
- Alternatively, deploy it as a `pm2 service` using `npm run deploy`
- For updating the pm2 service after changes, run `npm run update`