GitBook: [master] 96 pages and 26 assets modified

Author: eslachance

.gitbook/assets/aigjoin.png

@@ -1,12 +1,12 @@
-# Discord.js Getting Started
+# Introduction
 
 ## Introduction
 
-This guidebook was originally authored by eslachance#4611 then handed down to me for future updates, but when she started the book originally it was because the examples for discord.js and the documentation were quite daunting for newcomers. There was definitely a space for this kind of document online, made obvious by the recurring questions that pop up almost every day on the support channels.
+This guidebook was originally authored by eslachance\#4611 then handed down to me for future updates, but when she started the book originally it was because the examples for discord.js and the documentation were quite daunting for newcomers. There was definitely a space for this kind of document online, made obvious by the recurring questions that pop up almost every day on the support channels.
 
 Seeing as though there needed to be some more detailed explanations as well as code samples, She figured a guide would be a great place to start!
 
-To keep with the style of the official documentation, we will be using full terms (client and message) for those variables.
+To keep with the style of the official documentation, we will be using full terms \(client and message\) for those variables.
 
 ## Updating of this guide
 
@@ -16,12 +16,15 @@ But to me Evie is a mentor, she was the one that metaphorically took me under he
 
 And I am honoured to be continuing it.
 
-![Guide transfer](assets/permission.png)
+![Guide transfer](.gitbook/assets/permission.png)
 
 ## Get Support
 
 If you have any questions after reading this guide please join us on the official Discord.js server:
 
