-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
55 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,48 @@ | ||
**@retconned/kickjs** | ||
![Version](https://img.shields.io/npm/v/@retconned/kick-js?label=Version) | ||
![License](https://img.shields.io/npm/l/@retconned/kick-js?label=License) | ||
|
||
A demo package for Total TypeScript. | ||
❇️ **@retconned/kick-js** | ||
|
||
## **What is kick-js** | ||
|
||
**kick-js** is a TypeScript-based library for [kick.com](https://kick.com)'s chat system. It provides a simple interface that allows developers to build chat bots and other chat-related applications. | ||
|
||
### :construction: This is a new rewrite of the kick-js library, it is not compatible with the previous version. :construction: | ||
|
||
## Features :rocket: | ||
|
||
- Supports reading & writing to Kick.com chat. | ||
- Moderation actions (ban, slowmode). | ||
- Written in TypeScript. | ||
|
||
## Installation :package: | ||
|
||
Install the @retconned/kick-js package using the following command: | ||
|
||
```sh | ||
npm install @retconned/kick-js | ||
``` | ||
|
||
## Example code :computer: | ||
|
||
```ts | ||
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 :warning: | ||
|
||
@retconned/kick-js is not affiliated with or endorsed by [Kick.com](https://kick.com). It is an independent tool created to facilitate making moderation bots & other chat-related applications. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters