Skip to content

travisbartholome/travisbot

Repository files navigation

travisbot

It's a Twitch bot.

Requirements

Since I haven't set up Babel for this (yet) but am still using a good bit of ES6 syntax, you'll need a relatively recent node version to run this bot. (I'd recommend at least node >=8.0.0, but it should technically work as far back as node >=6.0.0).

Side note: get node 12 LTS here.

Running

Set up a file named config.js in the root directory. It should export a config object as the default export. An example config file, showing the correct structure with sensitive information removed, can be found at config.example.js.

See this link for descriptions of the variables in the tmiOptions object. The structure of tmiOptions should match the config object in the example.

See this link for information about the twitchApi object, This is used to make requests to the Twitch API for things like stream uptime. Specifically, you can refer to https://dev.twitch.tv/docs/authentication#registration (as of July 1, 2020) for information about generating a client ID and client secret, which you'll need to run API-dependent commands.

Run the bot by running npm start or node ./src/index.js in the repository's root directory.

Contributing

I'm happy to take any suggestions for this!

If you want to contribute, read CONTRIBUTING.md and submit an issue or pull request with your changes.

About

It's a Twitch bot.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published