From 136aca2697fd5c73cb1e0cc8b0544e7182498c12 Mon Sep 17 00:00:00 2001 From: h7x4 Date: Wed, 19 Mar 2025 13:54:09 +0100 Subject: [PATCH] README: add description --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b9f72e..f7a3e24 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # minecraft-heatmap -What the player doin? \ No newline at end of file +What the player doin? + +## What is this? + +This project is meant to visualize the login history of our minecraft server. +It does this by: + +1. Regularly scanning through all the minecraft logs for login and logout messages. +2. Calculating the intervals (as well as filtering invalid login/logout spans) +3. Putting them into an sqlite database +4. Fetching the data from the database, and displaying them on a website. + +It's intended to mimick the github contribution heatmap: + +![](https://preview.redd.it/dude-is-a-pro-v0-mltqiyxfjy291.jpg?auto=webp&s=f0ff6d458317d1023f82afb4db44717e4a8af42d)