Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/tmijs/tmi.js

💬 Javascript library for the Twitch Messaging Interface. (Twitch.tv)
https://github.com/tmijs/tmi.js

chat chatbot javascript nodejs tmi tmijs twitch twitchdev

Last synced: 21 days ago
JSON representation

💬 Javascript library for the Twitch Messaging Interface. (Twitch.tv)

Host: GitHub
URL: https://github.com/tmijs/tmi.js
Owner: tmijs
License: mit
Created: 2015-06-07T22:42:32.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2023-11-29T19:37:58.000Z (7 months ago)
Last Synced: 2024-06-09T15:59:36.728Z (23 days ago)
Topics: chat, chatbot, javascript, nodejs, tmi, tmijs, twitch, twitchdev
Language: JavaScript
Homepage: https://tmijs.com
Size: 3.15 MB
Stars: 1,538
Watchers: 55
Forks: 216
Open Issues: 33
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-stars - tmi.js
awesome-twitch-dev - tmijs/tmi.js - Connect to and interact with Twitch chat (IRC) from Node.js or a browser. (Libraries / JavaScript (Node.js))

README

        # tmi.js

![Test Workflow Status](https://github.com/tmijs/tmi.js/workflows/Test/badge.svg)

[![Npm Version](https://img.shields.io/npm/v/tmi.js.svg?style=flat)](https://www.npmjs.org/package/tmi.js)

[![Downloads](https://img.shields.io/npm/dm/tmi.js.svg?style=flat)](https://www.npmjs.org/package/tmi.js)

[![Issues](https://img.shields.io/github/issues/tmijs/tmi.js.svg?style=flat)](https://github.com/tmijs/tmi.js/issues)

[![Node Version](https://img.shields.io/node/v/tmi.js.svg?style=flat)](https://www.npmjs.org/package/tmi.js)

![](https://i.imgur.com/r1N7y1c.png)

[Website](https://tmijs.com/) |

[Documentation currently at tmijs/docs](https://github.com/tmijs/docs/tree/gh-pages/_posts) |

[Changelog on the release page](https://github.com/tmijs/tmi.js/releases)

## Install

### Node

```bash

$ npm i tmi.js

```

```js

const tmi = require('tmi.js');

const client = new tmi.Client({

	options: { debug: true },

	identity: {

		username: 'bot_name',

		password: 'oauth:my_bot_token'

	},

	channels: [ 'my_channel' ]

});

client.connect().catch(console.error);

client.on('message', (channel, tags, message, self) => {

	if(self) return;

	if(message.toLowerCase() === '!hello') {

		client.say(channel, `@${tags.username}, heya!`);

	}

});

```

### Browser

Available as "`tmi`" on `window`.

```html

```

```html

const client = new tmi.Client({ /* ... */ });

client.connect().catch(console.error);

```

#### Prebuilt Browser Releases

[Release page](https://github.com/tmijs/tmi.js/releases)

#### Build Yourself

```bash

$ git clone https://github.com/tmijs/tmi.js.git

$ npm install

$ npm run build

```

### Type Definitions

```bash

$ npm i -D @types/tmi.js

```

## Community

- Follow [@AlcaMagic on Twitter](https://twitter.com/AlcaMagic), [Alca on Twitch](https://twitch.tv/alca).

- Follow [@Schmoopiie on Twitter](https://twitter.com/Schmoopiie).

- Found a bug: [submit an issue.](https://github.com/tmijs/tmi.js/issues/new)

- Discussion and help about tmi.js: [Twitch API Discord Server](https://discord.gg/8NXaEyV)

- For everything else: [Official TwitchDev Discord Server](https://link.twitch.tv/devchat)

## Contributors

Thanks to all of the tmi.js [contributors](https://github.com/tmijs/tmi.js/graphs/contributors)!

## Contributing guidelines

Please review the [guidelines for contributing](https://github.com/tmijs/tmi.js/blob/main/CONTRIBUTING.md) of the [tmi.js repository](https://github.com/tmijs/tmi.js). We reserve the right to refuse a Pull Request if it does not meet the requirements.