-[![Join the Official Idiot's Guide Server](/assets/aigjoin.png)](https://discord.gg/gkZCQtH)[![Join the Official Discord.js Server](/assets/djsjoin.png)](https://discord.gg/bRCvFy9)
+![Join the Official Idiot's Guide Server](.gitbook/assets/aigjoin.png)
+
+![Join the Official Discord.js Server](.gitbook/assets/djsjoin.png)
 
 Last Updated: `21/01/2018`
+

.gitbook/assets/becomeapatronbanner.png

@@ -1,64 +1,66 @@
-# Summary
+# Table of contents
 
-* [Support me on Patreon](https://www.patreon.com/anidiotsguide)
 * [Introduction](README.md)
+* [Support me on Patreon](https://www.patreon.com/anidiotsguide)
+* [Introduction](introduction.md)
 * [Frequently Asked Questions](frequently-asked-questions.md)
 * [Common Errors](common-errors.md)
-* [Getting Started](getting-started.md)
-  * [Getting Started - Long Version](getting-started/the-long-version.md)
-  * [Getting Started - Linux TL;DR](getting-started/linux-tldr.md)
-  * [Getting Started - Windows TL;DR](getting-started/windows-tldr.md)
-* [First Bot](first-bot.md)
-  * [Your First Bot](getting-started/your-basic-bot.md)
-  * [Adding a Config File](getting-started/config-json-file.md)
-  * [Command with arguments](examples/command-with-arguments.md)
-  * [A Basic Command Handler](coding-guides/a-basic-command-handler.md)
-  * [Using Embeds in messages](examples/using-embeds-in-messages.md)
-* [Coding Guides](coding-guides.md)
-  * [JSON-Based Points System](coding-guides/storing-data-in-a-json-file.md)
-  * [SQLite-Based Points System](coding-guides/storing-data-in-an-sqlite-file.md)
-  * [Enmap-Based Points System](coding-guides/storing-data-in-a-persistent-collection.md)
-  * [Creating a Music Bot](coding-guides/coding-a-music-bot.md)
+* Getting Started
+  * [Getting Started - Long Version](getting-started/getting-started-long-version.md)
+  * [Getting Started - Linux TL;DR](getting-started/getting-started-linux-tl-dr.md)
+  * [Getting Started - Windows TL;DR](getting-started/getting-started-windows-tl-dr.md)
+* First Bot
+  * [Your First Bot](first-bot/your-first-bot.md)
+  * [Adding a Config File](first-bot/adding-a-config-file.md)
+  * [Command with arguments](first-bot/command-with-arguments.md)
+  * [A Basic Command Handler](first-bot/a-basic-command-handler.md)
+  * [Using Embeds in messages](first-bot/using-embeds-in-messages.md)
+* Coding Guides
+  * [JSON-Based Points System](coding-guides/json-based-points-system.md)
+  * [SQLite-Based Points System](coding-guides/sqlite-based-points-system.md)
+  * [Enmap-Based Points System](coding-guides/enmap-based-points-system.md)
+  * [Creating a Music Bot](coding-guides/creating-a-music-bot.md)
   * [Cleverbot Integration](coding-guides/cleverbot-integration.md)
-  * [Selfbots, the greatest thing in the universe](examples/selfbots-are-awesome.md)
+  * [Selfbots, the greatest thing in the universe](coding-guides/selfbots-the-greatest-thing-in-the-universe.md)
   * [Using Emojis](coding-guides/using-emojis.md)
-  * [Starboard](coding-guides/starboard.md)
-* [Understanding](understanding.md)
-  * [Events and Handlers](information/understanding-events-and-handlers.md)
-  * [Collections](information/understanding-collections.md)
-  * [Roles](information/understanding-roles.md)
-  * [Sharding](information/understanding-sharding.md)
-* [Examples](examples.md)
+  * [Making your own Starboard](coding-guides/starboard.md)
+* Understanding
+  * [Events and Handlers](understanding/events-and-handlers.md)
+  * [Collections](understanding/collections.md)
+  * [Roles](understanding/roles.md)
+  * [Sharding](understanding/sharding.md)
+* Examples
   * [Welcome Message every X users](examples/welcome-message-every-x-users.md)
   * [Message Reply Array](examples/message-reply-array.md)
   * [Making an Eval command](examples/making-an-eval-command.md)
-  * [Miscellaneous Examples](examples/misc-examples.md)
-  * [Using Guidebot's Flags](examples/using-guidebot-flags.md)
-* [Discord Webhooks](discord-webhooks.md)
-  * [Discord Webhooks \(Part 1\)](discord-webhooks/part-1.md)
-  * [Discord Webhooks \(Part 2\)](discord-webhooks/part-2.md)
-  * [Discord Webhooks \(Part 3\)](discord-webhooks/part-3.md)
-* [Other Guides](other-guides.md)
+  * [Miscellaneous Examples](examples/miscellaneous-examples.md)
+  * [Using Guidebot's Flags](examples/using-guidebots-flags.md)
+* Discord Webhooks
+  * [Discord Webhooks \(Part 1\)](discord-webhooks/discord-webhooks-part-1.md)
+  * [Discord Webhooks \(Part 2\)](discord-webhooks/discord-webhooks-part-2.md)
+  * [Discord Webhooks \(Part 3\)](discord-webhooks/discord-webhooks-part-3.md)
+* Other Guides
   * [Installing and Using a proper editor](other-guides/installing-and-using-a-proper-editor.md)
   * [Using Git to share and update code](other-guides/using-git-to-share-and-update-code.md)
-  * [Hosting on a Raspberry Pi](other-guides/hosting-on-a-pi.md)
-  * [Hosting Music Bots on a Raspberry Pi](other-guides/hosting-music-on-a-pi.md)
-  * [Hosting on Glitch.com](other-guides/hosting-on-glitchcom.md)
-  * [Async / Await](information/understanding-asyncawait.md)
-  * [Docker Part 1: Setup & Dockerfile](other-guides/docker-01.md)
-  * [Docker Part 2: Installing, running & More](other-guides/docker-02.md)
-  * [Introducing Enhanced Maps](coding-guides/using-persistentcollections.md)
+  * [Hosting on a Raspberry Pi](other-guides/hosting-on-a-raspberry-pi.md)
+  * [Hosting Music Bots on a Raspberry Pi](other-guides/hosting-music-bots-on-a-raspberry-pi.md)
+  * [Hosting on Glitch.com](other-guides/hosting-on-glitch.com.md)
+  * [Async / Await](other-guides/async-await.md)
+  * [Docker Part 1: Setup & Dockerfile](other-guides/docker-part-1-setup-and-dockerfile.md)
+  * [Docker Part 2: Installing, running & More](other-guides/docker-part-2-installing-running-and-more.md)
+  * [Introducing Enhanced Maps](other-guides/introducing-enhanced-maps.md)
   * [Introduction to modules](other-guides/introduction-to-modules.md)
-* [Video Guides](video-guides.md)
-  * [Episode 1](video-guides/episode-01.md)
-  * [Episode 2](video-guides/episode-02.md)
-  * [Episode 3](video-guides/episode-03.md)
-  * [Episode 4](video-guides/episode-04.md)
-  * [Episode 5](video-guides/episode-05.md)
-  * [Episode 6 Part 1](video-guides/episode-06-part-01.md)
-  * [Episode 6 Part 2](video-guides/episode-06-part-02.md)
-  * [Episode 7](video-guides/episode-07.md)
-  * [Episode 8](video-guides/episode-08.md)
-  * [Episode 9](video-guides/episode-09.md)
-  * [Episode 10 Part 1](video-guides/episode-10-part-01.md)
-  * [Episode 10 Part 2](video-guides/episode-10-part-02.md)
+* Video Guides
+  * [Episode 1](video-guides/episode-1.md)
+  * [Episode 2](video-guides/episode-2.md)
+  * [Episode 3](video-guides/episode-3.md)
+  * [Episode 4](video-guides/episode-4.md)
+  * [Episode 5](video-guides/episode-5.md)
+  * [Episode 6 Part 1](video-guides/episode-6-part-1.md)
+  * [Episode 6 Part 2](video-guides/episode-6-part-2.md)
+  * [Episode 7](video-guides/episode-7.md)
+  * [Episode 8](video-guides/episode-8.md)
+  * [Episode 9](video-guides/episode-9.md)
+  * [Episode 10 Part 1](video-guides/episode-10-part-1.md)
+  * [Episode 10 Part 2](video-guides/episode-10-part-2.md)
+

.gitbook/assets/cleverbot.png

@@ -2,9 +2,9 @@
 
 I've had this request since I started my Idiot's Guide, in fact it was one of the very first requests I had, but I had a feeling it would be a disappointing short episode, maybe a 5 minute long episode. But for a written guide it'd be perfect!
 
-So to get started, let's grab the example from [getting started](/getting-started/the-long-version.md) and shove it in a file.
+So to get started, let's grab the example from [getting started](../getting-started/getting-started-long-version.md) and shove it in a file.
 
-```js
+```javascript
 const Discord = require("discord.js");
 const client = new Discord.Client();
 
@@ -23,7 +23,7 @@ client.login("superSecretBotTokenHere");
 
 Once you've got that, we should go check out `cleverbot-node` on [npmjs.com](https://www.npmjs.com/package/cleverbot-node) and grab their example code
 
-```js
+```javascript
 var Cleverbot = require("cleverbot-node");
 cleverbot = new Cleverbot;
 cleverbot.configure({botapi: "IAMKEY"});
@@ -32,7 +32,7 @@ cleverbot.write(cleverMessage, function (response) {
 });
 ```
 
-> **NOTE:** As you can see in the above example taken from the npm page, you now need an API key, which you can get [here](http://www.cleverbot.com/api/), they do offer a free tier, but that's 5,000 api calls per month (at the time of writing), and please note it says it's a free __trial__.
+> **NOTE:** As you can see in the above example taken from the npm page, you now need an API key, which you can get [here](http://www.cleverbot.com/api/), they do offer a free tier, but that's 5,000 api calls per month \(at the time of writing\), and please note it says it's a free **trial**.
 
 Alright, we've got both parts we need, now before we continue we should get the module installed, just run `npm i cleverbot-node` with the `--save` flag if you have a `package.json` file \(and you should!\).
 
@@ -44,14 +44,14 @@ We have both our example codes, now we need to combine them for a working bot.
 
 Right, we need to take the first two lines of the cleverbot example...
 
-```js
+```javascript
 var Cleverbot = require("cleverbot-node");
 cleverbot = new Cleverbot;
 ```
 
 ...and put them with our discord definitions.
 
-```js
+```javascript
 const Discord = require("discord.js");
 const Cleverbot = require("cleverbot-node");
 const client = new Discord.Client();
@@ -63,15 +63,15 @@ I renamed `cleverbot` to `clbot` to reduce any possible confusion between the va
 
 Then we take the rest of the code and place that inside our message event handler, but for this example I only want the bot to talk to me in DM's, so we"ll check the channel `type` with the following code, you can make it respond on mentions or even in channels \(I would honestly advise against that.\)
 
-```js
+```javascript
 if (message.channel.type === "dm") {
   // Cleverbot code goes here.
 }
 ```
 
 Your code should look something like this...
 
-```js
+```javascript
 const Discord = require("discord.js");
 const Cleverbot = require("cleverbot-node");
 const client = new Discord.Client();
@@ -98,4 +98,5 @@ client.login("superSecretBotTokenHere");
 
 If everything is as above, then just send your bot a DM and watch the magic unfold!
 
-![Success!](/assets/cleverbot.png)
+![Success!](../.gitbook/assets/cleverbot.png)
+

.gitbook/assets/djsjoin.png

@@ -1,14 +1,12 @@
-# Coding a Music Bot
+# Creating a Music Bot
 
 Everyone including their grandparents want to create a music bot, I myself have created a music bot and believe me it's not as easy as you would think.
 
-However, if you insist on creating a music bot you can either check out the example bots below, or you could support me on Patreon for $5+, and you'll get a step by step tutorial on how to make a multi-guild compatible music bot and access to the completed source code to a custom music bot (When the series concludes).
+However, if you insist on creating a music bot you can either check out the example bots below, or you could support me on Patreon for $5+, and you'll get a step by step tutorial on how to make a multi-guild compatible music bot and access to the completed source code to a custom music bot \(When the series concludes\).
 
 As well as the music bot tutorial you also get a `patron` role on my guild, a private patron only channel to discuss with other patrons, priority d.js bot help, behind the scenes pictures, videos and vlogs, and early access to regular content and future patron tutorial series.
 
-[![Support me on Patreon](/assets/becomeAPatronBanner.png)](https://www.patreon.com/anidiotsguide)
+![Support me on Patreon](../.gitbook/assets/becomeapatronbanner.png)
+
+If you do not feel like supporting me, there are these amazing examples; [OhGodMusicBot](https://github.com/bdistin/OhGodMusicBot) by AoDude [Moosik](https://github.com/Gawdl3y/discord-moosik) by Gawdl3y [Commando's Music](https://github.com/iCrawl/Commando/tree/master/commands/music) by Crawl
 
-If you do not feel like supporting me, there are these amazing examples;
-[OhGodMusicBot](https://github.com/bdistin/OhGodMusicBot) by AoDude
-[Moosik](https://github.com/Gawdl3y/discord-moosik) by Gawdl3y
-[Commando's Music](https://github.com/iCrawl/Commando/tree/master/commands/music) by Crawl

.gitbook/assets/editorhelp.png

@@ -12,13 +12,13 @@ Similarly to the other _"Points System"_ articles, let's explore another altenat
 
 Let's start with installing the 2 parts that we need for this to work: `enmap` and `enmap-sqlite`. Simply run the following command in your project folder:
 
-```
+```text
 npm i enmap enmap-sqlite
 ```
 
 Once that's complete, we need to open up index.js and add two different things. First, we need to import and initialize the _Provider_ itself. Then, you need to create a new persistent Enmap using the provider itself. Here's how it goes:
 
-```js
+```javascript
 const Enmap = require("enmap");
 const Provider = require("enmap-sqlite");
 
@@ -31,9 +31,9 @@ That will create a new Enmap under the name of points, and attaches it to the cl
 
 The obvious goal of a points system is to accumulate fake internet points and gloat about it. So, of course, that's going to be our first focus. In this example implementation, we will make the points guild-specific, and unuseable in DMs. Points will still accumulate even if the user does a command, which simplifies our code a bit.
 
-Our starting point is a very basic message handler with pre-existing commands - such as what we see in the [Command with Arguments](/examples/command-with-arguments.md) page of this guide. The code is as such:
+Our starting point is a very basic message handler with pre-existing commands - such as what we see in the [Command with Arguments](../first-bot/command-with-arguments.md) page of this guide. The code is as such:
 
-```js
+```javascript
 client.on("message", message => {
   if (message.author.bot) return;
   // This is where we'll put our code.
@@ -48,7 +48,7 @@ client.on("message", message => {
 
 We do have a small caveat - we really don't want to react on Direct Messages, so our whole code will be in a block that checks for that:
 
-```js
+```javascript
 client.on("message", message => {
   if (message.author.bot) return;
   if (message.guild) {
@@ -60,7 +60,7 @@ client.on("message", message => {
 
 Our very first step is going to be to initialize a new entry in the enmap for any new user - one we haven't received a message from before. This is done using the `enmap.has(key)` method, which can check if a specific key exists in the Enmap, and `enmap.set(key, value)` method that adds data to Enmap. Note that our keys take the format of `guildid-userid` so they're unique to the guild and the user. Also, our data in this case is a complete object, which we'll take advantage of with Enmap 2.0.
 
-```js
+```javascript
 client.on("message", message => {
   if (message.author.bot) return;
   if (message.guild) {
@@ -82,7 +82,7 @@ There's obviously a few ways we could have done this, including some fancy terna
 
 Two methods will be used for the following bit, `enmap.getProp(key, propname)` which retrieves, specifically, only the points property from the saved object. We'll also use `enmap.setProp(key, propname, value)` which will then _save_ that points property back into the enmap without needing to load the whole object.
 
-```js
+```javascript
 client.on("message", message => {
   if (message.author.bot) return;
   if (message.guild) {
@@ -104,29 +104,29 @@ client.on("message", message => {
 
 Time to level up! If a user has enough points, they will go up a level. Now we have to do some math here, but don't run off in fear, this one's pretty easy. This is how we calculate the levels:
 
-```js
+```javascript
 const curLevel = Math.floor(0.1 * Math.sqrt(currentPoints));
 ```
 
 This line will calculate the square root of `currentPoints` then multiplies that result by 0.1 then floors that result for a round number.
 
 Now we should work out if you've amassed enough points to actually level up, by grabbing the current user's level and comparing them. If the new calculated level is higher, it means the user leveled up and we can deal with that, first by sending them a very annoying mee6-inspired message!
 
-```js
+```javascript
 if (client.points.getProp(key, "level") < curLevel) {
   message.reply(`You've leveled up to level **${curLevel}**! Ain't that dandy?`);
 }
 ```
 
 Lastly, we want to update the `score.level` value with the new level so throw this under the `message.reply`.
 
-```js
+```javascript
 client.points.setProp (key, "level", curLevel);
 ```
 
 So here's the whole thing from top to bottom, with bonus comments!
 
-```js
+```javascript
 client.on("message", message => {
   // As usual, ignore all bots.
   if (message.author.bot) return;
@@ -171,7 +171,7 @@ Alright, that's the bulk of the code, you could throw this into your bot and it
 
 So let's re-iterate our current starting position.
 
-```js
+```javascript
 client.on("message", message => {
   if (message.author.bot) return;
   if (message.guild) { /* Points Code Here */ }
@@ -186,7 +186,7 @@ client.on("message", message => {
 
 The `points` command would look like this:
 
-```js
+```javascript
   if (command === "points") {
     return message.channel.send(`You currently have ${client.points.getProp(key, "points")}, and are level ${client.points.getProp(key, "level")}!`);
   }
@@ -200,7 +200,7 @@ Let's finish this off with a very simple `leaderboard` command that will show th
 
 So here's our leaderboard command:
 
-```js
+```javascript
 if(command === "leaderboard") {
   // Get a filtered list (for this guild only), and convert to an array while we're at it.
   const filtered = client.points.filterArray( p => p.guildID === message.guild.id );
@@ -230,7 +230,7 @@ In the famous words of Evie _"Now take this, and make it **better than Mee6!** G
 
 Taken straight from [Evie's Gist on points](https://gist.github.com/eslachance/12e2239aa353b350e075a4b006238335) \(but adjusted for Enmap 2.0\), you might find these useful!
 
-```js
+```javascript
   if(command === "give") {
     // Limited to guild owner - adjust to your own preference!
     if(!message.author.id === message.guild.owner) return message.reply("You're not the boss of me, you can't do that!");
@@ -271,4 +271,5 @@ Taken straight from [Evie's Gist on points](https://gist.github.com/eslachance/1
 
     message.channel.send(`I've cleaned up ${toRemove.size} old farts.`);
   }
-```
+```
+