Prerequisites

Platform registration

warning

Before developing, please prepare a platform account.

• QQ Development platform
• KOOK Development platform
• DISCORD Development platform

Registered tutorial

Use the robot needs to get the account and Token key of the open platform in order to communicate with the message platform and then send and receive messages.

Here are some commonly used instructions or tutorials for the use of robot open platforms. Please choose according to your needs.

Robot name	Link
QQ/QQ-Guild Official Bot	Official documentation
WeChat Bot	Official documentation
Telegram Bot	Official documentation， Other tutorials
Discord Bot	Official documentation
kook Bot	Official documentation

Environmental preparation

MacOS

The system version must be at least MacOS12.

Older versions of the system are not guaranteed to work successfully.

Check git version; will prompt to download common toolkits if not installed

git --version

Brew Official Website

Doownload Brew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Add environment variable

echo 'export PATH="/opt/homebrew/bin:$PATH"' >> ~/.bash_profile

Add environment variable

echo 'export PATH="/opt/homebrew/bin:$PATH"' >> ~/.zshrc

Refresh environment variable

source ~/.bash_profile && source ~/.zshrc

Use nvm to install and manage Node.js versions, which makes it easier to switch versions for development.

Install nvm

brew install nvm

Add environment variable for nvm

echo 'export NVM_DIR="$HOME/.nvm"' >> ~/.bash_profile
echo '[ -s "/opt/homebrew/opt/nvm/nvm.sh" ] && \. "/opt/homebrew/opt/nvm/nvm.sh"' >> ~/.bash_profile
echo '[ -s "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm" ] && \. "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm"' >> ~/.bash_profile

Add environment variable for zshrc

echo 'export NVM_DIR="$HOME/.nvm"' >> ~/.zshrc
# This loads nvm
echo '[ -s "/opt/homebrew/opt/nvm/nvm.sh" ] && \. "/opt/homebrew/opt/nvm/nvm.sh"' >> ~/.zshrc
# This loads nvm bash_completion
echo '[ -s "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm" ] && \. "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm"' >> ~/.zshrc

Refresh environment variable

source ~/.bash_profile && source ~/.zshrc

Install NodeJS@18.20.3

nvm install 18.20.3
nvm use 18.20.3
node -v
npm -v

Ubuntu/Debian

Example system: Ubuntu 24.04 LTS / Debian 12.0 X86 2H2G

sudo apt update
sudo apt install wget -y
sudo apt install curl -y

Install nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

Add environment variable for nvm

echo 'export NVM_DIR="$HOME/.nvm"' >> ~/.bashrc
echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"' >> ~/.bashrc
source ~/.bashrc
nvm -v

Install NodeJS@18.20.3

nvm install 18.20.3
nvm use 18.20.3
node -v
npm -v

Install git

apt install git

Install chromium

sudo apt install chromium-browser

Centos

Example system: Centos 8.2 X86 2H2G

Ensure YUM is up-to-date

sudo yum update -y
sudo yum install wget -y
sudo yum install curl -y

Install NVM

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

Add environment variable for nvm

echo 'export NVM_DIR="$HOME/.nvm"' >> ~/.bashrc
echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"' >> ~/.bashrc
source ~/.bashrc # 刷新环境
nvm -v # 版本

CentOS 8 and below can't use Node V18,

please use 16.14.0 instead.

Install NodeJS@18.20.3

nvm install 18.20.3
nvm use 18.20.3
node -v
npm -v

Install git

yum install git

Install Chromium

yum  install chromium -y

Windows

Recommended system: Windows10 | Windows11

1. Install a browser: If not using the recommended system, please install Google Chrome / Edge

2. Install Node.js： Node.js@18.20.3

It is recommended to use nvm-setup.exe to manage Node.js versions for easier version switching during development.

The Node.js version must be greater than 16.14.0 and be an even version.

3. Install Git： Git Download for Windows

All options must be clicked as default to avoid Git corruption.

Encountered an issue? Read the Common Problems