HKVizPublic gameplaysGuidesAbout

Guides

  • Gameplay Recording Guide
  • Analytics Guide

About

  • Credits
  • Publications
  • Changelog
  • Privacy Policy

Gameplay Recording Guide

This guide shows you how to install the HKViz mod so it can record analytics while you play Hollow Knight. Once your data is recorded, you can check out the Analytics Guide to learn how to use it.

Contents

  • 0. Need help?
  • 1. Install Hollow Knight
  • 2. Install a Mod Manager
  • 3. Install the HKViz mod
  • 4. Log in to HKViz from the Hollow Knight main menu
  • 5. Start playing Hollow Knight
  • Optional: 6. Share your analytics with others
  • Usage on Steam Deck

0. Need help?

If you need help installing the mod, ask in the Hollow Knight Modding Discord Server in the #hkviz channel or send an email at support@hkviz.org.

1. Install Hollow Knight

First, install Hollow Knight on your Windows, Linux, or Mac computer, laptop, or handheld. Mods cannot be used on the Nintendo Switch, PS4, or Xbox One versions of Hollow Knight.

You can buy Hollow Knight from one of the stores below:

  • Steam
  • GOG
  • Humble Bundle

2. Install a Mod Manager

The easiest way to install mods is to use a mod manager. Two popular options are:

  • Lumafly Mod Manager for Windows, Mac, and Linux. The download button on the website should give you the correct installer for your system.
  • If Lumafly does not work for you, try Scarab Mod Manager. Download the zip file that matches your operating system.

3. Install the HKViz mod

If you use Lumafly, you can install the HKViz mod by clicking here.

If you use a different mod manager, or the link does not work, search for "HKViz" in your mod manager and click install.

Make sure Hollow Knight is closed while the mod is being installed, otherwise the mod manager cannot finish the setup.

4. Log in to HKViz from the Hollow Knight main menu

After the mod is installed, a Login button appears on the Hollow Knight main menu. Click it and follow the steps to create an account or log into an existing account.

After you are logged in, the button disappears from the main menu. To switch accounts later use the mod settings.

5. Start playing Hollow Knight

Once you are logged in, start playing Hollow Knight. The mod automatically records analytics and uploads them to HKViz.

You can view your gameplay on the start page.

The mod uploads analytics roughly every 5 minutes, so your gameplay may not appear immediately. When you return to the Hollow Knight main menu, the mod uploads the last part of your gameplay and shows a small message at the bottom while it is sending data.

Optional: 6. Share your analytics with others

By default, all of your gameplay recordings are private, so only you can see them. You can change the visibility of each recording individually by clicking the lock icon on the left side of a gameplay on the start page.

Usage on Steam Deck

Installing mods on Steam Deck can currently break controller input. You can usually fix this by disabling the "native controller" option in Hollow Knight > Options > Controller.

The login button also does not currently work in Game Mode.

  • Switch to Desktop Mode by pressing Steam > Power > Switch to Desktop.
  • Open Hollow Knight. You should see an icon on your desktop, or you can search for "Hollow Knight" in the start menu.
  • Set fullscreen mode to "Windowed" in Hollow Knight > Options > Video.
  • Log in to HKViz from the Hollow Knight main menu.
  • Close Hollow Knight and switch back to Game Mode.
  • After logging in, the mod should work normally on Steam Deck.
Hollow Knight and all related indicia are trademarks of Team Cherry © 2025
Getting startedChangelogPrivacy policy