search

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.35k stars 281 forks source link

Change description how a wine-application conf file has to be named #654

Open Elendil211 opened 2 years ago

Elendil211 commented 2 years ago

The current description is unintuitive. I didn't get it, asked in a forum, and the most common answer was basically that it's not working.

I suggest something in the form of:

  1. /path/to/application/dir/MangoHud.conf for native applications

  2. Per-application configuration in ~/.config/MangoHud: i. ~/.config/MangoHud/<application_name>.conf for native applications where <application_name> is the case sensitive name of the executable ii. ~/.config/MangoHud/wine-<application_name>.conf for wine/proton apps, where <application_name> is the case sensitive name of the actually running executable (not a launcher) without the .exe ending. For example for Overwatch, this would be Overwatch.conf because the actual game is Overwatch.exe, even though the executable you run from Lutris is Battle.net.exe

  3. ~/.config/MangoHud/MangoHud.conf

flightlessmango commented 2 years ago

That it's case sensitive and that it doesn't include the .exe could be good to mention. I don't see it very likely that people will assume that they should use the app name of a different app that isn't the app they want to config, I think it might make it more confusing by trying to guard for that

Elendil211 commented 2 years ago

I think it's also important to mention that wine- is a prefix that is not to be replaced by the app name. It's not exactly clear, that it's wine-(application_name) and not (wine-application)_name. That's why I added the <>.

And I tried configuring BattleNet because it's the app that is started in Lutris. CoreCtrl for example requires to make a profile for BattleNet. I guess this is the case with every game that is launched via a launcher. This is unintuitive, though - you're definitely right there. Someone who doesn't use CoreCtrl might not try this. On the other hand, many players might not even know that Overwatch.exe even exists, because you never have to start it manually (you always use the launcher).

I mentioned all of this because that's precisely what I tried doing. Maybe it would be a good way split it up and in the same turn also provide an example:

  1. /path/to/application/dir/MangoHud.conf for native applications
  2. Per-application configuration in ~/.config/MangoHud: i. ~/.config/MangoHud/<application_name>.conf for native applications where <application_name> is the case sensitive name of the executable ii. ~/.config/MangoHud/wine-<application_name>.conf for wine/proton apps, where <application_name> is the case sensitive name of the executable without the .exe ending.
  3. ~/.config/MangoHud/MangoHud.conf

Example: For Overwatch, this would be wine-Overwatch.conf (even though the executable you run from Lutris is Battle.net.exe, the actual game executable name is Overwatch.exe)

If you start the game from the terminal with MangoHud enabled (for example by starting Lutris from the terminal), it will tell you the the config file names it is looking for.

jackun commented 2 years ago

Probably doesn't need underscore in application_name either but leave it to future PR ;P