Alex/SquadMusicBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
24 Commits 1 Branch 0 Tags 130 KiB
TypeScript 94.2%
JavaScript 4.9%
Dockerfile 0.9%
main
Go to file
Alex Thomassen a68965e8a7
Add yt-dlp proxy support
2024-10-07 16:52:52 +00:00
downloads Initial implementation 2023-01-07 00:23:48 +00:00
interfaces Fix stream command, add reconnect command 2024-10-05 18:10:24 +00:00
services Reintroducing topic handling 2023-01-11 20:40:11 +00:00
.dockerignore Create Dockerfile for bot 2024-06-12 20:06:44 +00:00
.editorconfig Initial implementation 2023-01-07 00:23:48 +00:00
.gitignore Create Dockerfile for bot 2024-06-12 20:06:44 +00:00
config.sample.js Add yt-dlp proxy support 2024-10-07 16:52:52 +00:00
docker-compose.example.yml Create Dockerfile for bot 2024-06-12 20:06:44 +00:00
Dockerfile Create Dockerfile for bot 2024-06-12 20:06:44 +00:00
index.ts Add yt-dlp proxy support 2024-10-07 16:52:52 +00:00
package-lock.json Improve stream handling 2024-10-07 16:46:24 +00:00
package.json Improve stream handling 2024-10-07 16:46:24 +00:00
README.md Update README 2024-10-05 18:48:25 +00:00
tsconfig.json Initial implementation 2023-01-07 00:23:48 +00:00

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