Add Info Display

[ximk]

No description provided.

[Gaberboo]

It would be nice if the config file that is used is not tracked by git.

[malleoz]

To clarify, this file should ABSOLUTELY be committed. Because we always want to be able to provide it alongside the scripts (We don't expect the user to have to create this file manually themselves). However, we will want to ignore any changes to the file. Is this doable?

[Gaberboo]

It would work if this file was the default configuration and is used to supply configuration the main config file lacks.

[kierio04]

Would it be more beneficial to have an additional .py file to allow for further customisation using presets? For example:

• Default (Very basic info; only anything that a beginner might want - Frame Count, IV XYZ, Charges and Boosts, Checkpoints and Completion, Miscellaneous)
• TASing (More info than Default; what a more experienced TASer might want - Default + Speed, EV XYZ, MRV XYZ, MWV XYZ, Position)
• Micro (Info specific only to micro-optimisation - Frame Count, Lap Splits, Speed, Checkpoints and Completion, Position)
• Glitch (Info specific only to glitch hunting - Frame Count, Speed, IV XYZ, EV XYZ, Charges and Boosts, Checkpoints and Completion, Miscellaneous)
• All (All info available is shown, excepting any additional checks made in the infodisplay script itself, e.g. SMT only displays for karts)
• Custom (Whatever is defined in the ini file, which is shipped with the same settings as the Default preset)

I'm aware a lot of these have very few differences for now, but as more stuff gets added to infodisplay, more stuff will only cater to certain people/environments, making it useful to have presets to switch between.

[ximk]

Would it be more beneficial to have an additional .py file to allow for further customisation using presets? For example:

• Default (Very basic info; only anything that a beginner might want - Frame Count, IV XYZ, Charges and Boosts, Checkpoints and Completion, Miscellaneous)
• TASing (More info than Default; what a more experienced TASer might want - Default + Speed, EV XYZ, MRV XYZ, MWV XYZ, Position)
• Micro (Info specific only to micro-optimisation - Frame Count, Lap Splits, Speed, Checkpoints and Completion, Position)
• Glitch (Info specific only to glitch hunting - Frame Count, Speed, IV XYZ, EV XYZ, Charges and Boosts, Checkpoints and Completion, Miscellaneous)
• Custom (Whatever is defined in the ini file, which is shipped with the same settings as the Default preset)

I'm aware a lot of these have very few differences for now, but as more stuff gets added to infodisplay, more stuff will only cater to certain people/environments, making it useful to have presets to switch between.

Personally, I think an external guide of recommendations for certain scenarios (and just common sense) would negate the need for presets.

[vabold]

I like the idea of presets. May be out of the scope of this PR.

[malleoz]

I agree that presets are nice, but also agree that it is out of scope. Let's try to get this merged with this basic .ini config file.

I believe we are in agreement that the plan is to populate the config object with a ['DEFAULT'] configuration. Upon setting this object, we should then check to see if the config.ini file has been created. If not, we should copy the DEFAULT configurations to the file. Afterwards, the user will be able to see the default info display in-game, and now be able to edit the generated config.ini file to make the appropriate changes.

[kierio04]

In that case, I still think we should remove some of the things from being displayed by default. I believe there should only be; Frame Count, Speed, EV XZ/XYZ, Charges and Boosts, Checkpoints and Completion, and Airtime. This means:

• Adding an Airtime parameter, defaulting it to True
• Removing Airtime from the Miscellaneous block in create_infodisplay()
• Defaulting Surface Properties to False
• Defaulting Position to False

Also, we should decide on some consistency regarding the speed/velocity sections. I believe the following should be our layout:

• IV X/Y/Z and IV XZ/XYZ as the two parameters to toggle (by default, both False)
• EV X/Y/Z and EV XZ/XYZ as the two parameters to toggle (by default, False and True)
• MRV X/Y/Z and MRV XZ/XYZ as the two parameters to toggle (by default, both False)
• MWV X/Y/Z and MWV XZ/XYZ as the two parameters to toggle (by default, both False)

[malleoz]

Applied all changes from my review to xi's branch. I've limited the digits config so that it will be a max of 7 digits.
Awaiting @vabold opinion on if we should change the time functions to a dataclass still.

[vabold]

Applied all changes from my review to xi's branch. I've limited the digits config so that it will be a max of 7 digits.
Awaiting @vabold opinion on if we should change the time functions to a dataclass still.

The base game has a timer class, tracking minutes, seconds, milliseconds, and whether or not the timer is active. It's created on the stack frequently, so I'd say it's a good idea to allow the same thing here.

[malleoz]

Updated to include a dataclass that abstracts away time manipulation.

[malleoz]

Added a commit to address the info display flickering for the frame a savestate is loaded.

[vabold]

Backend looks good to me. LGTM assuming _draw_info_display.py is tested and reviewed by someone on the frontend.