Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Venture Adventure's debugging output to check for state changes #193

Merged

Conversation

MHLoppy
Copy link
Contributor

@MHLoppy MHLoppy commented May 13, 2024

Description

The current console debugging dumps a bunch of info every single cycle, which floods the console with mostly low-value information. Whilst whether the current debugging infodump is actually useful or not can be debated, in the meantime we can at least increase the signal-to-noise-ratio of the output by tracking the game state and comparing the current cycle's state vs the previous cycle's state.

If no change has been made, the infodump is not sent and a "waiting for changes..." message is sent once. Once the (tracked) state changes again, the updated infodump is sent.

Castiel mentioned how it was nice to be able to turn the debugging on/off by changing one line of code, so I've maintained this feature using a bool check before running the new code (change the bool to turn off the debugging output).

Type of change

  • Documentation (?)

How Has This Been Tested?

I built and ran Venture Adventure with the updated code and monitored the console output.

Testing Checklist

N/A

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation*
  • My changes generate no new warnings
  • I have requested will request a review from the team on Teams etc

* I'm working on some documentation updates elsewhere, so will include a note about flipping the bool in that documentation.

@MHLoppy
Copy link
Contributor Author

MHLoppy commented May 13, 2024

@github-actions github-actions bot added the compiled the source code has been successfully compiled label May 13, 2024
@MHLoppy MHLoppy marked this pull request as ready for review May 13, 2024 08:32
@MHLoppy MHLoppy changed the title Update debugging output to check for state changes Update Venture Adventure's debugging output to check for state changes May 13, 2024
Copy link
Contributor

@CastielM CastielM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Works a lot better to actually be able to stop and read the output!
And definitely nice to still be able to toggle it with once change.

I do think a lot of the output there is useful for debugging based on what I've worked on, but there's certainly room for improvement and/or making it easier to customize depending on what someone's working on.

We can ignore the error about the missing 'back' file, as I've resolved that in another PR. Looks like the libpng/sRGB warning is here too, not sure if that's a local thing to me or not but doesn't seem to cause any issues.

@CastielM
Copy link
Contributor

Looks good still after conflicts resolved

@omckeon
Copy link
Collaborator

omckeon commented May 16, 2024

@MHLoppy I've just updated the PingPong config.txt file to try to resolve the workflow failing. Try pulling that change into your fork/branch and commit that change, then you can message me on Teams to let me know and I can re-run the jobs. :)

@AmberPotion AmberPotion merged commit 42c95dc into thoth-tech:main May 20, 2024
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiled the source code has been successfully compiled
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants