This is a JavaScript rewrite version of my Discord bot Yue. Yue was using in NCU CSIE Discord Server and World of Warships guild PTT NiceBoat. It made so much fun. But the library used by Yue is no longer maintance(detail). In fact, the origin one which written by Python might not work properly in the soon future, so I decide to write a new one with discord.js.

Node.js 16.6.0 or newer is required.

git clone https://github.com/ppodds/YueJS.git
cd YueJS
npm install

If you encounter error, try to use docker to deploy your bot.

config files at src/config

bot-config.json

{
    "name": "Bot name",
    "statusList": ["a", "list", "of", "status"],
    "statusType": "Bot status type, either 'PLAYING', 'LISTENING' or 'WATCHING'",
    "token": "your token. you can get it on Developer portal",
    "env": "dev or prod",
    "dev": {
        "clientId": "123456789",
        "guildId": "123456789"
    },
    "author": {
        "avatar": "author avator url"
    }
}

db-config.json

{
    "host": "localhost",
    "port": 3306,
    "user": "Yue",
    "password": "test",
    "database": "Yue"
}

Note: Change "host": "localhost" as "host": "database" if you are using docker!

You need to install mariadb and sure it could work properly.

Note: There is a docker-compose.yml can build a test database service in few minutes.

Before you run the bot, you should deploy commands first.

npm run reg

Note: env in bot-config.json affacts the process of deploying commands. If env is prod, npm run reg would deploy commands globally.

Now you can use npm run start check whether it can work.

Note: If you get this error

Privileged intent provided is not enabled or whitelisted.

Try to enable options below

Run following commands.

cd ${project_path}
docker build --tag yue .

# database is not in the container
docker create -it -v ${project_path}/temp:/app/temp --network=host --name yue yue
# database is in the container
docker create -it -v ${project_path}/temp:/app/temp --name yue yue

# Note: only allow absolute path

# run container!
docker start yue

If you get the error below, check your bot-config.json set clientId and token properly.

DiscordAPIError[20012]: You are not authorized to perform this action on this application
    at SequentialHandler.runRequest (/app/node_modules/@discordjs/rest/dist/lib/handlers/SequentialHandler.js:198:23)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async SequentialHandler.queueRequest (/app/node_modules/@discordjs/rest/dist/lib/handlers/SequentialHandler.js:99:20)
    at async /app/deploy-commands.js:29:13 {
  rawError: {
    message: 'You are not authorized to perform this action on this application',
    code: 20012
  },
  code: 20012,
  status: 403,
  method: 'put',
  url: 'https://discord.com/api/v9/applications/??????????????????/commands'
}