Preparing Essentials

For the use of "Guilded-Bot" you need to install it via NPM, NPM is going to install all the dependencies for you. But, before that, you need set up a new project.

Go to a place of your PC and create a new folder named bot or whatever you want. Next you need to open a new terminal.

Opening a new terminal

❗

In this tutorial we are going to use the Windows Terminal and Visual Studio Code. If you are using another terminal, editor or OS, you need to find the equivalent commands.

Open the Windows Terminal and type cd and then drag the folder into the terminal. It should look like this: cd C:\Users\YourName\bot. (Replace YourName with your username and bot with the path to your folder)

Now you are in the folder.

Initializing the project

npm init

This command will initialize the project and create a package.json file. This file is going to store all the dependencies and other information about the project. You can edit this file later.

This command will ask you some questions, you can just press enter to skip them. The only thing you need to change is the entry point to index.js. This is the file where the bot is going to start.

🔔

If you want skip the questions, you can use the -y flag. This will skip all the questions and use the default values.

npm init -y

Installing Guilded-Bot

Now you need to install Guilded-Bot for your project. You can do this with the following command:

npm install guilded-bot

This command will install Guilded-Bot and all the dependencies for you. After this command is finished, you can start coding your bot.

Linter and Formatter (Optional)

While you are developing your bot, you should use a linter and a formatter. This will help you to find errors and format your code. You can use the following commands to install them:

npm install --save-dev eslint
npm install --save-dev prettier

After this command is finished, you can create a .eslintrc.json file and a .prettierrc file. You can copy the following code into the files:

.eslintrc.json

{
  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
  "parserOptions": {
    "ecmaVersion": 2020
  },
  "env": {
    "es6": true,
    "node": true
  }
}

.prettierrc

{
  "singleQuote": true,
  "trailingComma": "es5"
}

If you want, you can customize the files to your needs. You can find more information about the files here and here.