Debugging section in readme (#763)

This commit is contained in:
Josh Jordan 2020-10-10 18:45:04 -04:00 committed by GitHub
parent b1cdb47302
commit d1d8a52810
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions

View File

@ -26,7 +26,7 @@ ALL OTHER TRADEMARKS ARE THE PROPERTY OF THEIR RESPECTIVE OWNERS.
## Status
At the moment (october 2020) the game starts, you can select any character and run around Act1 town.
At the moment (october 2020) the game starts, you can select any character and run around Act1 town.
Much work has been made in the background, but a lot of work still has to be done for the game to be playable.
@ -99,6 +99,14 @@ Ingame you can create a heap dump by pressing `~` and typing `dumpheap`. A heap.
You may need to install [Graphviz](http://www.graphviz.org/download/) in order to convert the profiler output.
## Debugging
### Layouts
Layouts can show their boundaries and other visual debugging information when they render. Set `layoutDebug` to `true` in `d2core/d2gui/layout.go` to enable this behavior.
![Example layout in debug mode](https://user-images.githubusercontent.com/1004323/85792085-31816480-b733-11ea-867e-291946bfff83.png)
## Roadmap
There is an in-progress [project roadmap](https://docs.google.com/document/d/156sWiuk-XBfomVxZ3MD-ijxnwM1X66KTHo2AcWIy8bE/edit?usp=sharing),