Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.15 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.15 KB

HKViz web

A site for visualizing player-behavior for 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 player behavior is contained in the hkviz-mod repository.

Visit hkviz.org to get started recording your own gameplay.

I have Ideas/Feedback for visualizations

Feel free to open an issue on this repository, write @olivergrack on discord or contact me via [email protected].

How to use

To get started recording your own gameplay analytics visit 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 visting the public gameplays page.

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
    • 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

Project structure

This project is a monorepo, with the following packages:

  • @hkviz/hk-data: A package containing extracted data from Hollow Knight. It mainly exists so the other packages can be licensed under MIT, while this package contains copyrighted data.
  • @hkviz/parser: A package for parsing the recording files created by the mod
  • @hkviz/app: The frontend of the project, currently a Next.js app

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.