[xlcore][feature] Dxvk settings rework #1205

rankynbass · 2022-12-10T17:42:50Z

Edit: Links updated for building with marzent's suggestions added.

This PR will add the necessary framework to XIVLauncher.Common.Unix to allow XL Core to add several new features around DXVK. This is only the first part of the patch, but it needs to be in place before XL Core can be updated.

Moves all DXVK-related settings to a new class - DxvkSettings.
Adds support for DXVK version switching. Currently this includes 1.10.1 - 1.10.3, and 2.0. Default is 1.10.1, and it pulls from the dxvk-async repo just like before.
Adds support for DXVK_FRAMERATE_LIMIT. Setting the value to 0 sets framerate to unlimited.
Adds support for custom DXVK Hud strings. This includes verifying that you only used supported options.
Adds support for MangoHud
Actually does some checking on the file paths for MangoHud, so that you acutally have to pass it a file for MangoHud Custom.
Includes sensible fallbacks in the case that these changes are built against the current XL Core. Only the new DXVK hud options and MangoHud will show up, but it will build and run.
Change the 4th argument in the constructor method in Launcher.cs to have a default value of null; this is just to allow XL Core to build without changes.

I've been working on this for a while, trying to get it into a place where it would work in a flatpak environment without hanging or crashing. It's finally working now.

You can try it out for yourself by following the instructions here: XL Core Testing Flatpak, or build it by cloning my fork of XL Core and checking out the xlcore-fixes-plus-dxvk branch, and doing a dotnet publish

The master branch includes all the XL Core updates I'm working on, and the 1.0.2+new-dxvk-settings branch, is there to prove that it can be built against XL Core with no changes other than updating the submodule.

Here's some screenshots of how it looks (with XL Core patches).

Wine Tab:

Dxvk Tab:

Version Switcher:

Hud Switcher:

* Change the 4th arg in constructor to have a default value of null * xlcore calls this with only 3 args, so this allows compiling.

* Add dxvkVersion * Move dxvkAsync, dxvkHud into DxvkSettings * Set up dictionary for setting env vars. This will allow arbitrary number of vars to be set. * Reworked CompatibilityTools to support new features.

* uses DXVK_FRAME_RATE, so doesn't work with wineD3D * leave unset instead of 0, since that lets the user script it.

* Default is with no config * Custom will allow custom path to config file Currently uses ~/.config/MangoHud/MangoHud.conf by default. * Full shows almost everything. Very fun on a cpu with lots of cores and threads.

* Use ~/.xlcore/MangoHud.conf as first option for MangoHud Custom * If that doesnt' exist, use ~/.config/MangoHud/wine-ffxiv_dx11.conf * Finally, fall back to ~/.config/MangoHud/MangoHud.conf If it can't find any of those, it'll just present the default.

* DXVK Hud will only accept alphanumeric, comma, and = * MangoHud config file must exist

* If the file is not found, it will now just not set the file path * This will cause MangoHud to fall back to default locations which is unlikely to work in flatpak, but that's okay. * If the value passed is empty, it'll try to find a few default paths in .xlcore and .config/MangoHud

* set to empty config instead.

marzent

Thanks for bringing all DXVK settings together in one class, this is a nice change.

Just a few thoughts on even improving DXVK handling further:
Setting DXVK_LOG_PATH to the xlcore provided logs folder would be nice.
In the long run it would also be good to set DXVK_CONFIG_FILE and DXVK_STATE_CACHE_PATH to outside of the wine prefix, as that would make the shader state cache and DXVK configuration survive a prefix swap or deletion

marzent · 2022-12-10T17:57:26Z

src/XIVLauncher.Common.Unix/Compatibility/CompatibilityTools.cs

@@ -68,10 +66,28 @@ public CompatibilityTools(WineSettings wineSettings, Dxvk.DxvkHudType hudType, b
                this.dxvkDirectory.Create();
        }

+        if (!wineSettings.Prefix.Exists)


This seems to be duplicate code from line 80...
Actually there is no reason to do this at all since wine will create it's prefix folder on first startup anyways

So it is... deleting that. You know how it goes with copy/paste

marzent · 2022-12-10T17:59:54Z

src/XIVLauncher.Common.Unix/Compatibility/CompatibilityTools.cs

        if (!wineSettings.Prefix.Exists)
            wineSettings.Prefix.Create();
    }

