diff --git a/.gitignore b/.gitignore index 723ef36..7341eca 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ -.idea \ No newline at end of file +.idea +_site/ +.jekyll-cache \ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html index 866454e..12cc690 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -1,12 +1,13 @@ - + + {% if site.google_analytics %} @@ -15,14 +16,14 @@ {% seo %} - + - - + + - - -
- {{ content }} - - -
+ + +
+ {{ content }} + + +
- + + \ No newline at end of file diff --git a/index.md b/index.md index 31d3262..58bb882 100644 --- a/index.md +++ b/index.md @@ -6,7 +6,7 @@ Please select a category from below:

Help for plugins Help for plugin developers Authenticator App Guide -Steam Deck Setup Guide +Steam Deck & Linux Guide diff --git a/steamdeck.md b/steamdeck.md index 596380a..4faea73 100644 --- a/steamdeck.md +++ b/steamdeck.md @@ -1,98 +1,82 @@ -# XIVLauncher Linux (Flatpak/ Steam Deck) Installation Guide +# XIVLauncher Linux Installation Guide -## Installing XIVLauncher on Desktop Linux +XIVLauncher for Linux is distributed in many different formats depending on your system setup. Please read below for the recommended way to install XIVLauncher for your system: -**IMPORTANT:** Installation for the Steam Deck works a bit differently due to Valve's changes in SteamOS, please see the next section for Steam Deck instructions. +- **I am using a Steamdeck/Linux handheld with Steam big picture (regardless of if you own FFXIV on Steam)**: You should follow the [install as a compatibility tool guide](#install-xivlauncher-as-a-steam-compatibility-tool). +- **I am using a desktop Linux distro and own FFXIV through Steam**: You should follow the [install as a compatibility tool guide](#install-xivlauncher-as-a-steam-compatibility-tool). +- **I am using a desktop Linux distro and don't own FFXIV through Steam**: You should follow the [install as a Flatpak or system package guide](#install-xivlauncher-as-a-flatpak-or-system-package) +- **I am using a setup that is not listed here**: It may be the case that XIVLauncher may not be officially supported for your setup, but still refer to the [install as a Flatpak or system package guide](#install-xivlauncher-as-a-flatpak-or-system-package) to make sure. -Generally, the recommended and supported way to install XIVLauncher on a desktop Linux distribution (Ubuntu, Fedora Workstation, etc.) is to install it as a Flatpak. Flatpaks are mostly self-contained and sandboxed applications, which means that they only have access to the parts of your system that they explicitly need in order to function. The `Flatseal` program is a useful tool for managing permissions for Flatpak apps, which you may install separately if you so wish. +## Install XIVLauncher as a Steam compatibility tool -To install XIVLauncher as a Flatpak, you will need to have Flatpak itself installed and the Flathub repository for flatpaks enabled on your system. Please see upstream (your distro's and/or Flatpak's) documentation on how to install Flatpak to your system and to enable the Flathub repositories. +The XIVLauncher Steam compatibility tool is handled by a project called [XLM](https://github.com/Blooym/XLM). Automatic install scripts are provided for all major system configurations that will do most of the setup work for you *(However if your system configuration is not covered here you can always manually download the XLM binary from the [GitHub Releases Page](https://github.com/Blooym/xlm/releases/latest) and install that way)*. -### Install XIVLauncher as a Flatpak from the terminal +Auto installers for the Steam compatibility tool are provided for the `Steam Deck`, `Flatpak` and `Native` packages of Steam. Simply copy and paste the script for your system below into the terminal and the compatibility tool will be installed for you. Afterwards, follow the steps below to start using it. -To install XIVLauncher as a flatpak using the terminal, run the command `flatpak install flathub dev.goats.xivlauncher` as a regular user ( without `sudo`). - -### Install XIVLauncher as a Flatpak from your software store (GNOME/KDE) - -Some desktop environments provide graphical frontends for Flatpak repositories, allowing you to browse an app store to install Flatpaks in a more intuitive way. - -- If you are using GNOME, open Software and then search for `XIVLauncher`. Click on the XIVLauncher entry in the results. Click `Install`. - -- If you are using KDE, open Discover and then search for `XIVLauncher`. Click on the XIVLauncher entry in the results. Click `Install`. - -Other desktop environments may or may not have XIVLauncher available in their own Flatpak frontend applications. If XIVLauncher does not appear in GNOME Software or KDE Discover, verify that Flatpak is installed and running, and verify that you have the Flathub repos enabled. - -### Install XIVLauncher from the Arch User Repository (UNOFFICIAL) - -There are several **unofficial** packages for XIVLauncher on the Arch User Repository (AUR). These packages are an alternative method of installing XIVLauncher for Arch Linux and its derivative distributions (Manjaro, Endeavour OS, etc.) ONLY. - -Currently, the `xivlauncher`, `xivlauncher-bin` and `xivlauncher-git` AUR packages are available. However, **AUR packages are community builds and only the Flatpak release of XIVLauncher is officially supported.** - -For reference, `xivlauncher` downloads the source code and builds the `XIVLauncher` package on your system, `xivlauncher-bin` provides a prebuilt binary, and `xivlauncher-git` provides testing builds. We cannot guarantee the functionality or security of AUR packages. - -Please see the [Arch Wiki](https://wiki.archlinux.org/title/Arch_User_Repository#Installing_and_upgrading_packages) or your distribution's documentation on official instructions for installing AUR packages. AUR packages can be insecure. Be vigilant. - -## Installing XIVLauncher on Steam Deck +**Steamdeck Install Script**: -**IMPORTANT:** The following installation instructions are for the Steam Deck only. For installing XIVLauncher on a Linux desktop/laptop (including Arch Linux and/or KDE setups), please refer to the above section. +```sh +sh -c "$(curl -fsSL https://raw.githubusercontent.com/Blooym/xlm/main/setup/install-steamdeck.sh)" +``` -### Install the Steam version of FFXIV on your Steam Deck +**Steam Install Script (Native)** +```sh +sh -c "$(curl -fsSL https://raw.githubusercontent.com/Blooym/xlm/main/setup/install-native.sh)" +``` -To use XIVLauncher, the FFXIV Free Trial or the full version of FFXIV has to be installed on your Steam Deck's **internal memory**. You don't need to start it at any point in time, or need to create a Steam account, it just has to be installed. If you don't own FFXIV on Steam, please install the Free Trial. +**Steam Install Script (Snap)** +```sh +sh -c "$(curl -fsSL https://raw.githubusercontent.com/Blooym/xlm/main/setup/install-snap.sh)" +``` -To install the Trial, you will need to look for it in the Steam Store. Depending on whether or not you have previously installed the Trial on this account, it may be hidden from search results. In this case, look for Demos within the Final Fantasy franchise in Desktop Mode, or [use this link to go to the Trial](https://store.steampowered.com/app/312060/FINAL_FANTASY_XIV_Online_Free_Trial/). +**Steam Install Script (Flatpak)** +```sh +sh -c "$(curl -fsSL https://raw.githubusercontent.com/Blooym/xlm/main/setup/install-flatpak.sh)" +``` -This is needed for Gaming Mode to see the game window. +After the installer has finished, please follow these steps to use the compatibility tool: +- Switch back to gaming mode (if on Steam Deck) or restart your Steam client otherwise. +- Navigate to your library and select "FINAL FANTASY XIV Online" or "FINAL FANTASY XIV Online Free Trial" if you are playing via the free trial or don't own the Steam edition of FFXIV. +- Open the game properties menu and switch to the "compatibility" tab. +- Enable the "Force the use of a specific Steam Play compatibility tool" checkbox. +- From the box that appears select "XLCore [XLM]" (if this does not show, please make sure you properly restarted Steam). +- You can now launch the game as usual. XIVLauncher will be automatically installed and run for you. -### Switch to Desktop Mode +## Install XIVLauncher as a flatpak or system package -Press and hold the Power Button. Select `Switch to Desktop Mode`. +### Flatpak -### Install XIVLauncher +First, check to see if flathub is installed by running `flatpak remotes`. If you don't see an entry for flathub, check [https://flathub.org/setup](https://flathub.org/setup) for instructions on how to install it. -Open the `Discover Store`, search for `XIVLauncher`, and press Install. +#### Via terminal -**For Any other linux distro,** the `Discover Store` is a GUI for flatpak. This is the package: - -**OPTIONAL:** If you would like to install Final Fantasy XIV to your Deck's MicroSD card or any folder outside of the default (`~/.xlcore/ffxiv`), you will also need `Flatseal` from the Discover Store. See documentation on enabling external folder access below. - -### Add a Non-Steam Game - -In Steam's Desktop mode, select `ADD A GAME`, scroll down to XIVLauncher, click the checkbox, and click `ADD SELECTED PROGRAM` - -Right click on XIVLauncher in Steam, select `Properties`, and replace the `Launch Options` with the following: `XL_SECRET_PROVIDER=FILE %command% "run" "--parent-expose-pids" "--parent-share-pids" "--parent-pid=1" "--branch=stable" "--arch=x86_64" "--command=xivlauncher" "dev.goats.xivlauncher"` - -**NOTE:** Recent versions of Flatpak have seemingly deprecated the `--parent-pid=1` option. If you encounter problems, remove `--parent-expode-pids --parent-share-pids --parent-pid=1` from the launch options listed above. - -**NOTE:** With this configuration, XIVLauncher will save your password to a file on your Steam Deck, as Valve does not ship a safer way to store passwords by default. If this is a problem for you, please leave out `XL_SECRET_PROVIDER=FILE %command%` from the line above - XIVLauncher won't be able to save your password in that case. - -(For desktop Linux users with a sudden performance drop after some time in game, this may be caused by the Steam overlay. Try adding `LD_PRELOAD=""` at the start to disable it.) +To install XIVLauncher as a flatpak using the terminal, run the command `flatpak install flathub dev.goats.xivlauncher` as a regular user ( without `sudo`). -**Do not set a Compatibility mode for XIVLauncher.** XIVLauncher is a native Linux application. Setting Compatibility for it will break it. +#### Via your software store (GNOME/KDE) -### OPTIONAL: Allow external folder access to XIVLauncher +Some desktop environments provide graphical frontends for Flatpak repositories, allowing you to browse an app store to install Flatpaks in a more intuitive way. -Run Flatseal. On the left, scroll down to XIVLauncher. In the main part of the window, scroll down to `Filesystem`. Click the Folder icon next to Other files. Type the location where you would like to install Final Fantasy XIV. +- If you are using GNOME, open Software and then search for `XIVLauncher`. Click on the XIVLauncher entry in the results. Click `Install`. -For Steam Deck users, your MicroSD is mounted to `/run/media/mmcblk0p1` by default. +- If you are using KDE, open Discover and then search for `XIVLauncher`. Click on the XIVLauncher entry in the results. Click `Install`. -For desktop Linux users, the paths for external drives vary by distribution and system. +Other desktop environments may or may not have XIVLauncher available in their own Flatpak frontend applications. If XIVLauncher does not appear in GNOME Software or KDE Discover, verify that Flatpak is installed and running, and verify that you have the Flathub repos enabled. -### Switch to Gaming Mode +#### Installing FFXIV to an external drive -On the Desktop, tap `Return to Gaming Mode`. +If you would like to install Final Fantasy XIV to any folder outside of the default (`~/.xlcore/ffxiv`), you will also need `Flatseal` from the Discover Store. -### First time setup / Running the game +Run Flatseal. On the left, scroll down to XIVLauncher. In the main part of the window, scroll down to `Filesystem`. Click the Folder icon next to Other files. Type the path where you would like to install Final Fantasy XIV. -Run XIVLauncher in Steam. Once XIVLauncher has opened, click the Gear icon in the bottom left if you need to set the game data path, OTP macro, etc. (Use the mount location above for the data path if you're installing to the MicroSD.) After changing settings, click the check mark. Input your username and password, click login, and let XIVLauncher install the game (if it is not already present in your game data path). +### System package -When prompted, press the `Steam` button, select `FINAL FANTASY XIV Online` or `FINAL FANTASY XIV Online Free Trial` (the latter will appear for non-Steam service accounts). Final Fantasy XIV will appear on the screen after a few moments. +A list of alternative packages and formats can be found [here](https://github.com/goatcorp/XIVLauncher.Core?tab=readme-ov-file#distribution). Please note that apart from the compatibility tool and the Flatpak, the rest are maintained by members of the community and are deemed unofficial. You will, however, still receieve community support as long as the package is up-to-date. ## FREQUENTLY ASKED QUESTIONS ### Q: Where are my configuration files kept? -Configuration files are saved to `~/.xlcore`. +Configuration files are saved to `~/.xlcore`, except when running the compatibility tool with the Steam flatpak wherein the configuration files are saved to `~/.var/app/com.valvesoftware.Steam/.xlcore`. ### Q: The game is disappearing randomly and won't resume after sleep mode on Steam Deck @@ -100,7 +84,7 @@ Please make sure that FFXIV or the FFXIV Free Trial from the Steam Store is inst ### Q: My audio is crackling/distorted -Try adding `PULSE_LATENCY_MSEC=60` to the beginning of the Launch Options in Steam. +Try adding `PULSE_LATENCY_MSEC=60` in your XIVLauncher environment variable settings. ### Q: I can't control my game @@ -110,17 +94,17 @@ If that does not fix it, rename `~/.xlcore/ffxivConfig/FFXIV.cfg` to `FFXIV.cfg. ### Q: Final Fantasy XIV doesn't close properly / Steam constantly thinks Final Fantasy XIV is playing -A fix is in progress for newer versions of Flatpak. +Please [switch to the compatibility tool version of XIVLauncher](#install-xivlauncher-as-a-steam-compatibility-tool) and remove the old XIVLauncher flatpak to resolve this problem. -If you are on an older Flatpak version, make sure you set the Launch Options in the "Add a Non-Steam Game" step. Specifically the `--parent-expose-pids --parent-share-pids --parent-pid=1` arguments allow XIVLauncher to communicate with Steam to report the game closing. (This does not work on newer versions of Flatpak, as `--parent-pid=1` has been deprecated for breaking the Flatpak sandbox.) +### Q: I can't enter my username/password on Steam Deck -### Q: XIVLauncher immediately closes when trying to run it through Steam +Due to a limitation of Steam's text input API, please use the Steam Deck's Gaming Mode to finish setup. -Do not set a Compatibility mode for XIVLauncher in Steam. XIVLauncher is a native Steam application that does not need Proton to run. +### Q: I'm seeing "No secrets provider installed or configured" -### Q: I can't enter my username/password on Steam Deck +This means that XIVLauncher was unable to find a secure way to store your passwords. This is usually because you don't have a secrets manager like GNOME Keyring or KDE Wallet installed on your system. It's recommended you install a recognised and well known secrets manager to solve this problem. -Due to a limitation of Steam's text input API, please use the Steam Deck's Gaming Mode to finish setup. +If you are using a Steamdeck or are unable to install a secrets manager, you can run XIVLauncher with `XL_SECRET_PROVIDER=file` to store your credentials insecurely via a file. This will be done for you if you are using the compatibility tool on Steamdeck or with Flatpak Steam. -[Return to the top](# XIVLauncher Linux %28Flatpak/ Steam Deck%29 Installation Guide) +[Return to the top](#xivlauncher-linux-installation-guide) Return to the main FAQ