wofsauge / External-Item-Descriptions

A mod for the game "The Binding of Isaac: Rebirth" that displays useful informations for items, trinkets, rooms and more!
190 stars 115 forks source link

"Spoiler-free" option by flagging what chars/bosses have been encountered #476

Open Buurazu opened 2 years ago

Buurazu commented 2 years ago

As we all know, it's quite difficult to know for certain what specific items a save file has unlocked, but, it could be fairly doable to know what bosses they have seen before, to add a "spoiler-free" option (as well as removing redundant text from things like Sacrifice Poster and Mom's Shovel).

This would also require that specific line from the description to be separated from the main part of the description, but I have some plans in mind for that already (as I want things like "0-1 as Keeper" to be able to only be displayed as Keeper)

We could both check for the current character being played, and for any items that a given character or boss unlocks to determine if that character is unlocked or that boss route is unlocked, as well as the location that we're currently in.

Once these checks are passed, it could be a flag saved to that save file's EID data file so we don't have to do it every time.

I don't quite know what all would be considered a spoiler since it's been absolute years (key pieces unlocking the "mega satan" door is a spoiler i guess?), the easiest thing to avoid spoilers on is like Faded Polaroid mentioning the Ascent door, I suppose the Dad's Note description could be "???" if you've never gone through an ascent, and there's a few descriptions that are already purposely mysterious to not be spoilery (can open a certain flesh door) but they could have a spoiler-full version added

And of course there would be an option to turn off any spoiler censoring.

So for instance:

Buurazu commented 1 month ago

It took exactly 2 years but modifying descriptions based on achievement status is now possible with conditionals. I haven't done any yet, aside from removing Sacrifice Poster's text about unlocking The Lost if you have unlocked him.

However, I don't think I'll personally be going with the route of trying to detect what's unlocked based on the player's type/items/location; instead, this feature will only be available for REPENTOGON users, unless/until reading save file info is added to the official modding API, or someone else works on a AB+/Rep friendly way. There could still be a setting for non-repentogon users to turn off spoilers (aka fail the conditionals, where normally they're assumed to have passed)

Leaving this open until I actually make more spoiler descs and the setting