Steam Compatibility Tool installer #99

rankynbass · 2023-11-25T03:02:02Z

Adds a tab in the settings menu to install as a steam compatibility tool. The tab also provides some basic instructions. Once the tool is installed and configured in FFXIV in steam, xlcore can be launched directly from the FFXIV steam entry. It is not inside a flatpak, so FFXIV will properly close.

There are two downsides that I can't work around.

When the flatpak is used the first time to install as a compatibility tool it will still cause problems with steam. That is, the tool in compatibility mode causes no problems, but the flatpak itself stll does. It may also cause issues if someone selects it as a compatibility tool for a different game.
Whenever the tool is reinstalled or updated, it will cause a shader recompile on next launch (if shader pre-caching is enabled). This doesn't actually affect the game, and can be skipped, but unfortunately I don't know how to prevent it.

Tab when launched as a Flatpak:

Tab when launched as a Steam compatibility tool:

Entry in Steam compatibility list:

Cleaned up Steam Tool Settings Tab Added command line install options: --deck-install, --deck-remove to install to default paths --install=/path/to/Steam, --remove= to specify path

philpax · 2024-03-23T02:14:16Z

Apologies for letting this languish, as well as your other PRs. Is this/the other PRs still good to go? Anything you'd like to change?

rankynbass · 2024-03-23T02:29:36Z

I need to test two changes before this can be merged. Should have it done in the next 24 hours.

Edit: At the moment, this will trigger the stuttering bug unless LD_PRELOAD= is set in the steam launch arguments. I am testing a fix which seems to work.

KazWolfe · 2024-03-23T02:36:25Z

Assuming we want to move forward with this, I would like to advocate that we encourage the player install the game to wherever Steam wants to install it (that is, the game install should be next to the Steam-downloaded launcher files).

At least in my experience, all the normal issues that come with the launcher on SD card no longer exist when a compatibility tool is used. Users would be able to install FFXIV fully to the SD card and experience a normal play environment, and net us the added benefit of users being able to easily uninstall FFXIV to free up space without manually editing directories. I'm not sure how possible/valuable it would be to attempt to get XLCore to also use the "standard" paths for everything, but it would be nice if the user could swap back to standard Proton at will and keep their save files/game configurations.

Env vars on my test system:

# workaround flatpak being annoying (??)
export LD_LIBRARY_PATH=
export LD_PRELOAD=
export XL_SECRET_PROVIDER=FILE
export IgnoreChildProcesses=0

rankynbass · 2024-03-23T03:12:48Z

What is the IgnoreChildProcess? Any documentation on that?

KazWolfe · 2024-03-23T03:16:26Z

Unsure - I brought it in as a synced var from lsteamclient. I don't actually remember what it is...

rankynbass · 2024-03-23T16:20:13Z

Alright, this should be ready to go. Problem I was troubleshooting turned out to be elsewhere.

rankynbass · 2024-03-23T17:08:50Z

Here's an updated picture of the installer screen.

KazWolfe · 2024-03-23T18:19:39Z

Is it possible to hide the non-Steam Deck buttons on the Steam Deck?

rankynbass · 2024-03-23T19:36:12Z

Absolutely. I've done that. Also, the flatpak install option will be hidden if flatpak steam settings folder is not detected. There's no quick and easy path to check to find out if flatpak steam is installed. The best I could figure is actually flatpak info com.valvesoftware.Steam, and then check if the first line starts with "error". If it does, flatpak steam isn't installed. I haven't actually done that, though. Just checking to see if the paths are available for install atm.

rankynbass · 2024-03-23T20:13:14Z

Flatpak test build: https://github.com/rankynbass/XIVLauncher.Core/releases/tag/steamtool-1

philpax · 2024-03-25T00:39:53Z

Code looks good to me. Can someone try that test build? If it's alright, I'll merge it

Blooym · 2024-03-26T07:36:29Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+                        "\nuninstall button.");
+            return;
+        }
+        ImGui.Text("\nUse this tab to install XIVLauncher.Core as a Steam compatibility tool.");


I think it would be a good idea to have the opening explain quickly what a "steam tool" is and why a user might want to use it. (We could also do this in the FaQ or link to an explainer elsewhere?)

Blooym

I mostly just have some phrasing adjustments that I think make sense, feel free to not use my wording if you think it doesn't make sense though.

I do however have reservations about how we implement this as having users to manually update the steam compat tool every time we update the flatpak feels like a recipe for having users just never update the launcher which is going to be a headache. If we can solve that problem I'm happy to continue.