+        public CompatibilityTools(WineSettings wineSettings, Dxvk.DxvkHudType hudType, bool? gamemodeOn, bool? dxvkAsyncOn, DirectoryInfo toolsFolder)


Honestly wouldn't bother adding that, it's just unnecessary clutter

That's fine. I was just putting it in so it would still build against unmodified xlcore. Deleting this as well.

marzent · 2022-12-10T18:03:00Z

src/XIVLauncher.Common/Game/Launcher.cs

@@ -40,7 +40,7 @@ public class Launcher

    private const string FALLBACK_FRONTIER_URL_TEMPLATE = "https://launcher.finalfantasyxiv.com/v620/index.html?rc_lang={0}&time={1}";

-    public Launcher(ISteam? steam, IUniqueIdCache uniqueIdCache, ISettings settings, string? frontierUrl)
+    public Launcher(ISteam? steam, IUniqueIdCache uniqueIdCache, ISettings settings, string? frontierUrl = null)


This seems out of scope for this PR

Fair enough. It was just in so I could build against unmodified xlcore. Can definitely remove.

marzent · 2022-12-10T18:03:19Z

src/XIVLauncher.Common/Game/Launcher.cs

@@ -71,7 +71,7 @@ public Launcher(ISteam? steam, IUniqueIdCache uniqueIdCache, ISettings settings,
        this.client = new HttpClient(handler);
    }

-    public Launcher(byte[] steamTicket, IUniqueIdCache uniqueIdCache, ISettings settings, string? frontierUrl)
+    public Launcher(byte[] steamTicket, IUniqueIdCache uniqueIdCache, ISettings settings, string? frontierUrl = null)


marzent · 2022-12-10T18:07:53Z

src/XIVLauncher.Common.Unix/Compatibility/DxvkSettings.cs

+            Dxvk.DxvkVersion.v1_10_2 => "1.10.2",
+            Dxvk.DxvkVersion.v1_10_3 => "1.10.3",
+            Dxvk.DxvkVersion.v2_0 => "2.0",
+            _ => VersionOutOfRange(),


This probably should be an ArgumentOutOfRangeException, as it is not really supposed to happen and you'd have to change the default DXVK version in the future in like 3 different places

Alright, found a couple of examples in the code and mimicked them. It compiles, and, as you said, this shouldn't ever actually happen to a normal user. Changed.

marzent · 2022-12-10T18:08:18Z

src/XIVLauncher.Common.Unix/Compatibility/DxvkSettings.cs

