🎓Music Master Tutorial

A heavy breakdown on the Music Plugin (lots of scrolling here, check the sidebar!)

This configuration takes place in the /configuration/music.json file!

Key words:

Boolean: A true or false switch

String: An assortment of "text" or "numbers" like this

Numbers: Just numbers!

Array: Strings or Numbers["in", "a", "pattern", "like", "this"]

Welcome!

Here we'll go over the Music Plugin setup in its entirety, with brief (or not so brief!) explanations and descriptions on things.

I made sure to separate everything the best possible so that the sidebar has a quick reference to what you're looking for.

Feedback is welcome!

If you think something is missing, or needs a bit more work, then make sure to leave us a note at our support server!

---

Where do I start?

If you own the Lavalink Addon, your settings will be overridden unless you have use_own_lavalink set to true.

What am I looking for?

For information on what Lavalink is, check that out here!

What it comes down to really is that this configuration file doesn't have much to break or set up. Its essentially just a Lavalink node(s) lookup for Athena.

// Lavalink nodes for our music system. Please follow following format:
// { 
//     name: '<random name>',
//     url: '<ip>:<port>',
//     auth: '<password>',
// },

Do I have to sort them?

Not at all! As the Music configuration states:

// You can provide multiple nodes and the bot will select the one with
// lowest traffic for best sound quality (Array)

Which essentially takes the guesswork out of you having to figure out which one's higher quality, closer to you in terms of latency and how fast it is in terms of speed.

How do I set it up?

Simply drop your node information into the config file! Like this!

        lavalink_nodes: [
            {
			    name: 'Lavalink',
			    url: 'XXX.XXX.XXX.XXX:XXXX',
			    auth: 'password',
            },
        ],

This means that Athena will try to connect to a Lavalink node with xxx.xxx.xxx.xxx as its address, XXXX as its port, then attempt to authenticate to it with 'password' as its password. the name itself doesn't matter because it's only for your own reference.

---

Basic Configuration Tutorial

"default volume"

Whenever a new music session is being started the bot will start playing music with the following volume value set (Number)

Default: 60,

A Number statement, this simply controls how much volume Athena starts out with each time it connects to your channel. This can go up to 1000%. Yes. Seriously. Don't do it though.

Don't try to use letters in this. It breaks.

Examples:

default_volume: 60 makes Athena join voice channels at 60% volume automatically &#xNAN;(please don't try and blow your eardrums out)

What if I want a music channel?

This is an optional module!

You can set it to false to have music commands work anywhere you want, or set it totrue it and lock down music commands to the channels you set the IDs for.

You can set up a music channel by whitelisting channels so they are the only ones that can have music commands used in! The configuration for that is:

        whitelist_channels: {
            // Whether this feature should be enabled (Boolean)
            enabled: false,
            // List of channel ids where all music commands should be available (Array)
            channels: ["CHANNEL ID HERE", "CHANNEL ID HERE", "CHANNEL ID HERE"],
        },

---

What if I self-host Lavalink?

This is an optional tutorial!

Keep in mind, we want to make things as easy as possible for people, so we encourage alternative methods of getting Lavalink working, but this is here for the sake of transparency and fairness to customers.

What do I do?

If you have your own Lavalink server, you can set it up at this point!

        // If you own the "lavalink" addon the system is automatically being redirected
        // to our server even if you have a configured lavalink node above. If you wish
        // to use your own lavalink server even though you own the lavalink addon set
        // this value to false (Boolean)
        use_own_lavalink: false,
    },
}

By default, it is set to false, but flipping it to true makes the bot take the nodes you put in earlier into account, and try to connect to your own servers as opposed to Iynx's Lavalink host.

What if I want to do this?

There's a Lavalink Master Tutorial available now!

---

Congrats!

You're all done here! Now you can move onto other plugins and see how they work!