Bluemedia/muse
1
0
Fork 0
mirror of https://github.com/BluemediaGER/muse.git synced 2024-11-09 19:55:28 +01:00
Code Issues Packages Projects Releases Wiki Activity
🎧 a self-hosted midwestern Discord music bot that doesn't suck
306 commits 1 branch 0 tags 3.1 MiB
TypeScript 99.2%
Dockerfile 0.8%
Find a file
dependabot-preview[bot] b0a60ccd29
Bump got from 11.8.1 to 11.8.2 
Bumps [got](https://github.com/sindresorhus/got) from 11.8.1 to 11.8.2.
- [Release notes](https://github.com/sindresorhus/got/releases)
- [Commits](https://github.com/sindresorhus/got/compare/v11.8.1...v11.8.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-02-26 10:47:34 +00:00
.github Fix cache behavior 2021-01-07 11:52:10 -06:00
src Use yarn, remove manual type for package 2020-12-03 16:08:07 -05:00
.dockerignore Switch back to NPM, optimize Dockerfile 2020-10-24 15:19:35 -04:00
.env.example Test logo centering in README 2020-03-24 17:25:33 -05:00
.gitignore Switch back to NPM, optimize Dockerfile 2020-10-24 15:19:35 -04:00
Dockerfile Copy yarn.lock when building 2021-01-07 11:54:32 -06:00
LICENSE Initial commit 2020-03-07 17:04:01 -06:00
nodemon.json Inital commit 2020-03-09 11:57:39 -05:00
package.json Bump got from 11.8.1 to 11.8.2 2021-02-26 10:47:34 +00:00
README.md Change list ordering 2020-03-24 18:34:33 -05:00
tsconfig.json Bump dependencies and add typing event handler 2020-03-27 17:14:08 -05:00
yarn.lock Bump got from 11.8.1 to 11.8.2 2021-02-26 10:47:34 +00:00

README.md

Muse is a highly-opinionated midwestern self-hosted Discord music bot that doesn't suck. It's made for small to medium-sized Discord servers/guilds (think about a group the size of you, your friends, and your friend's friends).

Features

  • 🎥 Livestreams
  • ⏩ Seeking within a song/video
  • 💾 Local caching for better performance
  • 📋 No vote-to-skip - this is anarchy, not a democracy
  • ↔️ Autoconverts playlists / artists / albums / songs from Spotify
  • ↗️ Users can add custom shortcuts (aliases)
  • 1️⃣ Muse instance supports multiple guilds
  • ✍️ Written in TypeScript, easily extendable
  • ❤️ Loyal Packers fan

Design Philosophy

I believe it makes much more sense to let Discord handle user permissions (whenever possible) rather than building them into a bot and adding additional complexity. Instead of only allowing users with a certain role to control Muse, Muse allows anyone who has access to its bound channel to control it. Instead of specifying the owner as a user ID in the config, Muse simply looks at the guild owner.

Running

Muse is written in TypeScript. You can either run Muse with Docker (recommended) or directly with Node.js. Both methods require API keys passed in as environment variables:

  • DISCORD_TOKEN and DISCORD_CLIENT_ID can be acquired here by creating a 'New Application', then going to 'Bot'.
  • SPOTIFY_CLIENT_ID and SPOTIFY_CLIENT_SECRET can be acquired here with 'Create a Client ID'.
  • YOUTUBE_API_KEY can be acquired by creating a new project in Google's Developer Console, enabling the YouTube API, and creating an API key under credentials.

Muse will log a URL when run. Open this URL in a browser to invite Muse to your server.

Docker

(Replace empty config strings with correct values.)

docker run -it -v "$(pwd)/data":/data -e DISCORD_TOKEN='' -e DISCORD_CLIENT_ID='' -e SPOTIFY_CLIENT_ID='' -e SPOTIFY_CLIENT_SECRET='' -e YOUTUBE_API_KEY='' codetheweb/muse

This starts Muse and creates a data directory in your current directory.

Docker Compose:

version: '3.4'

services:
  muse:
    image: codetheweb/muse
    restart: always
    volumes:
      - ./muse:/data
    environment:
      - DISCORD_TOKEN=
      - DISCORD_CLIENT_ID=
      - YOUTUBE_API_KEY=
      - SPOTIFY_CLIENT_ID=
      - SPOTIFY_CLIENT_SECRET=

Node.js

Prerequisites: Node.js, ffmpeg

  1. git clone https://github.com/codetheweb/muse.git && cd muse
  2. Copy .env.example to .env and populate with values
  3. yarn install (or npm i)
  4. yarn build (or npm run build)
  5. yarn start (or npm run start)