+        }
+    }
+
+    private string VersionOutOfRange() {


This is unneeded with the above change

And deleted.

marzent · 2022-12-10T18:16:06Z

src/XIVLauncher.Common.Unix/Compatibility/DxvkSettings.cs

+    public Dxvk.DxvkVersion DxvkVersion { get; private set; }
+
+    private const string ALLOWED_CHARS = "^[0-9a-zA-Z,=.]+$";
+    private const string ALLOWED_WORDS = "^(?:devinfo|fps|frametimes|submissions|drawcalls|pipelines|descriptors|memory|gpuload|version|api|cs|compiler|samplers|scale=(?:[0-9]){0,2}(?:.(?:[0-9])+)?)$";


Is there a reason for scale being < 100 ?
DXVK will allow such values and will sanitize them by itself, in fact the only restriction it enforces is scale >= 0.01:
https://github.com/doitsujin/dxvk/blob/c0d843c5788448ed66d61246c6ad8453c41c87fd/src/dxvk/hud/dxvk_hud.cpp#L13

I didn't know if there were any limits, it just seemed a reasonable high number. Scales over 10 are probably not useful unless you're on an 8K+ display, but it's easy enough to change {0,2} to *. So... changed.

marzent · 2022-12-10T18:22:58Z

src/XIVLauncher.Common.Unix/Compatibility/Dxvk.cs

+        [SettingsDescription("1.10.2", "Newer version of 1.10 branch of DXVK. Probably works.")]
+        v1_10_2,
+
+        [SettingsDescription("1.10.3", "Newer version of 1.10 branch of DXVK. Probably works.")]


1.10.3 for sure works with Dalamud + GShade; it's really only 2.0 that is creating trouble

Remove Launcher.cs commit; out of scope.

Changes per marzent's suggestions.

* Change 1.10.2 & .3 to say safe to use. * Change 2.0 to be less redundant.

rankynbass · 2022-12-10T20:34:08Z

Added the dxvk log to logs folder, and added a .dxvk folder for state cache. It'll even be possible to pass in the correct storage path, assuming we ever get around to allowing changing that. By default, just assumes ~/.xlcore, though.

rankynbass · 2022-12-10T20:57:45Z

Alright, should be good now as of commit df1a3be

rankynbass · 2022-12-10T21:35:37Z

And I'm not sure if sync/async need different caches, so I'm keeping them separate now. Hopefully that's everything.

marzent · 2022-12-10T21:48:44Z

And I'm not sure if sync/async need different caches, so I'm keeping them separate now. Hopefully that's everything.

Theoretically they shouldn't, but there is some bugginess with async and DXVK 2.0 where async will miss saving entries sometimes, so this is probably cleaner

marzent · 2022-12-10T21:50:48Z

src/XIVLauncher.Common.Unix/Compatibility/DxvkSettings.cs

+        this.DxvkHud = hud;
+        string home = Environment.GetEnvironmentVariable("HOME");
+        corePath ??= Path.Combine(home,".xlcore");
+        string dxvkConfigPath = Path.Combine(corePath,".dxvk");


Maybe it is cleaner to pass a DirectoryInfo into the cctor here as well, just in case the base xlcore storage path will change

That's just the default. You can pass in the correct path to the constructor; it just defaults to null and sets the default to ~/.xlcore in that case. XL Core's Program.cs creates a DxvkSettings object, and I've passed it in there. But I could change it to pass in a DirectoryInfo. It's probably more "correct". So now the storage.Root object can be passed in from XL Core, instead of the string storage.Root.FullName.

…rework

Dxvk settings rework additions

rankynbass · 2022-12-12T05:11:32Z

Pulled in marzent's commits. I am using the public static functions I declared in the XL.Core UI, so I added those back in.

rankynbass · 2022-12-13T01:03:34Z

Got rid of a useless function that marzent previously removed and I foolishly re-added because I panicked when I saw a compile error about missing function CheckMangoHudPath(). Since all the function did was call File.Exists(), I just had to update XL.Core to use that instead of the function in question.

That should be it for now. Everything seems to be working when I build PR #17, both natively and as a flatpak.

rankynbass · 2022-12-13T23:28:38Z

Should we bump the default version to 1.10.3, and leave 1.10.1 and .2 in there for compatibility/testing purposes?

marzent · 2023-01-05T07:00:07Z

Should we bump the default version to 1.10.3, and leave 1.10.1 and .2 in there for compatibility/testing purposes?

1.10.3 is perfectly fine on any platform and plays nicer with some nvidia drivers iirc

src/XIVLauncher.Common.Unix/Compatibility/DxvkSettings.cs

src/XIVLauncher.Common.Unix/Compatibility/CompatibilityTools.cs

rankynbass · 2023-09-23T03:42:31Z

Made obsolete by #1366

rankynbass added 13 commits December 5, 2022 20:06

fix: Launcher.cs changed to work with xlcore

fe921f6

* Change the 4th arg in constructor to have a default value of null * xlcore calls this with only 3 args, so this allows compiling.

feat: add DxvkSettings & related

72bd2e4

* Add dxvkVersion * Move dxvkAsync, dxvkHud into DxvkSettings * Set up dictionary for setting env vars. This will allow arbitrary number of vars to be set. * Reworked CompatibilityTools to support new features.

feat: add frame rate limit support

001ff3e

* uses DXVK_FRAME_RATE, so doesn't work with wineD3D * leave unset instead of 0, since that lets the user script it.

feat: add backend for dxvkhud custom string

7cc2a5a

feat: add support for MangoHud

c0f50f7

* Default is with no config * Custom will allow custom path to config file Currently uses ~/.config/MangoHud/MangoHud.conf by default. * Full shows almost everything. Very fun on a cpu with lots of cores and threads.

fix: disable MangoHud when using DXVK Hud

8381d03

fix: make sure mangohud.conf exists

435396e

fix: basic validity checking added for custom huds

5dba7dc

* DXVK Hud will only accept alphanumeric, comma, and = * MangoHud config file must exist

fix: improve dxvkhud checking with regex.

e4c4a4b

fix: add "1" as valid value for dxvkhud

d3fed4d

fix: flatpak breaks using fallback method

e31bf46

* set to empty config instead.

marzent suggested changes Dec 10, 2022

View reviewed changes

rankynbass and others added 5 commits December 10, 2022 11:25

Update CompatibilityTools.cs

f7b7aad

Update Launcher.cs

bf0fb66

Remove Launcher.cs commit; out of scope.

Update DxvkSettings.cs

ad34feb

Changes per marzent's suggestions.

Update Dxvk.cs

87282c6

* Change 1.10.2 & .3 to say safe to use. * Change 2.0 to be less redundant.

feat: Add dxvk log, cache, config

f47ddca

rankynbass added 2 commits December 10, 2022 12:45

fix: Make sure to create .dxvk folder

84ed999

fix: Fixed directory create function.

df1a3be

fix: keep aync/async shader cache separate

a4a7b38

marzent reviewed Dec 10, 2022

View reviewed changes

rankynbass and others added 3 commits December 10, 2022 15:44

fix: use DirectoryInfo for xlcore path

c138a3a

DxvkSettings refactor and formatting

f58c2f6

Merge remote-tracking branch 'goat_origin/master' into dxvk-settings-…

391cc43

…rework

rankynbass mentioned this pull request Dec 11, 2022

feat: add DXVK settings tab goatcorp/XIVLauncher.Core#17

Closed

marzent and others added 5 commits December 12, 2022 00:01

add DXVK enabled switch

b33dc79

Apply suggestions from code review

d7139c4

Update src/XIVLauncher.Common.Unix/Compatibility/DxvkSettings.cs

90849ae

Apply suggestions from code review

1b05cda

Merge pull request #13 from marzent/dxvk-settings-rework2

84b9637

Dxvk settings rework additions

fix: get rid of useless function

810bcc9

rankynbass requested a review from marzent December 17, 2022 18:14

update: dxvk version to 1.10.3

a5f6ffd

marzent approved these changes Jan 5, 2023

View reviewed changes

marzent mentioned this pull request Jan 17, 2023

Adding XIVLauncher2.Common Blooym/xl2#5

Merged

rankynbass added 2 commits January 26, 2023 16:59

Add dxvk 2.1 support (no async)

26b704c

Update for Dxvk 2.2

62fee28

marzent reviewed Jun 15, 2023

View reviewed changes

src/XIVLauncher.Common.Unix/Compatibility/DxvkSettings.cs Outdated Show resolved Hide resolved

src/XIVLauncher.Common.Unix/Compatibility/CompatibilityTools.cs Outdated Show resolved Hide resolved

Fix a couple of minor style issues in code

3726cde

rankynbass mentioned this pull request Jun 24, 2023

Compatibility rework #1348

Closed

rankynbass closed this Sep 23, 2023

rankynbass deleted the dxvk-settings-rework branch November 25, 2023 00:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[xlcore][feature] Dxvk settings rework #1205

[xlcore][feature] Dxvk settings rework #1205

rankynbass commented Dec 10, 2022 •

edited

Loading

marzent left a comment

marzent Dec 10, 2022

rankynbass Dec 10, 2022

marzent Dec 10, 2022

rankynbass Dec 10, 2022

marzent Dec 10, 2022

rankynbass Dec 10, 2022

marzent Dec 10, 2022

rankynbass Dec 10, 2022

marzent Dec 10, 2022

rankynbass Dec 10, 2022

marzent Dec 10, 2022

rankynbass Dec 10, 2022

marzent Dec 10, 2022

rankynbass Dec 10, 2022

marzent Dec 10, 2022

rankynbass commented Dec 10, 2022

rankynbass commented Dec 10, 2022

rankynbass commented Dec 10, 2022

marzent commented Dec 10, 2022

marzent Dec 10, 2022

rankynbass Dec 10, 2022

rankynbass commented Dec 12, 2022

rankynbass commented Dec 13, 2022

rankynbass commented Dec 13, 2022

marzent commented Jan 5, 2023

rankynbass commented Sep 23, 2023

[xlcore][feature] Dxvk settings rework #1205

[xlcore][feature] Dxvk settings rework #1205

Conversation

rankynbass commented Dec 10, 2022 • edited Loading

marzent left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rankynbass commented Dec 10, 2022

rankynbass commented Dec 10, 2022

rankynbass commented Dec 10, 2022

marzent commented Dec 10, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rankynbass commented Dec 12, 2022

rankynbass commented Dec 13, 2022

rankynbass commented Dec 13, 2022

marzent commented Jan 5, 2023

rankynbass commented Sep 23, 2023

rankynbass commented Dec 10, 2022 •

edited

Loading