Getting Started

Creating your Discord Bot

To get started, we need to create a Discord Bot.

1. Go to the Discord Developer Portal.
2. Choose a cool name for your new Discord Bot.
3. Accept Discord’s ToS.
4. Click on the “Create” button.

Discord Developer Portal showing the “New Application” button

Now you have created your Discord Bot. Next, we’re going to allow some intents for the bot so it can read our messages.

1. Head to the “Bot” tab on the left sidebar.

Discord Developer Portal showing the “Bot” tab

2. Scroll down until you see “Privileged Gateway Intents”.
3. Check all three Intents.

Discord Developer Portal showing the “Privileged Gateway Intents” section

Inviting your Bot

Now we need to invite our newly created bot to our server!

1. Go to the “OAuth2” tab on the left sidebar.

Discord Developer Portal showing the “OAuth2” tab

2. Scroll down until you see “OAuth2 URL Generator”.

Check the following scopes:

• bot
• application.commands

Preferably, you should also check the “Administrator” permission to avoid any permission issues.

Discord Developer Portal showing the “OAuth2 URL Generator” section

3. Copy the generated URL and paste it into your browser and select the server you want to invite the bot to.

Showing how to Invite the Bot

---

You should now see your bot in your invited server. Next, we will set up a project to start coding our bot.

Showing the bot in the server

Setting up a Project

The last thing to do is getting our new bot up and running. But first, let’s get our Discord Bot Token.

1. Go back to the Developer Portal.
2. Go to the “Bot” tab on the left sidebar.
3. Reset the token.

Discord Developer Portal showing the “Bot” tab

4. Copy the Token, and keep it safe.

Sharing your Token

Anyone who has access to your bot token can control your bot. Do not share your bot token with anyone.

• Be sure to copy it as it will not be shown to you again.
• For security purposes, tokens can only be viewed once, when created. If you forgot or lost access to your token, please regenerate a new one.

Discord Developer Portal showing the “Token” section

Bringing your Bot Online

Now that we have our bot token, we can start coding our bot.

We are going to use Visual Studio Code for this, you can however use any code editor you prefer.

1. Open Visual Studio Code.

Choose what option you want to use.

Beginners

Using the Command Line is recommended for people without JavaScript knowledge.

• Using the Command Line

• Starting from Scratch

Using the Command Line

1. Open a new terminal.

   Opening a new terminal

2. Run the following command to create a new project:

Installing aoi.cli and starting a new project

npx @akarui/aoi.cli create

This might take a while, depending on your internet connection.

Running CLI

npm is not recognized as an internal or external command

If you get an error saying npm is not recognized as an internal or external command, you need to install Node.js. You can download it from here.

What is npm?

npm is a package manager for JavaScript programming language. It is the default package manager for the JavaScript runtime environment Node.js.

What is npx?

npx is a package runner tool that comes with npm 5.2+ and higher. It is used to execute packages without installing them globally.

3. You will be asked to enter your bot token. Paste the token you copied earlier.

• Head to the created index.js file, you should see a couple of placeholders.

You need to replace the DISCORD BOT TOKEN with the token you copied earlier, and the DISCORD BOT PREFIX with the prefix you want to use for your bot.

Adding the base of your bot

To continue with this guide, follow this link.

Creating your first Command

---

Starting from Scratch

To start from scratch we need to manually create our files and folders.

1. Create a new folder for your project.
2. Open the folder in Visual Studio Code.
3. Create a commands folder.
4. Create a index.js file.

Creating a new folder

5. Run npm init -y in the terminal to create a package.json file.

What is package.json?

package.json is a file that contains metadata about the project. It includes the project’s name, version, description, and dependencies.

Make sure you’re in the project folder before running the command.

Running cd

6. Install the aoi.js package by running the following command:

   You can use either npm, pnpm, yarn, or bun to install the package. If you don’t know what to use, you can use npm.

npm

npm i aoi.js

yarn

yarn add aoi.js

pnpm

pnpm add aoi.js

npm is not recognized as an internal or external command

If you get an error saying npm is not recognized as an internal or external command, you need to install Node.js. You can download it from here.

What is npm?

npm is a package manager for JavaScript programming language. It is the default package manager for the JavaScript runtime environment Node.js.

What is npx?

npx is a package runner tool that comes with npm 5.2+ and higher. It is used to execute packages without installing them globally.

Running npm install

Your file structure should look like this:

File Structure

7. We now need to add the base of your bot.

• This is the code that will be in your index.js file.
• You require the previously copied token!
• You can ignore everything else for now besides the token.

index.js

const { AoiClient } = require("aoi.js");

const client = new AoiClient({
    token: "Discord Bot Token", // Here goes the Token you copied earlier!
    prefix: "!", // Here goes the prefix you want to use for your bot!
    intents: ["MessageContent", "Guilds", "GuildMessages"],
    events: ["onMessage", "onInteractionCreate"],
    database: {
        type: "aoi.db",
        db: require("@aoijs/aoi.db"),
        dbType: "KeyValue",
        tables: ["main"],
        securityKey: "a-32-characters-long-string-here"
    }
});

// Ping Command which responds when doing "!ping"
client.command({
    name: "ping",
    code: `Pong! $pingms`
});

client.loadCommands("./commands");

Adding the base of your bot

To continue with this guide, follow this link.

Creating your first Command

---

Creating your first Command

Now that we have the base of our bot, let’s create our first command.

1. Create a new file in the commands folder.
2. Name the file avatar.js.

We will now use several functions to return the avatar of the user who used the command.

avatar.js

module.exports = {
    name: "avatar",
    code: `
  $author[$username's Avatar!]
  $color[Random]
  $image[$authorAvatar]
  $footer[Requested by $username]
  $addTimestamp
  `
};

Creating the avatar command

---

Running your Bot

Now that we have our bot set up, we can run it.

Head back to your terminal and run the following command:

Running the bot

node index.js

This will run our bot, and you should see it come online in your server.

When running !avatar or !ping in your server, you should see the bot respond with the avatar of the user who used the command or with “Pong!“.