ComfyJS 使用教程

ComfyJS 使用教程

ComfyJS Comfiest Twitch Chat Library for JavaScript | NodeJS + Browser Support 项目地址: https://gitcode.com/gh_mirrors/co/ComfyJS

1. 项目目录结构及介绍

ComfyJS 是一个用于与 Twitch 聊天进行交互的 JavaScript 库，支持 NodeJS 和浏览器环境。项目目录结构如下：

ComfyJS/
├── .github/              # GitHub 相关的配置文件
├── dist/                 # 编译后的文件，包含压缩版的 ComfyJS 库
├── examples/             # 使用 ComfyJS 的示例代码
├── types/                # TypeScript 类型定义
├── vendor/               # 第三方库文件
├── .gitignore            # Git 忽略文件
├── LICENSE               # MIT 许可证文件
├── README.md             # 项目说明文件
├── _publish.sh           # 发布脚本
├── app.js                # NodeJS 环境下的入口文件
├── package-lock.json     # npm 包锁定文件
├── package.json          # npm 包配置文件
├── test.js               # 测试文件
├── version.js            # 版本管理文件

2. 项目的启动文件介绍

ComfyJS 的启动主要依赖于 app.js 文件，这是 NodeJS 环境下的入口文件。以下是一个基本的启动示例：

const ComfyJS = require('comfy.js');

ComfyJS.onCommand = (user, command, message, flags, extra) => {
  if (flags.broadcaster && command === 'test') {
    console.log('!test was typed in chat');
  }
};

ComfyJS.Init('MyTwitchChannel');

这段代码设置了 onCommand 事件监听器，当在 Twitch 聊天中输入 !test 命令时，会在控制台输出一条消息。通过调用 ComfyJS.Init 方法并传入你的 Twitch 频道名称来初始化 ComfyJS。

3. 项目的配置文件介绍

ComfyJS 的配置主要通过环境变量来实现。你需要创建一个 .env 文件来存储你的 Twitch 用户名和 OAuth 密码。.env 文件的内容应该如下所示：

TWITCHUSER=你的Twitch用户名
OAUTH=你的OAuth密码

在 NodeJS 应用中，你可以使用 dotenv 包来加载这些环境变量：

require('dotenv').config();

const ComfyJS = require('comfy.js');

ComfyJS.onCommand = (user, command, message, flags, extra) => {
  // 你的命令处理逻辑
};

ComfyJS.Init(process.env.TWITCHUSER, process.env.OAUTH);

通过这种方式，你可以在不将敏感信息直接硬编码在代码中的情况下，安全地管理你的 Twitch 凭据。

ComfyJS Comfiest Twitch Chat Library for JavaScript | NodeJS + Browser Support 项目地址: https://gitcode.com/gh_mirrors/co/ComfyJS