https://github.com/r6stats/twitch-bot
Twitch.tv Bot for R6Stats
https://github.com/r6stats/twitch-bot
r6stats rainbow-six rainbow6 twitch twitch-bot
Last synced: about 1 year ago
JSON representation
Twitch.tv Bot for R6Stats
- Host: GitHub
- URL: https://github.com/r6stats/twitch-bot
- Owner: R6Stats
- License: gpl-3.0
- Created: 2018-09-19T04:23:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-19T04:23:17.000Z (over 7 years ago)
- Last Synced: 2025-01-29T12:22:16.595Z (over 1 year ago)
- Topics: r6stats, rainbow-six, rainbow6, twitch, twitch-bot
- Language: JavaScript
- Homepage: https://r6stats.com
- Size: 37.1 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# R6Stats Twitch Bot
Developed for R6Stats, this Twitch bot uses [tmi.js](https://github.com/tmijs/tmi.js) to interact with the Twitch Chat API and provide streamers a way for their users to view and share Rainbow Six: Siege stats right in Twitch chat.
Stats are provided by [R6Stats.com](https://r6stats.com)
## Usage
The bot currently supports a limited amount of commands. Parameters in {...} are required and those in [...] are optional.
* !ping - pings the bot to ensure it is online and responding to messages
* !setstats {username} {platform} - set the player that whose stats will be displayed when `!stats` is called with no arguments
* !stats - called with no arguments, the `!stats` command displays the stats for the player set with `!setstats`
* !stats {username} {platform} - displays the stats for a player on the specified platform
### Examples
```bash
!setstats AjjeSaeb pc # set the channel's stats to this player
!stats # displays the stats for AjjeSaeb on PC, as set above
!stats Zamhomie pc # displays the stats for Zamhomie on PC
```
## Installing
Clone the repository, copy `config.example.js` to `config.js` and modify as necessary. Then run:
```bash
yarn # or npm install
npm run dev
```