A site for visualizing gameplays of Hollow Knight, 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 data is contained in the hkviz-mod repository.
Visit hkviz.org to see the site in action:
- 🎥 to record analytics for your own gameplays visit the install guide.
- 🌐 to analyze public gameplays of other players explore public gameplays.
- 📜 and lastly there is the visualization guide that explains the different visualizations and how to interpret them.
Feel free to open an issue on this repository, write @olivergrack on discord or contact me via [email protected].
To set this project up locally:
- First copy the
.env.examplefile 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
- If needed install pnpm
- Install dependencies using
pnpm install. - Start the project locally using
pnpm dev
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 modsrc/lib/viz: Components for visualizing the datasrc/server/db: Database connection and schemasrc/server/[run|account|...]: Server functions and additional logic for handling requests and database interactionssrc/routes: standard solid start folder for routes
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.