SquadMusicBot/README.md

SquadMusicbot

Spaghetti code music bot, with support for streaming certain radio streams too.

Requirements

Using Node.js

• Node.js v20 (LTS)
  • Current LTS (Long-Term Support) of Node.js. Should work with most versions shortly before or after (e.g. v18, or v22).
• npm
• TypeScript
  • npm install -g typescript
• ffmpeg
  • Debian/Ubuntu: sudo apt install ffmpeg

Using Docker

• Docker, with Docker Compose (docker-compose-plugin).

Setup

1. Clone the repository
2. Copy config.sample.js to config.js and fill in the values
3. Directly using Node:
   1. Run npm install
   2. Run npm run start
      • Alternatively, deploy it as a pm2 service using npm run deploy
        • Requires you to install pm2: npm install -g pm2
      • For updating the pm2 service after changes, run npm run update
4. Second option is via Docker and Docker Compose:
   1. Copy the docker-compose.example.yml to docker-compose.yml
   2. Run docker compose up -d
   3. For updating the container after changes, run docker compose up -d --build