How to's for HKViz

Other links

How to use the HKViz-mod to record analytics of your gameplays

Hello to the HKViz install page!
Here you learn how to install the mod, to create and record analytics of you playing Hollow Knight.

Contents

0. Need help?

If at any point you need help, feel free to ask in the Hollow Knight Modding Discord Server inside the #hkviz channel or via email support@hkviz.org

1. Install Hollow Knight

First, you need to have Hollow Knight installed on your windows, linux or mac computer, laptop or handheld. Mods can not be used on the Nintendo Switch, PS4, or Xbox One versions of HollowKnight. You can buy Hollow Knight at one of the following stores:

2. Install a Mod Manager

The easiest way to install mods is using a mod installer. There are a few available.

  • I recommend using the Lumafly mod manager available for Windows, Mac, and Linux. You can click the download button on the website, it should give you the correct installer.
  • If this mod manager doesn't work for you, you can try Scarab Mod Manager select one of the zip files depending on your operating system.

3. Install the HKViz mod

If you have chosen the Lumafly mod manager, you can install the HKViz mod by clicking here

Alternatively, if you are using another mod manager, or the link did not work, search for 'HKViz' in your mod manager and click install. While installing the mod, HollowKnight must be closed, otherwise the mod manager will not be able to install the mod.

4. Login to HKViz from the HollowKnight main menu

Once you have the mod installed, a Login button is displayed on the main menu of HollowKnight. Click on it and follow the steps to create an account.

5. Start playing HollowKnight

Once logged in you can start playing HollowKnight. The mod will automatically record your gameplay, and upload it to HKViz. You can view your gameplay on the start page.

The mod uploads analytics roughly every 5 minutes, so your gameplay might not be visible immediately. When you go back to the main menu of HollowKnight, the mod will upload the last bit of gameplay, and while display a small message in the bottom while it is uploading data.

Optional: 6. Share your analytics with others

By default all your gameplay is set to private, so only you can see it. You can change this by clicking on the lock icon on the left of a gameplay on the start page.

Usage on Steamdeck

Currently installing mods on the steamdeck breaks all controller inputs. You can fix this by disabling the 'native controller' option in the HollowKnight Options > Controller

Additionally, the login button does not currently work, while in game mode.

  • Use the desktop mode by pressing the Steam button > Power > Switch to Desktop.
  • Open HollowKnight (A icon should be visible on your desktop, alternatively you can search for)
  • Set the fullscreen mode to 'Windowed' in the HollowKnight Options > Video
  • Then you can login to HKViz from the main menu of HollowKnight.
  • After the login, close HollowKnight and switch back to game mode.
  • Playing HollowKnight and using the mod now should work as expected.