update README.md

pull/1/head
telans 4 years ago
parent f3bedf3bce
commit fe206c19c0
No known key found for this signature in database
GPG Key ID: 195444EE92DBCB20

@ -1,16 +1,25 @@
# MangoHud
A modification of the Mesa vulkan overlay. Personal improvements including temperature reporting and logging capabilities.
A modification of the Mesa Vulkan overlay. Including GUI improvements, temperature reporting, and logging capabilities.
#### Comparison (outdated)
![](assets/overlay_comparison.gif)
# Installation
- Arch linux: [PKGBUILD](https://github.com/flightlessmango/PKGBUILDS/blob/master/mangohud/PKGBUILD)
First, clone this repository and cd into it:
`git clone https://github.com/flightlessmango/MangoHud.git; cd MangoHud`
Then simply run the following command:
`./build.sh install`
This will build and copy `libMangoHud.so` & `libMangoHud32.so` to `$HOME/.local/share/MangoHud`, as well as copying the required Vulkan layer configuration files.
# Normal usage
To enable the MangoHud vulkan overlay layer, run :
To enable the MangoHud Vulkan overlay layer, run :
`MANGOHUD=1 /path/to/my_vulkan_app`
@ -33,14 +42,16 @@ Note: Width and Height are set automatically based on the font_size, but can be
Example: `MANGOHUD_CONFIG=cpu_temp,gpu_temp,position=top-right,height=500,font_size=32`
## Environment Variables
- `MANGOHUD_OUTPUT` : Define name and location of the output file (Required for logging)
- `MANGOHUD_FONT`: Change default font (set location to .TTF/.OTF file )
## Keybindings
- `F2` : Toggle Logging
- `F12`: Toggle Hud
## MangoHud fps logging
## MangoHud FPS logging
When you toggle logging (using the keybind `F2`), a file is created with your chosen name (using `MANGOHUD_OUTPUT`) plus a date & timestamp.
@ -57,6 +68,7 @@ These filenames will be used as the legend in the graph.
![](assets/log_upload_example.gif)
# Notable changes
- Removed hud decoration [90a2212](https://github.com/flightlessmango/mesa/commit/90a2212055a8047d46d0220d5fdc30a76900aaed)
- Changed frametime graph to Lines instead of Histogram [e40533b](https://github.com/flightlessmango/mesa/commit/e40533b7f46858e5b9f08829e789277b2364d5d1)
- Set static min/max ms on frametime graph to act like Afterburners graph [df5238f](https://github.com/flightlessmango/mesa/commit/df5238f990218f5d6e698d572b05ddd19e52b108)

Loading…
Cancel
Save