chat-analyzer 1.0.0b5

Installation

todo…

Some console code:

beep 123
...

Usage

TODO: Discuss modes url:… chatfile: JSON from Xenova’s chat-downloader to JSON analytic data to be used for visualization (or -sc) reanalyze:…

usage: chat_analyzer [-h] [--version] [--platform {youtube,twitch}]
                    [--mode {url,chatfile,reanalyze}]
                    [--save-chatfile-output SAVE_CHATFILE_OUTPUT]
                    [--interval INTERVAL] [--print-interval PRINT_INTERVAL]
                    [--highlight-percentile HIGHLIGHT_PERCENTILE]
                    [--highlight-metric {usersPSec,chatsPSec,activityPSec}]
                    [--description DESCRIPTION] [--output OUTPUT] [--nojson]
                    [--debug] [--break BREAK]
                    source

Output

For non-developers, I highly recommend you use the visualizer on chatanalyze.com to view the output of the program. Simply follow the instructions and upload the output json file to the visualizer.

All of the analytical data is output in a single .json file. Certain datapoints exist regardless of the platform the VOD is from, some datapoints are specific to the platform.

Common fields among ALL platfroms:

{
    "duration": 7386.016,
    "interval": 5,
    "description": "description ",
    "program_version": "1.0.0b5",
    "platform": "www.....com",
    "duration_text": "2:03:06",
    "interval_text": "0:05",
    "mediaTitle": "The title of the VOD",
    "mediaSource": "https://www...",
    "samples": [
        {
        "startTime": 0,
        "endTime": 5,
        "sampleDuration": 5,
        "startTime_text": "0:00",
        "endTime_text": "0:05",
        "activity": 10,
        "chatMessages": 9,
        "firstTimeChatters": 9,
        "uniqueUsers": 9,
        "avgActivityPerSecond": 2.0,
        "avgChatMessagesPerSecond": 1.8,
        "avgUniqueUsersPerSecond": 1.8,
        "_userChats": {},
        },
        ...
    ],
    "totalActivity": 42547,
    "totalChatMessages": 42034,
    "totalUniqueUsers": 12533,
    "overallAvgActivityPerSecond": 5.760480345561126,
    "overallAvgChatMessagesPerSecond": 5.691024768968819,
    "overallAvgUniqueUsersPerSecond": 5.66955345060893,
    "highlights": [
        {
        "startTime": 4405,
        "endTime": 4420,
        "description": "avgUniqueUsersPerSecond sustained at or above [8.6]",
        "type": "avgUniqueUsersPerSecond",
        "peak": 11.2,
        "avg": 9.866666666666665,
        "duration": 15,
        "duration_text": "0:15",
        "startTime_text": "1:13:25",
        "endTime_text": "1:13:40"
        },
        ...
    ],
    "highlights_duration": 540,
    "highlights_duration_text": "9:00",
    "spikes": [],
    "_overallUserChats": {},
    "_currentSample": null,
}

TODO: Use the docs within dataformat.py to populate each field’s description

duration: “……”

Twitch-specific fields:

Within the main object:

...,
"totalSubscriptions": 478,
"totalGiftSubscriptions": 213,
"totalUpgradeSubscriptions": 5

Within each sample object:

...,
"subscriptions": 1,
"giftSubscriptions": 0,
"upgradeSubscriptions": 0

YouTube-specific fields:

Within the main object:

...,
"totalSuperchats": 253,
"totalMemberships": 246

Within each sample object:

...,
"superchats": 0,
"memberships": 0

Special Thanks

This project wouldn’t exist without Xenova and their chat-downloader! All of the platform-standardization and downloading logic that they worked on for their downloader made the analyzer infinitely easier to write. In order to avoid compatability issues, this software comes packaged with a frozen version of the downloader src, and all credit goes to Xenova for the contents in the chat_downloader directory. If you are willing, go on over to their repo and show them some support as well :)