tmi.js
Website | Documentation currently at tmijs/docs | Changelog on the release page
Install
Node
$ npm i tmi.jsconst 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.
<script src="/scripts/tmi.min.js"></script><script>
const client = new tmi.Client({ /* ... */ });
client.connect().catch(console.error);
</script>Prebuilt Browser Releases
Build Yourself
$ git clone https://github.com/tmijs/tmi.js.git
$ npm install
$ npm run buildType Definitions
$ npm i -D @types/tmi.jsCommunity
- Follow @AlcaMagic on Twitter, Alca on Twitch.
- Follow @Schmoopiie on Twitter.
- Found a bug: submit an issue.
- Discussion and help about tmi.js: Twitch API Discord Server
- For everything else: Official TwitchDev Discord Server
Contributors
Thanks to all of the tmi.js contributors!
Contributing guidelines
Please review the guidelines for contributing of the tmi.js repository. We reserve the right to refuse a Pull Request if it does not meet the requirements.