Skip to content

th3r3dfox/silksong-tracker

Repository files navigation

Silksong Tracker

View the Silksong Tracker.

Silksong Tracker is a web-based tool that allows you to analyze and visualize your Hollow Knight: Silksong save files. It helps players explore their progress, bosses defeated, items collected, and hidden secrets.

All data is processed locally in your browser - your save file is never uploaded or stored.

Features

  • Upload and decode Silksong .dat save files
  • View progress for bosses, items, and upgrades
  • Toggle spoiler and missing only filters
  • All decoding and rendering happens client-side
  • Compatible with modern browsers (Chrome, Firefox, Edge)

How to Use

  1. Go to the website for the tracker.
  2. Click on the "Upload save" button in the top-right-hand corner.
  3. Click on the box that says "click to browser".
  4. Select your save file.
  5. The tracker will decode the save and display the progress by category.

Technical Overview

You can read a technical overview of the project on a separate page.

Development / Contributing

This project is written in TypeScript and uses Vite to bundle all of the code.

Getting Started

  • Install Git, if you do not already have it installed.
  • Install Visual Studio Code, if you do not already have it installed. (We recommend using Visual Studio Code, but feel free to use a different editor if you know what you are doing.)
  • Install Node.js, if you do not already have it installed.
  • Create a GitHub account and login, if you have not already.
  • Fork this repository.
  • Clone your fork.
  • Open a new shell/termainal and cd to the cloned repository directory.
  • Install the JavaScript/TypeScript dependencies:
    • npm ci
  • Start a local version of the website on your computer:
    • npm run start

Formatting & Linting

This project uses Prettier, an automatic code formatter, and ESLint, a code linter. We have a ".vscode/settings.json" file that tells Visual Studio Code to automatically format a file on save. For this to work properly, you have to:

  1. Open Visual Studio Code to the repository folder. (File --> Open Folder)
  2. Ensure that you have already installed the JavaScript/TypeScript dependencies with: npm ci
  3. Install the Prettier extension for Visual Studio Code.
  4. Install the ESLint extension for Visual Studio Code.

Before submitting a pull request, please make sure that your updated coded passes our lint checks:

npm run lint

Credits

Inspired by ReznorMichael's Hollow Knight Save Analyzer.

Legal

This is a non-commercial fan project. We are not affiliated with Team Cherry.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors