mikl/hollow-knight-silksong-completion-check
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
ReznoRMichael 2021-01-26 00:36:43 +01:00
parent c60e12eeba
commit d96173ef43
1 changed files with 48 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -1,10 +1,14 @@
# Hollow Knight: Analyze Save Completion Online Tool
> Analyze your saves. See precisely what you missed and where. See Completion %, locations (also Shards/Fragments), costs, Game Statistics. I even designed spoiler-free hints based on your progress, if you are completely lost.
> Now you can see what you missed easily! Game Completion %, every Shard/Fragment/Ore, costs, locations, Game Statistics, Hunter's Journal, Achievements, Game Completion essentials. And if you are completely lost, I designed a spoiler-free Hint system based on your individual game progress.
## Support Tool (PayPal)
Every single penny counts: [Donate any amount](https://www.paypal.me/ReznoRMichael). By donating you directly contribute to the purpose of improving the tool for yourself and everyone else.
## General info
Hollow Knight doesn't have a game completion list. There is no way to easily check what specific things you forgot to do or missed for full 112% Game Completion, Hunter's Journal and Achievements. Until now! I wrote a tool for that for you.
Hollow Knight doesn't have a game completion list in-game. There is no way to easily check what specific things you forgot to do or missed for full 112% Game Completion, Hunter's Journal and Achievements. Until now! I wrote a tool for that for you.
*Inspirations: love for Hollow Knight, discussions on the forum, [KayDeeTee](https://github.com/KayDeeTee/Hollow-Knight-SaveManager) and [bloodorca](https://bloodorca.github.io/hollow)'s Save Editors, programming learning, Elderbug.*
@ -14,32 +18,44 @@ More info with features and visual previews can be found in the official [Steam
## How to use
* Use bloodorca's amazing [Online Save File Editor](https://bloodorca.github.io/hollow) to decode your Hollow Knight **user\*.dat** save file into text.
There are two ways to use this online tool:
* **CTRL+A** (Select All) inside the text box after decoding the save. **CTRL+C** (Copy) to copy the whole contents inside the text box. Be careful not to copy the whole webpage! Only the text inside the text box.
1. **Simple way**: just choose your **user\*.dat** save file and see the magic happen! See [save game locations paragraph](#hollow-knight-save-game-locations) below on where to find your Hollow Knight save files.
* **CTRL+V** (Paste) the text data inside the text box on the [Tool's webpage](http://reznortech.rf.gd/hollow-knight-completion/).
2. **Advanced way**: for people who wish to share saves on forums in text format through [pastebin.com](https://pastebin.com/). Step by step tutorial:
* Click **"Analyze Text"**. If the copy-pasted data was correct, you will see your Completion %, Play Time, and a whole list of things you have done (✅) or not yet done (❌).
* Use bloodorca's amazing [Online Save File Editor](https://bloodorca.github.io/hollow) to decode your Hollow Knight **user\*.dat** save file into text.
* Left-click anywhere inside the text box in the Editor after decoding the save and press **CTRL+A** (or Right-click -> Select All). Only the text inside the text box (decoded save file contents) should be selected.
* Press **CTRL+C** (or Right-click -> Copy) to copy the whole contents inside the text box.
* Go to the [Tool's webpage](https://reznormichael.github.io/hollow-knight-completion-check/) and press **CTRL+V** (or Right-click -> Paste) to paste the copied text inside the text box.
* Click **"Analyze Text"**. If the copy-pasted data was correct, you will see your Completion %, Play Time, and a whole list of things you have done (✅) or not yet done (❌).
## Hollow Knight Save game locations
#### Your Steam Cloud
### Your Steam Cloud
If you have Steam Cloud enabled for Hollow Knight, you can download your save [directly from here.](https://store.steampowered.com/account/remotestorageapp/?appid=367520)
You can use this if you want to check your save progress without access to your PC (on mobile/tablet for example) or if you don't want to search manually for the save files.
#### Windows
### Windows
`%USERPROFILE%\AppData\LocalLow\Team Cherry\Hollow Knight\`
**Pro Tip:** Copy and paste this code into the folder path bar of the Windows File Explorer window and press Enter to go there instantly (Windows 10).
*Example path: C:\Users\your-username\AppData\LocalLow\Team Cherry\Hollow Knight*
#### Linux
### Linux
`~/.config/unity3d/Team Cherry/Hollow Knight/`
#### macOS
### macOS
`~/Library/Application Support/unity.Team Cherry.Hollow Knight/`
#### Filenames
### Filenames
**user\*.dat** — main save file. Where \* is a number between 1 and 4, and it is the appropriate save slot inside the game.
**user\*.dat.bakX** — backup save files. Where X is a number in ascending order meaning how many backups were made during the whole playthrough of that save. The higher the number, the more recent the backup. There are usually 3 save backups at one time, older backups are deleted.
@ -52,7 +68,22 @@ If you like the tool and wish it developed further with more functions and easie
## Version History
* 2020-01-19:
* 2021-01-XX:
— **Major New Release v1.0.0!** Finally out of Beta.
— **Much easier to use:** Just choose a \*.dat or \*.bak save file to analyze. And that's it! You don't even have to press "Analyze", because programming magic does that for you.
— **Optimized:** Now smaller, faster and more web- and mobile-friendly than before. At least I hope 😉
— Added to Game Statistics:
✅ Shade Geo (Amount of Geo the Shade is currently holding)
— Windows HK Save files location in a code box for easy copy-paste in the Windows File Explorer address bar
— Improved text area graphics and readability
* 2021-01-19:
— Changed the site address to GitHub Pages using https. Now the site is published directly from the GitHub source. This should fix the problem for some people who were not able to visit the previous webpage.
@ -64,7 +95,7 @@ If you like the tool and wish it developed further with more functions and easie
— fixed the Path of Pain check (thanks to Reaper4578, kanna, tintingaroo for greatly helping in this, and kiotosmith, Reaper4578 for bringing this to my attention)
— added some new journal entries
— added some new journal entries:
**Achievements Essentials additions**
(rare missable enemies/entries for the Keen Hunter/True Hunter/Hunter's Mark achievements)
@ -144,7 +175,10 @@ If you like the tool and wish it developed further with more functions and easie
## Using
* JavaScript
* JavaScript (compiled to ES 6 / ES 2015)
* [AES-JS](https://github.com/ricmoo/aes-js)
* [Webpack](https://github.com/webpack/webpack)
* [Babel](https://github.com/babel/babel)
* HTML5/CSS
* JSON
* Fontello