Installing Node.js and discord.js
To use discord.js, you'll need to install Node.js. You can do so by going to the Node.js website.
Installing on Windows
If you're developing on Windows, it's as simple as installing any other program. Go to the Node.js website, download the latest version, open up the downloaded file, and follow the steps from the installer.
Installing on macOS
If you're developing on macOS, you have a few options. You can go to the Node.js website, download the latest version, double click the package installer, and follow the instructions. Or you can use a package manager like Homebrew with the command
brew install node.
Installing on Linux
If you're developing on Linux, you may consult this page to determine how you should install Node.
On that note, there's a possibility that you may already have Node (e.g. if you're using a VPS). You can check by running the
node -v command. If it outputs something like
v8.0.0 or higher, then you're good to go! Otherwise, take a look at the page linked above for instructions on installing Node on your OS.
If you do have Node installed, but have an older version (i.e. anything below 8.0.0), you should upgrade to the latest version. Discord.js v11 requires Node 8.0.0 or higher.
Preparing the essentials
To install and use discord.js, you'll need to install it via npm (Node's package manager). npm comes with every Node installation, so you don't have to worry about installing that. However, before you install anything, you should set up a new project folder.
Setting up a project folder
Like any other project, you should have a dedicated folder for this, in order to keep it organized and manageable.
Navigate to a place on your machine that's easy to find and reopen in the future, for convenience purposes. Create a new folder like you normally would (for Linux, you can use
mkdir project-name inside your terminal). If you already have a name you want to use for your bot, you can use that as the folder name. Otherwise, you may name it something like
discord-bot for the time being (or anything else you have in mind).
Once you're done making the folder, open it up (for Linux, you can use
cd project-name inside your terminal).
Opening the command prompt
If you're on Linux, you can quickly open up the terminal with
Ctrl + Alt + T.
If you're on Windows and aren't familiar with opening up the command prompt, simply do the following:
- Open your bot project folder.
- Hold down the
Shiftkey and right-click inside of the folder.
- Choose the "Open command window here" option.
It should then open up a window with a black background. It's a bit unattractive, but we'll talk about using better, more powerful tools in a different part of the guide.
Using the command prompt
With the command prompt open, run the
node -v command to make sure you've successfully installed Node.js. If you see something like <branch="11.x" inline>
v10.0.0, great! If not, go back and try installing again.
The next command you'll be running is
npm init. This command creates a
package.json file for you, which is what will be used to keep track of the dependencies your bot uses, as well as other info. If you're a bit confused by that, you can simply ignore it for the time being.
npm init command will ask you a sequence of questions - you should fill them out as you see fit. If you're not sure of something or just want to skip it as a whole, simply leave it blank and press enter.
Want to get started quickly? Use
npm init -y to have it fill out everything for you!
Once you're done with that, you're ready to install discord.js!
Now that you've installed Node.js and know how to open up your console and run commands, you can finally install discord.js!
To install discord.js, simply run the
npm install discord.js. This can take a bit of time, but should be done fairly quickly.
Once the installation is complete, you'll see something like this:
This is perfectly normal and means that it worked. You don't need to install any of the items listed in order to use discord.js; they are 100% optional.
And that's it! With all the necessities installed, you're almost ready to start coding your bot.
Installing a linter
While you are coding, you may find that you run into numerous syntax errors, or just code in an inconsistent style. It's highly urged that you install a linter to ease these troubles. While code editors generally are able to point out syntax errors, with a linter, you can coerce your coding to be in a specific style as you define in the configuration. While this is not required, it's strongly recommended. Click here for the linter guide!