README.md

❇️ @retconned/kick-js

What is kick-js

kick-js is a TypeScript-based library for kick.com's chat system. It provides a simple interface that allows developers to build chat bots and other chat-related applications.

🚧 This is a new rewrite of the kick-js library, it is not compatible with the previous version. 🚧

Features 🚀

• Supports reading & writing to Kick.com chat.
• Moderation actions (ban, slowmode).
• Written in TypeScript.

Installation 📦

Install the @retconned/kick-js package using the following command:

npm install @retconned/kick-js

Example code 💻

import { createClient } from "@retconned/kick-js";
import "dotenv/config";

const client = createClient("xqc", { logger: true });

client.on("ready", () => {
  console.log(`Bot ready & logged into ${client.user?.tag}!`);
});

client.login({ process.env.TOKEN, process.env.COOKIES });

client.on("ChatMessage", async (message) => {
  console.log(`${message.sender.username}: ${message.content}`);
  }
});

Disclaimer ⚠️

@retconned/kick-js is not affiliated with or endorsed by Kick.com. It is an independent tool created to facilitate making moderation bots & other chat-related applications.