Update README.md
This commit is contained in:
parent
0fac08aebf
commit
6fbb5142fb
36
README.md
36
README.md
@ -1,10 +1,34 @@
|
|||||||
# Discord-Channel-Analysis
|
# 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:
|
Planned statistics:
|
||||||
|
|
||||||
* Most active users (All time | Past Year | 6 Months | 3 Months | 1 Month | Week) by percentage
|
* Most active users by time period. Can display either messages or percentage of chat.
|
||||||
* Most used emojis
|
* Most used emojis, phrases, GIFs (Configure in settings file)
|
||||||
* Most used phrases by percentage of users. (User can specify which phrase to look for)
|
* Chat activity histogram over time
|
||||||
* Chat activity over time (When is the most active month? At what time is it the most active)
|
* Most active time of day
|
||||||
* More will be added to this list in time
|
|
||||||
|
# Settings Configuration
|
||||||
|
To be implemented
|
||||||
|
|
||||||
|
# Troubleshooting
|
||||||
|
To be updated as development ensues
|
||||||
|
Loading…
x
Reference in New Issue
Block a user