Repository navigation
feat(diagnostics): developer diagnostics and runtime inspection (DEBUG-1) - #152
Merged
Merged
Conversation
…gine meter (DEBUG-1)
… and crash reports (DEBUG-1)
…example (DEBUG-1)
|
Preview of 4320fe2 (candidates demos): https://micro-engine-3jyftqe8w-nastmzs-projects.vercel.app |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #119.
Evaluation:
docs/evaluations/debug-1.md. Record:odd/tasks/debug-1.md.What an external developer can now do
Game.Diagnosticsreports the last frame's events, update, render and present times, steps, allocations, collections per generation, draw calls and audio voices, plus the time of every frame system (FrameSchedule.MeasureTime/Times(phase)). Off by default, free while off."MicroEngine"(dotnet-counters monitor --counters MicroEngine); a listener turns measuring on.Game.DebugDraw(lines, rects, circles, points, text; world or screen space; one frame or N seconds) andDebugDraw.Physics(world).IPhysicsWorld2D.ShapesOf/DescriptionOf(default members, newPhysicsCapabilities.ShapeInspection, declared by both backends),TilePhysicsWorld2D.GridOf.InputSystem.Trace/Routed, the layer that took each event.ILog:PlatformRequest.Log; SDL and raylib messages are replayed into the game's log at start (same console text by default).crash-<time>.txtto the save folder and names it (CrashReport,HostEnvironment.CrashDirectory).IGraphicsDevice.Counters,AudioMixer.Statistics.Docs: new manual page "Diagnosing a game", a Diagnostics example in
samples/Examples(F3), release notes, regenerated API pages.Checks
dotnet test MicroEngine.slnx -c Release: all pass exceptMicroEngine.Desktop.Testsclipboard check, which also fails intermittently onmainon the same machine (2 of 3 runs).api-reference --check, site tests 71/71,SITE_DEMOS=none npm run buildwith check-dist.Not verified: desktop windows (SDL/raylib), browser and mobile runs of the overlay;
dotnet-countersagainst a live process.Risk: item 3. The shared frame loop takes the measured path while diagnostics are active, and backend messages reach the console when the game starts instead of when the platform is created (same text). Additive contract members only, with defaults.