Check Tracker - Version 1.0+

sonoftunk commented 1 year ago

With #1942 being merged into develop, that could be considered the v.1.0 of the Check Tracker. This issue attempts to lay out all further work to be or could be done on the Check Tracker in a version 1.1 or 2.0 beyond.

Feature: Support for Checked/Seen/Scummed/Hinted. At the moment, only Unchecked, Skipped, and Saved do anything.
Task: Interface Language. Several fields in the interface are English only. Most of these have been marked with //TODO Language, but there are some places that have not.
Feature: Better Vanilla support. Currently my goal has been to make Vanilla track 100% speedrun requirements, but it's only really roughly done right now. Further design discussions on which checks should show for Vanilla and implementation of them will be necessary
Bug: MQ Spoiled 1/12 chance. Because the MQ dungeon count is currently used to determine if the labels for MQ/Vanilla should show on the tracker, there's a chance that if 0 dungeons are rolled, then the labels would disappear and you'd know there's 0 MQ dungeons. Fix is to load the RSK_RANDOM_MQ_DUNGEONS setting instead and use it.
Feature: Last Location Checked. In an earlier version of the Check Tracker, an icon would show beside the last item you checked.
Feature: Sorting Schemes. Right now, only sorting by area is possible. This feature would allow users to select between different modes. For example, a Check Type so all Skulltullas are together, Heart Pieces, Major Items, etc.
Task: Fine tuning on Checks being Shown/Hidden - While the current logic on which checks are shown/hidden based on settings, there's still some fine tuning that can be done to work with all the settings. For example, @briaguya-ai has already pointed out for randomizers that tokens won't show unless Tokensanity is on, but you may want tokens to show anyways as the 10-50 skulltulla rewards may be needed.
Bug: Loading into Temple of Time doesn't auto-scroll the list.
Bug: Cross-support with Randomized entrances. The patch applied for Auto-scrolling was done so naively, such that grottos, fairy fountains, bazaar, and shooting gallery won't scroll properly if they aren't in their vanilla areas.
Task: Code reuse. There's code in a few places where it's re-inventing the wheel that other places are already implementing. Namely, Rainbow generation for UI elements, which already exists in CosmeticEditor and in Check Tracker.
Bug/Task: Locked Colours. At the moment, each of the colours in the Check Tracker shows a Locked checkbox due to the use of EnhancementColor. These Locks are meaningless in the context of the Check Tracker, as there is no Randomize All that affects them.
Task: UX enhancements. I'm not great with ImGui or UI/UX, so an entire pass to make it better can be done.
Feature: Search. In an earlier version of the Check Tracker, a search box was available that looked for only unchecked checks, but was eventually removed. This feature would add it back with proper area/check searching, checks properly updating when hidden via filter, etc.
Task: Enhanced Adult/Child indicators. Currently, Checks show and there's no indication of age requirement for them. This enhancement would add something (colour, text, letter) to the Check Tracker
Feature: In-Logic indicator. It's certainly possible to know whether a check is possible to be gotten via the items you have in your inventory. When this feature is enabled, it would show the Unchecked checks differently depending on if they can be retrieved or not
Feature: Glitch-Check indicator. Similar to the above, and when we have ability to include/exclude certain glitches, this feature would show checks as retrievable with glitches.
Feature: More Performance options. Right now there's only two options for Performance mode, on or off. This feature would add a combobox or slider of some kind to change the number of checks per frame to look for, rather than just 1 or all.

briaguya-ai commented 1 year ago

feature: exclude manually excluded checks (when setting up a seed with certain locations excluded, those should no longer appear on the check tracker)

briaguya-ai commented 1 year ago

the 3 scrubs that are always shuffled aren't showing up https://github.com/HarbourMasters/Shipwright/blob/43ff9713e939bd93a60b01c5d92965b4393a2576/soh/soh/Enhancements/randomizer/randomizer_check_tracker.cpp#L481

edit: moved this to a new issue https://github.com/HarbourMasters/Shipwright/issues/2160