flightlessmango / MangoHud

A Vulkan and OpenGL overlay for monitoring FPS, temperatures, CPU/GPU load and more. Discord: https://discordapp.com/invite/Gj5YmBb
MIT License
6.37k stars 283 forks source link

Userguide still sucks, 3 years later.. #1434

Open ruthan opened 1 week ago

ruthan commented 1 week ago

Hi, im back few years later and project description still sucks :( I lost a hour trying to madness like this nonsense: LD_PRELOAD=/usr/lib/mangohud/lib32/libMangoHud.so:/usr/lib/mangohud/lib32/libMangoHud_dlsym.so steam steam://rungameid/2200 Because description is not for BFU. There is not even clear how to find out if you lib32 or lib64 for LD_PRELOAD..

I had to on Mint23, build MangoHud to make is working with Goverlay, like 1 GB of libs and building support files to download, 15 minutes of compiling on my machine.. to find out that Goverlay is mostly preview of 2 simpless rotating cubes and gears.. yeah and RivaTurner lite monitoring parameters enabler..

There should be examples of LD_Preload and libMangoHud_dlsym.so

There should be in bold text, that you should click on Steam game, by rigth mouse then propeties, general and add to lauch option copy paste this string: mangohud %command% and %command% does not mean some text variable to replace or find out by user, as it usually in guides means.. and For vulkan use: 2 simple screenshots added to guide would do wonders, picture is better than 1000 words sometimes.

So hint how to discover if game is OpenGL or Vulkan would be nice too, or even autodetetion by Mangohud, it can clear detect DKVK without extra hint.

Just my 2 cents, im creating issues not bug.. and this are users for sure..

Leopard1907 commented 1 week ago

https://github.com/flightlessmango/MangoHud?tab=readme-ov-file#normal-usage

Description is very clear and very very easy. You likely didnt read?

If you did read; can you tell which part confused you?

To enable the MangoHud overlay layer for Vulkan and OpenGL, run :

mangohud /path/to/app

For Lutris games, go to the System options in Lutris (make sure that advanced options are enabled) and add this to the Command prefix setting:

mangohud

For Steam games, you can add this as a launch option:

mangohud %command%

Or alternatively, add MANGOHUD=1 to your shell profile (Vulkan only).

There isn't a single word in here that would lead user to ld preload for Steam games with appid?

Did you get such "tips" from ProtonDB etc?

ruthan commented 5 days ago

Its lost cause. I read it in the past and now and made same mistake twice, because its not clear. I wrote exactly why in my previous post. Launch option could mean also more than 1 thing, assume that user know nothing about that problem, that is not developer and provide step by step tutorial could save a lot of time.

I can only add "Or alternatively, add MANGOHUD=1 to your shell profile (Vulkan only)." again it would be nice to tell, where shell profile is assume that is bash and give user specific example..

By the way, i have some distros installed and it seems, that even with same game and same steam version, mangohud success rate depends heavy on installed Nvidia driver version or kernel. I was testing with Nvidia drivers 470 success rate was poor and later with Nvidia drivers 550 and HUD appeared much more often, almost in every game and tested same games sample. Problem could be in distro specific thing or if MangoHud was compiled locali. In teste it with Manjaro up to date expect grahics drivers - 470, Ubuntu 24.04 and Fedora 40.