Bluemedia/muse
1
0
Fork 0
mirror of https://github.com/BluemediaGER/muse.git synced 2024-11-10 03:55:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse source
This commit is contained in:
Max Isom 2022-02-05 16:59:29 -05:00
parent 50c047f589
commit e7d0c96f8a
No known key found for this signature in database
GPG key ID: 25C9B1A7F6798880
2 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
.github/hero.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 225 KiB

8
README.md
View file

@ -4,6 +4,8 @@
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). 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).
![Hero graphic](.github/hero.png)
## Features ## Features
- 🎥 Livestreams - 🎥 Livestreams
@ -16,10 +18,6 @@ Muse is a **highly-opinionated midwestern self-hosted** Discord music bot **that
- ✍️ Written in TypeScript, easily extendable - ✍️ Written in TypeScript, easily extendable
- ❤️ Loyal Packers fan - ❤️ 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 ## 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: 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:
@ -92,4 +90,4 @@ By default, Muse limits the total cache size to around 2 GB. If you want to chan
### Bot-wide commands ### 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 propogate.) To do this, set the environment variable `REGISTER_COMMANDS_ON_BOT` to `true`. 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`.