Discord Bot TypeScript 模板使用教程

Discord Bot TypeScript 模板使用教程

Discord-Bot-TypeScript-TemplateDiscord bot - A discord.js bot template written with TypeScript.项目地址:https://gitcode.com/gh_mirrors/di/Discord-Bot-TypeScript-Template

1. 项目的目录结构及介绍

Discord-Bot-TypeScript-Template/
├── src/
│   ├── commands/
│   │   └── example.ts
│   ├── events/
│   │   └── ready.ts
│   ├── utils/
│   │   └── logger.ts
│   ├── config.ts
│   ├── index.ts
│   └── types.ts
├── .env.example
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

• src/: 包含所有 TypeScript 源代码文件。
  • commands/: 存放所有命令处理文件。
  • events/: 存放所有事件处理文件。
  • utils/: 存放工具函数和类。
  • config.ts: 配置文件。
  • index.ts: 项目入口文件。
  • types.ts: 类型定义文件。
• .env.example: 环境变量示例文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 编译配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

index.ts 是项目的入口文件，负责初始化和启动 Discord 机器人。以下是 index.ts 的主要内容：

import { Client, Intents } from 'discord.js';
import { config } from './config';
import { logger } from './utils/logger';

const client = new Client({ intents: [Intents.FLAGS.GUILDS] });

client.once('ready', () => {
    logger.info('Bot is ready!');
});

client.login(config.token);

• 导入必要的模块和配置。
• 创建 Client 实例并设置 intents。
• 监听 ready 事件，当机器人准备好时输出日志。
• 使用配置文件中的 token 登录 Discord。

3. 项目的配置文件介绍

config.ts 文件负责管理项目的配置信息，包括 Discord 的 token 和其他可能的配置项。以下是 config.ts 的主要内容：

import dotenv from 'dotenv';

dotenv.config();

export const config = {
    token: process.env.DISCORD_TOKEN || '',
};

• 使用 dotenv 模块加载环境变量。
• 从环境变量中读取 Discord token。
• 导出配置对象供其他模块使用。

请确保在项目根目录下创建一个 .env 文件，并添加 DISCORD_TOKEN 环境变量，例如：

DISCORD_TOKEN=your_discord_token_here

这样，项目在启动时就能正确读取到 Discord token。

Discord-Bot-TypeScript-TemplateDiscord bot - A discord.js bot template written with TypeScript.项目地址:https://gitcode.com/gh_mirrors/di/Discord-Bot-TypeScript-Template