This is the codebase for the rewrite of Nyx, written with Eris Oceanic.js and a lot of energy drinks.
THIS CODE IS BASICALLY A MIXTURE OF MY CURRENT KNOWLEDGE IN JAVASCRIPT AND MY KNOWLEDGE YEARS BACK. IT'S A MESS. THAT'S WHY NYX V3 IS IN DEVELOPMENT, I ONLY OPEN-SOURCED THIS FOR TRANSPARENCY AND POTENTIALLY IF PEOPLE WANTED TO SELF-HOST THEIR OWN INSTANCES.
Make sure that you have Node.js & NPM (to run the bot itself), FFmpeg (for music support), and Git (for self-updating support) installed.
- Clone the repository through the commandline by running
git clone https://github.com/nyx-bot/Nyx -b v2
in the preferred directory of your choice. - Copy
config.example.json
intoconfig.json
and edit it accordingly.
- Create a bot token on Discord's official developer page
- Don't worry about Top.gg & Genuis API keys here as they're handled by the musicAPI.
- [OPTIONAL] Set up and configure a nyxCache system from this repository
- [OPTIONAL] Set up and configure the musicAPI from this repository
- Install packages with
npm install
. - Run
index.js
with your favorite Node.js process manager.
Personally, I'd use PM2 to manage the instance. Nyx also fully supports their web dashboard placeholders thing or whatever it's called.