main

Welcome to oberknecht-client - a JavaScript based IRC Client for Twitch

Owned Packages used in this client:

https://github.com/jubewe/oberknecht-utils

https://github.com/jubewe/oberknecht-api

Usage

You'll need to have NodeJS (/npm) installed to use this package.

Full Sample at: https://github.com/jubewe/oberknecht-client-test

1. Install the package via the node package manager (npm):

npm install oberknecht-client

2. Import the client into your file:

index.js

const { oberknechtClient } = require("oberknecht-client");

import { oberknechtClient } from "oberknecht-client";

3. Create a new oberknechtClient

const oberknecht = new oberknechtClient(<clientOptions>);

Example

const client = new oberknechtClient({
    token: "bbxxpxcy1w248ajgb4rkeytdkdwffd",
    // Token link generator: https://jubewe.de/twitch/oauthlink
    username: "jubewe",
    channels: ["jubewe", "ju_b0t"]
});

4. Connect client to chat

client.connect();

5. Add a event listener

Event Types: https://github.com/jubewe/oberknecht-client/blob/master/lib/src/oberknecht.emitter.events.js

client.on("<event>", (callback) => {})

GitHub Repository

https://github.com/jubewe/oberknecht-client

NPM Package

https://www.npmjs.com/package/oberknecht-client