Comfy.JS 使用指南

Comfy.JS 使用指南

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

1. 项目介绍

Comfy.JS 是一个用于与 Twitch 聊天进行交互的 JavaScript 库，支持 NodeJS 和浏览器环境。这个库可以让开发者轻松集成 Twitch 聊天功能，通过简单的几行代码即可实现命令响应、消息监听等功能，非常适合 Twitch 主播或开发者打造互动性强的聊天体验。

2. 项目快速启动

安装

Node 环境

首先，确保你的系统中安装了 Node.js。然后通过以下命令安装 Comfy.JS：

npm install comfy.js --save

浏览器环境

将 comfy.min.js 从 dist 文件夹中下载，或者在 HTML 页面中通过 CDN 链接引入：

<script src="comfy.min.js"></script>

或者使用 JSDelivr CDN：

<script src="https://cdn.jsdelivr.net/npm/comfy.js@latest/dist/comfy.min.js"></script>

初始化

Node 环境

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");

浏览器环境

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

ComfyJS.Init("MyTwitchChannel");
</script>

响应命令

通过监听 onCommand 事件，可以在聊天中响应特定的命令。

ComfyJS.onCommand = (user, command, message, flags, extra) => {
    if (command === "test") {
        ComfyJS.Say("replying to !test");
    }
};

发送消息

要发送消息，使用 ComfyJS.Say() 方法，并确保你已经配置了 OAuth 令牌。

ComfyJS.Say("Hello, chat!");

3. 应用案例和最佳实践

命令防刷

为了防止命令被频繁触发，可以使用 extra.sinceLastCommand 来设置冷却时间。

ComfyJS.onCommand = (user, command, message, flags, extra) => {
    if (command === "test" && extra.sinceLastCommand.any < 1000) {
        console.log("Command is on cooldown.");
    } else {
        ComfyJS.Say("Command executed.");
    }
};

读取聊天消息

可以通过监听 onChat 事件来读取聊天中的所有消息。

ComfyJS.onChat = (user, message, flags, self, extra) => {
    console.log(user + ": " + message);
};

4. 典型生态项目

Comfy.JS 作为一个 Twitch 聊天交互库，可以与多种 Twitch 生态项目配合使用，例如：

• Twitch 聊天机器人
• 自动化聊天管理工具
• 游戏互动功能开发

通过整合这些生态项目，可以为 Twitch 频道提供更加丰富和专业的互动体验。

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