From 13aec7401f69629e9192669795987de6709c64f1 Mon Sep 17 00:00:00 2001 From: Farhan Hakim D Date: May 14 2025 02:32:46 +0000 Subject: [PATCH 1/4] Add 'Using mangohud' section on steam --- diff --git a/modules/ROOT/assets/images/steam_game_properties.png b/modules/ROOT/assets/images/steam_game_properties.png new file mode 100644 index 0000000..6ed57cf Binary files /dev/null and b/modules/ROOT/assets/images/steam_game_properties.png differ diff --git a/modules/ROOT/assets/images/steam_mangohud.png b/modules/ROOT/assets/images/steam_mangohud.png new file mode 100644 index 0000000..42b121d Binary files /dev/null and b/modules/ROOT/assets/images/steam_mangohud.png differ diff --git a/modules/ROOT/pages/monitoring.adoc b/modules/ROOT/pages/monitoring.adoc index be18b9e..9ebce03 100644 --- a/modules/ROOT/pages/monitoring.adoc +++ b/modules/ROOT/pages/monitoring.adoc @@ -29,6 +29,37 @@ sudo dnf install mangohud ==== Graphical Install ==== MangoHUD is searchable in your fedora graphical package manager such as Gnome Software and KDE Discover. +// TODO: Create a detailed step by step guide for MangoHUD installation using Gnome Software and KDE Discover. NOTE: You will see two seperate version of mangoHUD when searching for it in the Graphical Package Manager, "Fedora (Linux)" as well as "Flatpak". To summarize the difference between both version, Fedora (Linux) version will install mangoHUD system wide (but not Flatpak application) while Flatpak version will only be able to be use on Flatpak applications. +==== Using MangoHUD ==== + +===== Steam ===== + +To use MangoHUD ingame, you will need to add `mangohud` to your game launch options as detailed below: + +1. Right click on the game that you want to enable MangoHUD overlay and click on "properties" ++ +image::steam_game_properties.png[width=100%] ++ +2. Under launch options, add the following line, ++ +image::steam_mangohud.png[800, 600] ++ +---- +mangohud %command% +---- ++ +3. Click apply and launch the game. + + +NOTE: By default MangoHUD overlay will not be enabled ingame, you will need to press the default key combo to enable it. The default combo key is `SHIFT + F12` to toggle the overlay. + +[TIP] +-- +If you are using `gamemode` to run you games in steam, you can chain the launch option together. Here's an example of launch option to use if using MangoHUD with gamemode +---- +mangohud gamemoderun %command% +---- +-- From a20a7a3a895f419608a7e66e78c3f5a23a4ccd79 Mon Sep 17 00:00:00 2001 From: Farhan Hakim D Date: May 14 2025 03:21:25 +0000 Subject: [PATCH 2/4] Formatting and correction, add additional info on usage --- diff --git a/modules/ROOT/pages/monitoring.adoc b/modules/ROOT/pages/monitoring.adoc index 9ebce03..f5f3f78 100644 --- a/modules/ROOT/pages/monitoring.adoc +++ b/modules/ROOT/pages/monitoring.adoc @@ -33,9 +33,42 @@ MangoHUD is searchable in your fedora graphical package manager such as Gnome So NOTE: You will see two seperate version of mangoHUD when searching for it in the Graphical Package Manager, "Fedora (Linux)" as well as "Flatpak". To summarize the difference between both version, Fedora (Linux) version will install mangoHUD system wide (but not Flatpak application) while Flatpak version will only be able to be use on Flatpak applications. -==== Using MangoHUD ==== +=== Using MangoHUD === -===== Steam ===== +==== Keyboard commands ==== + +Common keyboard combo to control MangoHUD ingame are as follows: + +[cols="1,1"] +|=== +|Key Combo |Control + +|R-SHIFT+F12 +|Toggle overlay + +|R-SHIFT+F12 +|Change overlay position + +|R-SHIFT+F10 +|Toggle preset + +|L-SHIFT+F2 +|Toggle logging + +|L-SHIFT+F4 +|Reload configuration +|=== + +==== Testing ==== + +You can test your MangoHUD installation by running glxgears, which should be pre-installed in fedora. Run the following command on your terminal. + +[source,bash] +---- +mangohud glxgears +---- + +==== Steam ==== To use MangoHUD ingame, you will need to add `mangohud` to your game launch options as detailed below: @@ -54,7 +87,7 @@ mangohud %command% 3. Click apply and launch the game. -NOTE: By default MangoHUD overlay will not be enabled ingame, you will need to press the default key combo to enable it. The default combo key is `SHIFT + F12` to toggle the overlay. +NOTE: By default MangoHUD overlay will not be enabled ingame, you will need to press the default key combo to enable it. The default combo key is `R-SHIFT + F12` to toggle the overlay. [TIP] -- From f901defb7ff881c2f7040f44fd17a958ef12b7a4 Mon Sep 17 00:00:00 2001 From: Farhan Hakim D Date: May 14 2025 03:42:44 +0000 Subject: [PATCH 3/4] Add mangohud GUI install - KDE Discover --- diff --git a/modules/ROOT/assets/images/mangohud_discover.png b/modules/ROOT/assets/images/mangohud_discover.png new file mode 100644 index 0000000..3fa5880 Binary files /dev/null and b/modules/ROOT/assets/images/mangohud_discover.png differ diff --git a/modules/ROOT/pages/monitoring.adoc b/modules/ROOT/pages/monitoring.adoc index f5f3f78..b2766b0 100644 --- a/modules/ROOT/pages/monitoring.adoc +++ b/modules/ROOT/pages/monitoring.adoc @@ -33,6 +33,13 @@ MangoHUD is searchable in your fedora graphical package manager such as Gnome So NOTE: You will see two seperate version of mangoHUD when searching for it in the Graphical Package Manager, "Fedora (Linux)" as well as "Flatpak". To summarize the difference between both version, Fedora (Linux) version will install mangoHUD system wide (but not Flatpak application) while Flatpak version will only be able to be use on Flatpak applications. + +===== KDE Discover ===== + +image::mangohud_discover.png[width=100%] + +On Fedora KDE Edition, you can open Discover and search for MangoHUD to install. Note that they will be two entries for MangoHUD, one for system install and another for Flatpak install. Install both if you're planning on using MangoHUD on both system install and flatpak applications. + === Using MangoHUD === ==== Keyboard commands ==== From 116dc7b839cb2580840fe539b86ff2ccc84d54e8 Mon Sep 17 00:00:00 2001 From: Farhan Hakim D Date: May 14 2025 04:34:00 +0000 Subject: [PATCH 4/4] Add mangohud configuration guide --- diff --git a/modules/ROOT/pages/monitoring.adoc b/modules/ROOT/pages/monitoring.adoc index b2766b0..c2fcbfc 100644 --- a/modules/ROOT/pages/monitoring.adoc +++ b/modules/ROOT/pages/monitoring.adoc @@ -103,3 +103,42 @@ If you are using `gamemode` to run you games in steam, you can chain the launch mangohud gamemoderun %command% ---- -- + +=== Configuring MangoHUD === + +==== Graphical Configuration Tool ==== + +You can configure and customize your MangoHUD overlay by using goverlay. It provides a graphical way to customize the look of the MangoHUD overlay with preview, you can even change the keyboard combo key if the defaults is not to your preference. +Goverlay is included in fedora repository, so you can directly search the package using your Graphical Package Manager (Gnome Software, KDE Discover), or you can install goverlay using the terminal using the following command. + +[source,bash] +---- +sudo dnf install goverlay +---- + +Then find "Goverlay" in your application launcher to start customizing MangoHUD overlay to your liking. + +==== Config Files ==== + +By default, MangoHUD will use a preset configuration out of the box. To customize the file manually, you can create a configuration file per user under your `~/.config` folder. +Create the file using the following command + +[source,bash] +---- +mkdir ~/.config/MangoHud +touch ~/.config/MangoHud/MangoHud.conf +---- + +You can then edit the file using you preferred text editor, for example + +[source,bash] +---- +vi ~/.config/MangoHud/MangoHud.conf +---- + +You can refer to the example configuration to get you started located here. +---- +/usr/share/doc/mangohud/MangoHud.conf.example +---- + +