Formatting update

Author: RobertAndion

README.md

@@ -4,11 +4,16 @@ If you come across some issues feel free to post them in the issues.
 
 ### General Setup
 To be written.
+### Node must be version 12!
+Ubuntu node install:
+curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
+sudo apt-get install -y nodejs
 
 ## COMMAND DOCUMENTATION:
 ### NOTE: 
 Anything after ! is a command name and the prefix ! is needed to run the command,
 the items in <> are the function arguments and anything with OPTIONAL is as it sounds.
+
 ```
 !play <SONG-NAME>
 ```

commands/ytdltie.js

@@ -1,10 +1,11 @@
+const ytdl = require('ytdl-core');
+const ytSearch = require('yt-search');
 /*
-Start of an object wrapper for the ytdl class
-and a queue system for a nodeJS music bot.
+Start of an object wrapper for the ytdl class and a queue system for a nodeJS music bot.
+This is a core file for the bot but also acts as an interface to the ytdl code and simplifies it in
+the main index page.
 */
 
-const ytdl = require('ytdl-core');
-const ytSearch = require('yt-search');
 
 /*ffmpeg_options = { // Keep bot from dying if it cuts out, could pass this in play, hard coded for now.
     'options': '-vn',
@@ -144,6 +145,8 @@ module.exports = class ytdltie {
             return;
         }
         const stream = ytdl(song.url, {filter: 'audioonly',options: '-vn', before_options: "-reconnect 1 -reconnect_streamed 1 -reconnect_delay_max 5", highWaterMark: 1<<25, maxReconnect: 10});
+        // highWaterMark is in bytes, 32MB to load up front(Excessive but effective?), maxReconnect tells it to try 10 times on failure. before_options also tell it to try and reconnect.
+        // Each song gets its own new Stream, so in theory 10 should be enough unless the song is super long.
         song_queue.connection.play(stream, {seek: 0, volume: 0.5})
         .on('finish', () => {
             song_queue.songs.shift();
@@ -152,5 +155,4 @@ module.exports = class ytdltie {
         await song_queue.text_channel.send(`Now playing **${song.title}**`); // Customizable
     }
 
-}
-
+}

index.js

@@ -1,21 +1,12 @@
-/*
-packages:
-discord.js
-@discordjs/opus
-ffmpeg-static
-yt-search
-ytdl-core
-
-Ubuntu node install:
-curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
-sudo apt-get install -y nodejs
-*/
 const ytdltie = require('./commands/ytdltie.js');
 const Discord = require('discord.js');
 const {
     prefix,
     token,
 } = require('./config.json');
+/*
+Main file for running the bot, contains the command handler, ytdltie object (MusicHandler) and error handling.
+*/
 const client = new Discord.Client();
 const MusicHandler = new ytdltie(Discord,client);
 client.login(token);