I'd also like if the flatpak and native steam options were condensed into singular option with buttons underneath the path for the default locations of native steam and flatpak steam. Do people use both together?

Blooym · 2024-03-26T07:39:35Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+        }
+        if (!steamToolInstalled) ImGui.EndDisabled();
+
+        if (CoreEnvironmentSettings.IsDeck != true && steamFlatpakInstalled)


Suggested change

if (CoreEnvironmentSettings.IsDeck != true && steamFlatpakInstalled)

if (!CoreEnvironmentSettings.IsDeck && steamFlatpakInstalled)

Actually, I made a mistake here. This should be !Program.IsSteamDeckHardware. CoreEnvironmentSettings is just checking environment variables.

Blooym · 2024-03-26T07:42:42Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+    {
+        Entries = new SettingsEntry[]
+        {
+            steamPath = new SettingsEntry<string>("Steam Path (native install)", "Path to the native steam config files. Only change this if you have your steam config stored somewhere else.",


Suggested change

steamPath = new SettingsEntry<string>("Steam Path (native install)", "Path to the native steam config files. Only change this if you have your steam config stored somewhere else.",

steamPath = new SettingsEntry<string>("Steam Path (native)", "Path to the native steam installation. Only change this if you have steam installed in a non-default location.",

Blooym · 2024-03-26T07:43:53Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+        {
+            steamPath = new SettingsEntry<string>("Steam Path (native install)", "Path to the native steam config files. Only change this if you have your steam config stored somewhere else.",
+                () => Program.Config.SteamPath ?? Path.Combine(CoreEnvironmentSettings.HOME, ".local", "share", "Steam"), s => Program.Config.SteamPath = s),
+            steamFlatpakPath = new SettingsEntry<string>("Steam Path (flatpak install)", "Path to the flatpak steam config files. Only change this if you have your steam config stored somewhere else.",


Suggested change

steamFlatpakPath = new SettingsEntry<string>("Steam Path (flatpak install)", "Path to the flatpak steam config files. Only change this if you have your steam config stored somewhere else.",

steamFlatpakPath = new SettingsEntry<string>("Steam Path (flatpak)", "Path to the flatpak steam installation. Only change this if you have your flatpak steam installed in a non-default location.",

Blooym · 2024-03-26T07:46:11Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+
+    public override SettingsEntry[] Entries { get; }
+
+    public override bool IsUnixExclusive => true;


As far as I'm aware steam compatibility tools are Linux exclusive and this property only hides this page from Windows users. We don't actually release on Mac at all right now but I still wanna point this out.

Blooym · 2024-03-26T07:48:21Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+            ImGui.Text("If you are trying to upgrade, you must first update your local install of XIVLauncher.Core. Then launch the local" +
+                        "\nversion, navigate back to this tab, and re-install as a Steam compatibility tool.");
+            ImGui.Text("\nIf you are trying to uninstall, you should likewise launch the native version of XIVLauncher, and click the appropriate" +
+                        "\nuninstall button.");


Is there any way for us to do these updates on behalf on the end user instead of having them update the tool manually every time XIVLauncher updates? If we know they want the steam tool installed via a config field like wantsSteamTool then we can transparently update it on their behalf on launch.

At least in my experimental config on Steam Deck, XLCore launched through the flatpak command works just fine. I'm curious if we can generate the script accordingly. We can probably both check for XIVLauncher.Core in $PATH and try to launch via Flatpak if the binary does not exist where we expect it to.

I'm not immediately aware of downsides to allowing $PATH to resolve xlcore nor attempting a Flatpak run, but admittedly my own scope here is pretty narrow.

The only issue I see with calling the flatpak is that the flatpak version of steam is not able to do that easily unless it has flatpak-spawn --host privilege iirc.

It's actually possible to download a tar.gz file and overwrite the steam tool in place, although you have to restart both the launcher and steam for some changes to take effect. I've successfully done this when I explored steam tool possibility back around 1.0.4. That would leave the flatpak or native install un-updated, though.

Perhals we could distribute a small installer script that installs XL as a compatibility tool and then having it auto update itself, skipping the Flatpak?

Blooym · 2024-03-26T07:56:24Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+        ImGui.Text("\nAfter you have installed XIVLauncher as a Steam tool, close this program, and launch Steam. Select Final Fantasy XIV from the library,");
+        ImGui.Text("and go to Compatibility. Force the use of a specific Steam Play compatibility tool, and choose XIVLauncher.Core as Compatibility Tool.");
+        ImGui.Text("XIVLauncher.Core will now be used to launch Final Fantasy XIV.");


I wanted to reword this to be a little more explicit for users that may get confused why it doesn't show up in the list, or cannot find the compatibility tab.

Suggested change

ImGui.Text("\nAfter you have installed XIVLauncher as a Steam tool, close this program, and launch Steam. Select Final Fantasy XIV from the library,");

ImGui.Text("and go to Compatibility. Force the use of a specific Steam Play compatibility tool, and choose XIVLauncher.Core as Compatibility Tool.");

ImGui.Text("XIVLauncher.Core will now be used to launch Final Fantasy XIV.");

ImGui.Text("\nAfter you have installed XIVLauncher as a Steam compatibility tool please close XIVLauncher and launch or restart Steam. Find 'Final Fantasy XIV Online' in your steam library");

ImGui.Text("and open the 'Properties' menu and navigate to the 'Compatibility' tab. Enable 'Force the use of a specific Steam Play compatibility tool' and from the dropdown menu select 'XIVLauncher.Core'. If this option does not show up then restart Steam and try again.");

ImGui.Text("After finishing these steps, XIVLauncher will now be used when launching FINAL FANTASY XIV from steam.");

Blooym · 2024-03-26T07:57:54Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+        ImGui.Text("XIVLauncher.Core will now be used to launch Final Fantasy XIV.");
+        if (CoreEnvironmentSettings.IsDeck != true && steamFlatpakInstalled)
+        {
+            ImGui.Text("\nIf you wish to install into Flatpak Steam, you must use Flatseal to give XIVLauncher access to Steam's flatpak path. This is probably something like:");


Suggested change

ImGui.Text("\nIf you wish to install into Flatpak Steam, you must use Flatseal to give XIVLauncher access to Steam's flatpak path. This is probably something like:");

ImGui.Text("\nIf you wish to install into Flatpak Steam, you must use Flatseal to give XIVLauncher access to Steam's flatpak path. This is commonly found at:");

Blooym · 2024-03-26T07:58:30Z

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

+        if (CoreEnvironmentSettings.IsDeck != true && steamFlatpakInstalled)
+        {
+            ImGui.Text("\nIf you wish to install into Flatpak Steam, you must use Flatseal to give XIVLauncher access to Steam's flatpak path. This is probably something like:");
+            ImGui.Text($"{CoreEnvironmentSettings.HOME}/.var/app/com.valvesoftware.Steam. If you do not give this permission, installation will fail. You will probably also want to");


Suggested change

ImGui.Text($"{CoreEnvironmentSettings.HOME}/.var/app/com.valvesoftware.Steam. If you do not give this permission, installation will fail. You will probably also want to");

ImGui.Text($"{CoreEnvironmentSettings.HOME}/.var/app/com.valvesoftware.Steam. If you do not give this permission, installation will fail. You will also want to");

Blooym · 2024-03-26T08:01:26Z

src/XIVLauncher.Core/UnixCompatibility/SteamCompatibilityTool.cs

+        // File.SetUnixFileMode() doesn't exist, for some reason, so just run chmod
+        var psi = new ProcessStartInfo("/bin/chmod");


Very strange that SetUnixFileMode isn't available here.

It's not available in dotnet 6. We can switch to it if we upgrade to 8. https://learn.microsoft.com/en-us/dotnet/api/system.io.file.setunixfilemode?view=net-8.0. You can see in the Applies To section that it's for 7 and later.

rankynbass · 2024-03-27T15:23:07Z

Added the rewording suggestions, and fixed the deck check to use the correct variable.

rankynbass · 2024-04-13T14:22:42Z

Okay, I think this is the best state I can get this in without building a newer version of Facepunch Steamworks with Floating Keyboard. Steam input works fine in Gaming Mode, and external keyboard entry works fine in desktop mode. Desktop with Big Picture Mode steam functions like Gaming Mode, but clunky.

External keyboard is (probably) needed to edit launcher text boxes in desktop mode, but I'm not 100% sure of that, since I'm using an AMD mini-pc with HoloIso instead of an actual steam deck. The steam deck may be able to bring up a software keyboard in places HoloIso can't.

rankynbass · 2024-04-13T23:58:42Z

Tested Floating Keyboard after it was added to XL.Common, and unfortunately it doesn't really work in desktop mode. It's actually possible to get it to pop up, but only if using gamescope (why? who knows). Even then, it doesn't actually function. However, I was able to install CoreKeyboard from the Discover store, and it did work, so it should now be possible to use the compatibility tool in desktop mode as long as CoreKeyboard or some other software keyboard, or an external keyboard, is installed.

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs

4ndv · 2024-05-24T07:05:08Z

Tested your Apr 13 sct-10 flatpak from here with flatpak-ed Steam, didn't noticed any obvious issues.

When game is closed Steam now correctly handles that, so probably that'll be a good fix for #39?

rankynbass · 2024-05-24T15:51:55Z

There are two problems with this as it stands: aria2c won't work on slightly older linux versions and libsecret might have a similar problem. Most of this is because the flatpak now uses 23.08 instead of 22.08, with a newer version of glibc. I've started working on static compiled aria2 binaries here: https://github.com/rankynbass/aria2-static-build. I'm not sure if the libsecret problem actually matters; the vast majority of linux distros come with libsecret already installed.

electr0sheep · 2024-08-24T22:02:21Z

The current state of XIVLauncher for steam deck is that if we use "--parent-expose-pids" "--parent-share-pids" "--parent-pid=1", it won't launch at all. But also, FFXIV won't shut down once we close the game either. Seems like this PR addresses exactly that issue in the best way possible, but still isn't merged. Is there anything I can do to help speed this along?

reiichi001 · 2024-08-25T01:35:14Z

@electr0sheep please do not recommend people to use unsupported builds. Especially old ones. The SCT build you're linking to is from xlcore 1.0.8 and predates fixes needed for login, news handling, ffxivboot patches failing, and proper Dawntrail handling.

electr0sheep · 2024-08-25T02:16:11Z

@reiichi001 Wasn't my intention to recommend it. I'll delete the comment. Would like to get the ball rolling though, as it's frustrating to see the progress made with this PR, but the zombie process issue still persists.

Ryonez · 2024-09-11T22:13:37Z

Poking my head in to see how this is going. With the flatpack changes locking out the old workarounds, restarting steam to reset things is a bit frustrating.

If I can be of any help with testing, I have a Steam Deck and am willing to test builds and things, like the keyboard issues mentioned above.

Blooym · 2024-09-15T11:54:40Z

Poking my head in to see how this is going. With the flatpack changes locking out the old workarounds, restarting steam to reset things is a bit frustrating.

If I can be of any help with testing, I have a Steam Deck and am willing to test builds and things, like the keyboard issues mentioned above.

I think? we're somewhat moving to do this as an independent tool now as integrating it into the launcher required the compatibility tool to be updated manually every time the launcher was updated.

I've created and been using XLM which is a compatibility tool that fixes the flatpak problems perfectly and i've been using it for a while now. I want it to become an official goatcorp repository when someone has the time to do that.

Ryonez · 2024-09-15T23:58:39Z

I think? we're somewhat moving to do this as an independent tool now as integrating it into the launcher required the compatibility tool to be updated manually every time the launcher was updated.

I've created and been using XLM which is a compatibility tool that fixes the flatpak problems perfectly and i've been using it for a while now. I want it to become an official goatcorp repository when someone has the time to do that.

I just gave it a go, following the steamdeck instructions. It went smoothly, worked with the current XIVLauncher settings, and shut down correctly. Thank you very much for a smooth solution.

rankynbass · 2024-09-21T17:11:42Z

This has been implemented as a stand-alone program: https://github.com/Blooym/xlm

rankynbass added 5 commits November 24, 2023 15:55

feature: Allow install as Steam compatibility tool

da6333b

Tweak Steam Tool tab for clearer instructions

34c396d

Add uninstall buttons

0084586

Fix compatibility tool launch script, clean up instructions.

08d2cb3

Ignore Steam won't be used with Steam compat tool

98d8cb1

rankynbass marked this pull request as ready for review November 25, 2023 06:21

rankynbass added 7 commits November 26, 2023 12:35

Add 1s sleep to xlcore script.

1e0f80b

Add checks for steam

f373482

Fix non-flatpak Steam detection in flatpak

1ca0695

Removed #if FLATPAK directives

2e2569a

Cleaned up Steam Tool Settings Tab Added command line install options: --deck-install, --deck-remove to install to default paths --install=/path/to/Steam, --remove= to specify path

Allow --install to handle ~/path/to/Steam

0ea02dc

Rework XL_PRELOAD

8d6a079

Merge branch 'main' into sct-installer

abc6e2e

Minor script fix. Seems to help with stuttering.

4d8d9b8

Deck doesn't show flatpak install option

cb12b7a

Blooym reviewed Mar 26, 2024

View reviewed changes

rankynbass added 2 commits March 27, 2024 08:08

Change some wording per suggestions

9cb5a1a

Fix some spacing issues

d6d4e44

Merge branch 'main' into sct-installer

f7f0f70

philpax requested a review from Blooym March 27, 2024 20:04

rankynbass added 4 commits April 6, 2024 15:04

Convert xlcore script to posix sh

b8fee9c

Update otp with Common components

e6001c2

Try without extra Steam Input

62c16da

Update with better steamdeck detection

e03cd9b

Improve CL options

c3098ab

4ndv reviewed May 23, 2024

View reviewed changes

src/XIVLauncher.Core/Components/SettingsPage/Tabs/SettingsTabSteamTool.cs Outdated Show resolved Hide resolved

rankynbass added 3 commits May 23, 2024 12:38

Show flatpak steam instructions for all non-steamdeck users

17b0509

Improve handling of different versions

2357bdd

Use Program.CoreRelease in SteamCompatibilityTool.cs

0eebea8

yaomtc mentioned this pull request Jul 24, 2024

Latest flatpak + appstream update breaks XIVLauncher with --parent-expose-pids --parent-share-pids #97

Open

rankynbass closed this Sep 21, 2024

	if (CoreEnvironmentSettings.IsDeck != true && steamFlatpakInstalled)
	if (!CoreEnvironmentSettings.IsDeck && steamFlatpakInstalled)

	steamPath = new SettingsEntry<string>("Steam Path (native install)", "Path to the native steam config files. Only change this if you have your steam config stored somewhere else.",
	steamPath = new SettingsEntry<string>("Steam Path (native)", "Path to the native steam installation. Only change this if you have steam installed in a non-default location.",

	steamFlatpakPath = new SettingsEntry<string>("Steam Path (flatpak install)", "Path to the flatpak steam config files. Only change this if you have your steam config stored somewhere else.",
	steamFlatpakPath = new SettingsEntry<string>("Steam Path (flatpak)", "Path to the flatpak steam installation. Only change this if you have your flatpak steam installed in a non-default location.",


		public override SettingsEntry[] Entries { get; }

		public override bool IsUnixExclusive => true;

	ImGui.Text("\nIf you wish to install into Flatpak Steam, you must use Flatseal to give XIVLauncher access to Steam's flatpak path. This is probably something like:");
	ImGui.Text("\nIf you wish to install into Flatpak Steam, you must use Flatseal to give XIVLauncher access to Steam's flatpak path. This is commonly found at:");

	ImGui.Text($"{CoreEnvironmentSettings.HOME}/.var/app/com.valvesoftware.Steam. If you do not give this permission, installation will fail. You will probably also want to");
	ImGui.Text($"{CoreEnvironmentSettings.HOME}/.var/app/com.valvesoftware.Steam. If you do not give this permission, installation will fail. You will also want to");

		// File.SetUnixFileMode() doesn't exist, for some reason, so just run chmod
		var psi = new ProcessStartInfo("/bin/chmod");

Steam Compatibility Tool installer #99

Steam Compatibility Tool installer #99

Conversation

rankynbass commented Nov 25, 2023 • edited Loading

philpax commented Mar 23, 2024

rankynbass commented Mar 23, 2024 • edited Loading

KazWolfe commented Mar 23, 2024 • edited Loading

rankynbass commented Mar 23, 2024

KazWolfe commented Mar 23, 2024

rankynbass commented Mar 23, 2024

rankynbass commented Mar 23, 2024

KazWolfe commented Mar 23, 2024

rankynbass commented Mar 23, 2024 • edited Loading

rankynbass commented Mar 23, 2024

philpax commented Mar 25, 2024

Blooym Mar 26, 2024 • edited Loading

Choose a reason for hiding this comment

Blooym 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 Mar 27, 2024

rankynbass commented Apr 13, 2024

rankynbass commented Apr 13, 2024

4ndv commented May 24, 2024

rankynbass commented May 24, 2024

electr0sheep commented Aug 24, 2024

reiichi001 commented Aug 25, 2024

electr0sheep commented Aug 25, 2024

Ryonez commented Sep 11, 2024

Blooym commented Sep 15, 2024

Ryonez commented Sep 15, 2024

rankynbass commented Sep 21, 2024

rankynbass commented Nov 25, 2023 •

edited

Loading

rankynbass commented Mar 23, 2024 •

edited

Loading

KazWolfe commented Mar 23, 2024 •

edited

Loading

rankynbass commented Mar 23, 2024 •

edited

Loading

Blooym Mar 26, 2024 •

edited

Loading