Adix is a high quality music bot meant to benefit the various communities on Discord by streaming music in a voice channel to entertain users, bringing music experience to a whole new level. Immerse yourself in your favourite music, streamed directly to your Discord server in high quality.
Languages
- TypeScript
Internal Software
- discord.js (Discord API wrapper)
- @lavacord/discord.js (Lavacord) (Lavalink wrapper)
- chalk (Logging styling)
- dotenv (Environment variables)
- eslint (Linting)
- husky (Pre commit actions)
- nodemon (Development assistance)
- tsc (TypeScript compiler)
External Software
- Lavalink (Music player)
To set up Adix on your device, you can choose from cloning, forking or downloading the code zip file. Once you have the code for Adix, run npm install if you use npm or yarn install if you use yarn. After installing the dependencies, rename the .env.example file to .env and edit placeholder values for the environment variables accordingly. The Lavalink environment variables (LAVALINK_[property]) values here (hostname should be the address value). adix.config.js does not need to be altered, but will be required for Adix to function.
Adix will require an external Lavalink server to be running in order to start itself. If you decide to use the Lavalink server within the project, you will need to be running both the server and bot simutaneously on your host. Note: the server must be running first before starting the bot.
You can find Adix's Lavalink server GitHub repository, configured with Docker, here.
To run the bot:
# npm
npm run start
# yarn
yarn start(Note: do not use the server script unless you have a Lavalink server folder on your local instance of Adix with a Lavalink.jar and application.yml file in its root)
To deploy to production using the provided docker compose file you need to set the following environment variables.
TOKENCLIENT_IDGUILD_IDWEBHOOK
If you need any assistance, feel free to contact tncz#4129 on Discord.
This project is licensed under the GPL-3.0 License.