mirror of
https://github.com/BluemediaGER/muse.git
synced 2024-09-19 19:15:29 +02:00
60376d4f57
Co-authored-by: Max Isom <codetheweb@users.noreply.github.com> Co-authored-by: Max Isom <hi@maxisom.me>
101 lines
3.9 KiB
Markdown
101 lines
3.9 KiB
Markdown
<p align="center">
|
||
<img width="250" height="250" src="https://raw.githubusercontent.com/codetheweb/muse/master/.github/logo.png">
|
||
</p>
|
||
|
||
🚨: v1.0.0 was a breaking change. Please take a look at the [release notes](https://github.com/codetheweb/muse/releases/tag/v1.0.0) for upgrade instructions
|
||
|
||
------
|
||
|
||
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
|
||
|
||
## 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` can be acquired [here](https://discordapp.com/developers/applications) by creating a 'New Application', then going to 'Bot'.
|
||
- `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` can be acquired [here](https://developer.spotify.com/dashboard/applications) with 'Create a Client ID'.
|
||
- `YOUTUBE_API_KEY` can be acquired by [creating a new project](https://console.developers.google.com) 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. Muse will DM the server owner after it's added with setup instructions.
|
||
|
||
A 64-bit OS is required to run Muse.
|
||
|
||
### Versioning
|
||
|
||
The `master` branch acts as the developing / bleeding edge branch and is not guaranteed to be stable.
|
||
|
||
When running a production instance, I recommend that you use the [latest release](https://github.com/codetheweb/muse/releases/).
|
||
|
||
|
||
### 🐳 Docker
|
||
|
||
There are a variety of image tags available:
|
||
- `:2`: versions >= 2.0.0
|
||
- `:2.1`: versions >= 2.1.0 and < 2.2.0
|
||
- `:2.1.1`: an exact version specifier
|
||
- `:latest`: whatever the latest version is
|
||
|
||
(Replace empty config strings with correct values.)
|
||
|
||
```bash
|
||
docker run -it -v "$(pwd)/data":/data -e DISCORD_TOKEN='' -e SPOTIFY_CLIENT_ID='' -e SPOTIFY_CLIENT_SECRET='' -e YOUTUBE_API_KEY='' codetheweb/muse:latest
|
||
```
|
||
|
||
This starts Muse and creates a data directory in your current directory.
|
||
|
||
**Docker Compose**:
|
||
|
||
```yaml
|
||
version: '3.4'
|
||
|
||
services:
|
||
muse:
|
||
image: codetheweb/muse:latest
|
||
restart: always
|
||
volumes:
|
||
- ./muse:/data
|
||
environment:
|
||
- DISCORD_TOKEN=
|
||
- YOUTUBE_API_KEY=
|
||
- SPOTIFY_CLIENT_ID=
|
||
- SPOTIFY_CLIENT_SECRET=
|
||
```
|
||
|
||
### Node.js
|
||
|
||
**Prerequisites**:
|
||
* Node.js (16.x is recommended because it's the current LTS version)
|
||
* ffmpeg
|
||
|
||
1. `git clone https://github.com/codetheweb/muse.git && cd muse`
|
||
2. Copy `.env.example` to `.env` and populate with values
|
||
3. I recommend checking out a tagged release with `git checkout v[latest release]`
|
||
4. `yarn install` (or `npm i`)
|
||
5. `yarn start` (or `npm run start`)
|
||
|
||
**Note**: if you're on Windows, you may need to manually set the ffmpeg path. See [#345](https://github.com/codetheweb/muse/issues/345) for details.
|
||
|
||
## ⚙️ Additional configuration (advanced)
|
||
|
||
### Cache
|
||
|
||
By default, Muse limits the total cache size to around 2 GB. If you want to change this, set the environment variable `CACHE_LIMIT`. For example, `CACHE_LIMIT=512MB` or `CACHE_LIMIT=10GB`.
|
||
|
||
### Bot-wide commands
|
||
|
||
If you have Muse running in a lot of guilds (10+) you may want to switch to registering commands bot-wide rather than for each guild. (The downside to this is that command updates can take up to an hour to propagate.) To do this, set the environment variable `REGISTER_COMMANDS_ON_BOT` to `true`.
|