OICQ 开源项目使用教程

1. 项目目录结构及介绍

OICQ 项目的目录结构如下：

OICQ/
├── bin/
├── config/
├── docs/
├── lib/
├── test/
├── .gitignore
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── web-api.md

目录介绍

• bin/: 存放项目的可执行文件或启动脚本。
• config/: 存放项目的配置文件。
• docs/: 存放项目的文档文件。
• lib/: 存放项目的核心代码库。
• test/: 存放项目的测试代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档，通常包含项目的简介、安装和使用说明。
• package.json: Node.js 项目的配置文件，包含项目的依赖、脚本等信息。
• tsconfig.json: TypeScript 项目的配置文件。
• web-api.md: Web API 的文档文件。

2. 项目启动文件介绍

项目的启动文件通常位于 bin/ 目录下。假设启动文件名为 start.js，其内容可能如下：

#!/usr/bin/env node

const { createClient } = require('../lib/oicq');
const config = require('../config/config.json');

const client = createClient(config.account);

client.on('system.online', () => {
  console.log('Logged in');
});

client.on('message', (e) => {
  console.log(e);
  e.reply('hello world', true);
});

client.login();

启动文件说明

• #!/usr/bin/env node: 指定使用 Node.js 运行该脚本。
• createClient: 创建 OICQ 客户端实例。
• config.json: 从配置文件中读取账号信息。
• client.on('system.online', ...): 监听客户端上线事件。
• client.on('message', ...): 监听消息事件，并回复消息。
• client.login(): 执行登录操作。

3. 项目配置文件介绍

项目的配置文件通常位于 config/ 目录下。假设配置文件名为 config.json，其内容可能如下：

{
  "account": 147258369,
  "password": "your_password",
  "options": {
    "log_level": "info",
    "cache_dir": "./cache"
  }
}

配置文件说明

• account: 登录账号。
• password: 登录密码。
• options: 其他配置选项。
  • log_level: 日志级别，可选值为 debug, info, warn, error。
  • cache_dir: 缓存目录路径。

通过以上配置文件，可以灵活地调整项目的运行参数，以适应不同的环境和需求。

---

以上是 OICQ 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你快速上手并使用该项目。