Razzmatazzz / RemnantSaveGuardian

Tool to backup your saves and view your world rolls
GNU General Public License v3.0
290 stars 41 forks source link

parsing the save files better #227

Closed AndrewSav closed 2 months ago

AndrewSav commented 3 months ago

Dear contributors!

I have create a library https://github.com/AndrewSav/lib.remnant2.saves for parsing remnant 2 save files and another one https://github.com/AndrewSav/lib.remnant2.analyzer to sit on top of first and provide data similar to what RemnantSaveGuardian wants to display.

I also replaced the file parsing in RemnantSaveGuardian with this library, you can see it in a fork:https://github.com/AndrewSav/RemnantSaveGuardian/tree/newengine

This is obviously a massive change, so I want to float the idea if this is something we could consider for merging. I want to warn, that the save format is totally, absolutely 100% percent hellish. If anyone thinks, "once we know the format things should be easy", that's unfortunately wrong. This format is clearly not made for humans. So even with it, things remains complex. However there are benefits of the new approach.

Advantages

There are a few other minor things that could be added with the new library, e.g display the actual Cass shop, track Kill x bosses quest progressions, blood moon change tracking, etc

Disadvantages

Can someone have a look please, and let me know if we want to go anywhere from here.