rizowski/muzik-bot

muzik-bot

Muzik-bot is a competitor of MusicBot. Why? Because when I would try to run MusicBot for an extended amount of time it would crash. With the large number of issues and lack of project support, Muzik-bot was born. With Muzik-bot you will find that it stable and faster than other competitors.

requirements

• Node: 6

Mac OSX

• brew install ffmpeg
• xCode
  • Set developer tools: sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
• Node: 6

Linux

• sudo apt install node-gyp

Getting Started

Below is how to get the bot running either with command line or a docker container.

Roles

Each role is in hierarchy order. Owner has all permissions but mod only has mod + dj permissions.

  owner:
    - player
      - settings
    - cache
      - settings
  mod:
    - player
      - volume
    - cache
      - clean
  dj:
    - help
    - hello
    - player
      - play
      - queued
      - skip
      - stop
      - shuffle

config

The config settings are pretty self explanatory, but in the case that they're not here is a brief overview of what they mean.

{
  player: {
    // Volume of the bot. 0.2 seems to be a comfortable non-ear-blasting level
    volume: 0.2,
  },
  youtube: {
    // Your Youtube api Key (not OAuth 2.0)
    // https://developers.google.com/youtube/registering_an_application
    apiKey: 'YT_API_KEY'
  },
  discord: {
    // The bot's discord token
    // https://github.com/Chikachi/DiscordIntegration/wiki/How-to-get-a-token-and-channel-ID-for-Discord
    token: 'DISCORD_TOKEN'
  },
  streaming: {
    // This is the number of times the bot will send packets to the server.
    // 1 is 1x the amount of bandwidth. 2 is 2x and so on...
    // Not recommended to go above 5
    passes: 2
  },
  permissions: {

  }
};

Node

• Optional: npm i -g nodemon
• git clone git@github.com:rizowski/muzik-bot.git
• cd muzik-bot
• npm i
• npm start or nodemon .

Docker

comming soon...

docker run rizowski/muzik-bot \
  --name muzik-bot \
  -v /local/path/for/config:/usr/src/app/config \
  -v /local/path/for/cache:/usr/src/app/.cache \