From 704598b9ebd87870895b4fd6c4f5ca68a98af8b3 Mon Sep 17 00:00:00 2001 From: Oliver Grack Date: Fri, 31 Jan 2025 11:51:11 +0100 Subject: [PATCH] restructured readme and added dates to released versions in changelog --- README.md | 34 ++++++++++++++++++-------------- src/routes/(docs)/_changelog.mdx | 4 ++-- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b3ea1c68..a5281aa0 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,50 @@

- +

# HKViz web -A site for visualizing player-behavior for [Hollow Knight](https://www.hollowknight.com), like seeing the path one has taken in playthrough, to which boss one had the most difficulties, where one has spent the most time, and more. +A site for visualizing gameplays of [Hollow Knight](https://www.hollowknight.com), like seeing the path one has taken in playthrough, to which boss one had the most difficulties, where one has spent the most time, and more. -The mod for recording player behavior is contained in the [hkviz-mod repository](https://github.com/hkviz/hkviz-mod). +The mod for recording data is contained in the [hkviz-mod repository](https://github.com/hkviz/hkviz-mod). -Visit [hkviz.org](https://www.hkviz.org/) to get started recording your own gameplay. +Visit [hkviz.org](https://www.hkviz.org/) to see the site in action: + +- 🎥 to record analytics for your own gameplays visit the [install guide](https://www.hkviz.org/guide/install). +- 🌐 to analyze public gameplays of other players explore [public gameplays](https://www.hkviz.org/run). +- 📜 and lastly there is the [visualization guide](https://www.hkviz.org/guide/analytics) that explains the + different visualizations and how to interpret them. ## I have Ideas/Feedback for visualizations Feel free to [open an issue](https://github.com/hkviz/hkviz-web/issues) on this repository, write @olivergrack on discord or contact me via [support@hkviz.org](mailto:support@hkviz.org). -## How to use - -To get started recording your own gameplay analytics visit [hkviz.org](https://www.hkviz.org). - -You can also view gameplays from other players, if they send you a link and have set their gameplay to 'public' or 'unlisted' or by visiting the -[public gameplays page](https://www.hkviz.org/run). - ## For developers To set this project up locally: -- First copy the .env.example file in the root directly, and fill it with connection information for +- First copy the `.env.example` file in the root directly, and name it `.env`, and fill it with connection information for - a mysql database (where user accounts, and run metadata is stored) - a r2/s3 bucket (where analytics files are stored) - auth providers (discord, google, ...). Can be left empty if you are testing with the email login -- Start the project locally using `npm run dev` +- If needed [install pnpm](https://pnpm.io/installation) +- Install dependencies using `pnpm install`. +- Start the project locally using `pnpm dev` ### Project structure -This project is a monorepo, with the following packages: +These are some key folders of the project: - `src/lib/hk-data`: Contains extracted data from Hollow Knight. (Not licensed under MIT) - `src/lib/parser`: Parsing the recording files created by the mod +- `src/lib/viz`: Components for visualizing the data +- `src/server/db`: Database connection and schema +- `src/server/[run|account|...]`: Server functions and additional logic for handling requests and database interactions - `src/routes`: standard solid start folder for routes ### License -This project will largely be MIT licensed, with the exception of the `@hkviz/hk-data` package. Currently, this separation is not yet finished. Therefore, licenses are still missing. +This project will largely be MIT licensed, with the exception of the `hk-data` folder, containing assets from Hollow Knight. +Currently, this separation is not yet finished. Therefore, licenses are still missing. diff --git a/src/routes/(docs)/_changelog.mdx b/src/routes/(docs)/_changelog.mdx index aa50c958..9c5e34c9 100644 --- a/src/routes/(docs)/_changelog.mdx +++ b/src/routes/(docs)/_changelog.mdx @@ -1,6 +1,6 @@ # Mod Version 1.6.0.0 -**(To be released)** +**2025-01-31** - **Better error recovery when uploading data**: As the website version 3.0.0 or later now provides better information and error handling when a file upload is reattempted, @@ -9,7 +9,7 @@ # Website 3.0.0 -**(To be released)** +**2025-01-31** - **Room analytics based on timeline position**: Following confusions in the user study, the room analytics now updates based on the timeline position, but can also be set to display the gameplay totals like they did before.