Archives/MangoHud
2
0
Fork 0
mirror of https://github.com/flightlessmango/MangoHud.git synced 2024-10-31 15:20:13 +00:00
Code Issues Projects Releases Wiki Activity
20 Commits 53 Branches 32 Tags 567 MiB
C 55.9%
C++ 39.4%
Python 2%
Shell 1.6%
Meson 0.9%
Other 0.2%
d2cd2c5743
Go to file
telans d2cd2c5743
revert part of "ignore compiler warnings"; fixed on master
2020-01-30 07:36:25 +13:00
assets MangoHud Standalone 2020-01-28 05:11:05 +01:00
bin remove unused git_sha1.h 2020-01-29 21:35:09 +13:00
include/vulkan MangoHud Standalone 2020-01-28 05:11:05 +01:00
modules meson.build for ImGui 2020-01-28 05:30:51 +01:00
src remove unused mesa-overlay-control.py 2020-01-29 23:25:16 +13:00
.gitignore build.sh: add version to package 2020-01-29 23:43:01 +13:00
.gitmodules Added needed submodules 2020-01-28 05:06:48 +01:00
build.sh build.sh: add version to package 2020-01-29 23:43:01 +13:00
meson.build revert part of "ignore compiler warnings"; fixed on master 2020-01-30 07:36:25 +13:00
README.md update README.md 2020-01-28 20:39:49 +13:00

README.md

MangoHud

A modification of the Mesa Vulkan overlay. Including GUI improvements, temperature reporting, and logging capabilities.

Comparison (outdated)

Installation

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 :

MANGOHUD=1 /path/to/my_vulkan_app

Or alternatively, add MANGOHUD=1 to your shell profile.

MANGOHUD_CONFIG parameters

You can customize the hud by using the MANGOHUD_CONFIG environment variable while separating different options with a comma.

  • cpu_temp : Displays current CPU temperature
  • gpu_temp : Displays current GPU temperature
  • core_load : Displays current CPU load per core
  • font_size : Changes the default font size (default is 24)
  • width : Set custom hud width
  • height : Set custom hud height
  • position=x: Available values for x include top-left, top-right, bottom-left, and bottom-right

Note: Width and Height are set automatically based on the font_size, but can be overridden.

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

When you toggle logging (using the keybind F2), a file is created with your chosen name (using MANGOHUD_OUTPUT) plus a date & timestamp.

This file can be uploaded to Flightlessmango.com to create graphs automatically. you can share the created page with others, just link it.

Multiple log files

It's possible to upload multiple files when using Flightlessmango.com. You can rename them to your preferred names and upload them in a batch. These filenames will be used as the legend in the graph.

Log uploading walkthrough

Notable changes

  • Removed hud decoration 90a2212
  • Changed frametime graph to Lines instead of Histogram e40533b
  • Set static min/max ms on frametime graph to act like Afterburners graph df5238f
  • Added CPU/GPU usage (Only Nvidia and AMD)
  • Changed font to UbuntuMono-Bold 73f0aa9
  • Increased hud font size b7d238b