Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.87 KB

README.md

File metadata and controls

36 lines (24 loc) · 1.87 KB

Codacy Badge

Sneyra

Sneyra is a music bot (yeah, another bot in this world) built on top of Klasa, and uses Discord.js to connect to the Discord API.

Features

  • All basic music bot commands, included skip prompting (based on the 40% of users connected to the voice channel, after 4 users).
  • An echo command, because, why not?
  • Clean code, easy to modify. Fully modular and classbased.
  • Full Music Handler interface and caching, make sure she replies 'smartly'!

Requirements

  • git command line (Windows|Linux|MacOS) installed
  • node Version 8.1.0 or higher
  • ffmpeg: npm install --global ffmpeg-binaries
  • node-opus: npm install node-opus (alternatively you can use opusscript, but it's very bad for production, has memoryleaks and stream/quality issues).
  • A good network connection.

Downloading

In a command prompt in your projects folder (wherever that may be) run the following:

git clone https://github.com/kyranet/Sneyra

Once finished:

  • In the folder from where you ran the git command, run cd Sneyra and then run npm install
  • Rename config.json.example to config.json
  • Edit config.json and enter your bot token and the YouTube Search API token.
  • NEVER UPLOAD THIS FILE WITH YOUR TOKENS ANYWHERE, TO DO SO, YOU ARE LETTING OTHER PEOPLE USE THE TOKEN TO DESTROY ALL THE GUILDS YOUR BOT IS IN. IF YOU DID, RESET YOUR TOKEN IN DISCORD'S APPLICATION PAGE.