Twitch-Emote-Analytics-Tracker

A Twitch Bot which can track the usage of Twitch emotes (FFZ, BTTV ) in your chat! Give the viewers and yourself the power to check the most used emotes per user or over the whole channel. To get a understanding what the bot can do refer to the Command List

How to setup the bot on your own

Comming soon!

How to get started as a streamer

If you setup the bot on your own or I added your channel to my bot you need to do the following steps.

1. Before you can import your emotes to the tracking list you need to run both commands or one of them at least : !setbttvuserid or !setffzuserid.
2. Run !refresh. There should be a message in chat stating how many emotes got imported.
3. Double check the tracking list of the emotes by typing !trackedemotes in chat which displays all emotes imported.
4. You can run !track if you want that your emotes usage should be tracked.
5. Inform your viewer that they also can use some commands explained here.

How to get started as a viewer

If the streamer has set up the bot correctly you can also start to get some information about your top emotes used in this particular channel.

1. You need to use !track command. At this point the bot won't ignore your messages anymore and will start tracking your usage of the Twitch emotes. If you want to cancel this tracking just use !untrack. The bot will then ignore all your message in chat. You can however reactivate the tracking any time you want by running !track again.
2. To get the top three used Twitch emotes on the channel use !mytopemotes in chat.

Commands

Command	Arguments	Output	Access
!track		The user will be tracked of there Twitch emotes usage	Viewer and higher
!untrack		The user will be no longer tracked of there Twitch emotes usage	Viewer and higher
!mytopemotes		Delivers the top 3 used emote of the user	Viewer and higher
!help		Delivers a link to this documentation in twitch chat	Viewer and higher
!trackedemotes		Delivers all tracked emotes of the channel	Mods or higher
!addemote	emoteName e.g !addEmote KEKW	Add a custom emote which are not in FFZ or BTTV	Mods or higher
!removeemote	emoteName e.g !removeEmote KEKW	Removes a custom emote	Mods or higher
!channeltopemotes		Delivers all used emotes in the channel ordered by the most used to the least one.	Broadcaster only
!setbttvuserid	e.g !setbttvuserid 1234	Set's the mandatory userId for importing emotes from BTTV	Broadcaster only
!setffzuserid	e.g !setffzuserid zezima	Set's the mandatory userId for importing emotes from FFZ	Broadcaster only
!refresh		Sync the tracked emotes with BTTV and FFZ. Adds missing and removes deleted emotes	Broadcaster only
!reset		Deletes all tracked data from all tracked user of the channel	Broadcaster only

!track

Using !track command will add you to the tracking list. This means all message you write in this channel you used the command will be scanned by the bot. We do not save the messages! We save only your userId, used emote and how many times you used it.

!untrack

Using !untrack command will remove you from the tracking list. The bot will ignore all you message you made and therefore won't keep track on your usage of the Twitch emotes.

!mytopemotes

Using !mytopemotes command will displays your top 3 used Twitch emotes with the corresponding count in chat.

!trackedemotes

Using !trackedemotes will displays all Twitch emotes which are tracked on the channel. Be aware that multiple messages will be send to the chat depending on how many there are.

!channeltopemotes

Using the !channeltopemotes will display all used Twitch emotes of the channel from the most used down to the least used one. Keep in mind that the count is sum up by all viewers which has the tracking activated once.

!setbttvuserid

Does set the value for importing emotes from your BTTV Channel. The provided value is the technical userId. Follow the instruction below to retrieve this id.

Getting the BTTV UserId

1. Go to BTTV with your Twitch account you use to stream!
2. Open up the developer console by pressing the key F12 or by right clicking the page and choose inspect
3. Go to the tab Network and filter it to Fetch/XHR.

5. Now click on Dashboard at the BTTV page
6. In the developer console is a new entry. Choose preview and copy the id. (This is your bttv userId)

!setffzuserid

Does set the value for importing emotes from your FFZ channel. The provided value is the account name on FFZ.

!refresh

Using the !refresh command will sync the tracked emotes with BTTV and FFZ. However you need to first set some values before using this command successfully. There are currently two sources integrated. BTTV and FFZ. If you want to get one or both of this sources and you have a channel there then refer to this commands !setBttvUserId or !setffzuserid.

!reset

Using the !reset command will delete all tracked data from all viewers of your channel. This means also that !mytopemotes and !channeltopemotes will be reseted as well starting from 0 again.

!addemote

Use !addemote command only if you want to add a custom Twitch emote which are not in BTTV or FFZ.

To add a emote to the tracking list use !addEmote [theEmoteYouWantToAdd] for e.g !addEmote KEKW. When successfull the bot will reply.

!removeemote

Use !removeemote to remove custom added Twitch emotes. This command won't work on BTTV or FFZ emotes. If you need to update BTTV or FFZ emotes then use !refresh command.

To remove a emote from the tracking list use !removeEmote [theEmoteYouWantToRemove] for e.g !removeEmote KEKW. When successfull the bot will reply.

!help

Bot responses to Twitch chat with a link to this documentation.

The MIT License (MIT)

Copyright (c) 2021 Dominic Gilomen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.