aidan/Discord-Channel-Analysis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Aidan Haas 2023-01-26 14:13:32 -05:00 committed by GitHub
parent 0fac08aebf
commit 6fbb5142fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,10 +1,34 @@
# Discord-Channel-Analysis
Generates statistics of a given discord channel like most active times of the week, most active users, and more.
Generates trends of discord channels / chats
Discord Channel Analysis parses the output from [Discord Chat Explorer](https://github.com/Tyrrrz/DiscordChatExporter) into readable information.
# How to Use
Ensure you have the latest version of Python installed.
Download the latest release of Discord Channel Analysis. Extract the release to your desired location.
Download [Discord Chat Explorer](https://github.com/Tyrrrz/DiscordChatExporter)
Insert your token into Discord Chat Explorer. Once logged in, navigate to the settings menu and change the date format to `MM-dd-yyyy HH:mm:ss`
Navigate to your desired channel and export the chat in CSV format in the same location as unzipped Discord Channel Analysis.
Modify the settings file in the program directory to specify which stats you'd like to calculate.
Run main.py
Stats will be written to an output file.
Planned statistics:
* Most active users (All time | Past Year | 6 Months | 3 Months | 1 Month | Week) by percentage
* Most used emojis
* Most used phrases by percentage of users. (User can specify which phrase to look for)
* Chat activity over time (When is the most active month? At what time is it the most active)
* More will be added to this list in time
* Most active users by time period. Can display either messages or percentage of chat.
* Most used emojis, phrases, GIFs (Configure in settings file)
* Chat activity histogram over time
* Most active time of day
# Settings Configuration
To be implemented
# Troubleshooting
To be updated as development ensues