Linux Support: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
(Revamping the Wine section to show how to install FP12 using the installer)
(Updates and Nix details)
 
(48 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Linux support in Flashpoint is currently experimental due to a lack of maintainers. This page describes the current state of our Linux support. If you need assistance with installing or playing, visit us at <code>flashpoint-help</code>.
Linux support in Flashpoint is currently experimental due to a lack of maintainers. This page describes the current state of our Linux support. If you need assistance with installing or playing, ask in the <code>#help</code> channel on the [https://flashpointarchive.org/discord Discord server].


As it stands, the Docker version of Flashpoint for Linux supports Flash, HTML5, Shockwave, Unity and Java. The exceptions are content that uses the Chromium browser, and Shockwave content that plays in-browser.
Flashpoint for Linux supports Flash, HTML5, Shockwave, Unity, Java and various other web platforms. Not everything is supported, such as DevalVR and Viscape.
If you want support for the other platforms that are Windows-exclusive, there are a few options to get the Windows version of Flashpoint running on Linux:
If you want support for platforms that are Windows-exclusive, there are a few options to get the Windows version of Flashpoint running on Linux:
* [https://bluemaxima.org/flashpoint/downloads/ Download the Windows version of Flashpoint] and run it in a Windows virtual machine. This is the recommended non-native option.
* [https://flashpointarchive.org/downloads Download the Windows version of Flashpoint] and run it in a Windows virtual machine. This is the recommended non-native option.
* [[#Using_Wine|Run the Windows version of Flashpoint with Wine]]. This works well on some computers, but does not work consistently.
* [[#Windows_Version_Using_Wine|Run the Windows version of Flashpoint with Wine]]. This works well on some computers, but does not work consistently.


Otherwise, download the [https://drive.google.com/file/d/1zgBrmyiMpSfW9xsZ9A4ejvR0lktWlTRR/view?usp=sharing latest Docker Flashpoint package] and [[#Manual Installation|install it]].
Otherwise, if you do not need support for those platforms, try any of the methods of launching Flashpoint listed below.


== Manual Installation ==
== Immutable Version ==
 
=== Notes ===
This is an old build is designed for use on distros with an immutable rootfs, such as SteamOS, NixOS, Fedora Silverblue, etc. Most of the dependencies, including Wine, PHP and GTK3, are already included within the installation directory. No packages should need to be installed in order for this version to work, but due to compatibility issues with specific configurations, your system may still complain about missing libraries. More space will be needed to run this compared to the [[#Mutable_Version|mutable version]], so if you are able and willing to install a couple packages to save space, use the mutable version instead.
 
If you have [https://nixos.org/download/ Nix] on your system, you can also launch the mutable version of Flashpoint under [[#Nix_Shell|a Nix shell]] or with <code>steam-run</code> (<code>nix-shell -p steam-run --run "steam-run ./start-flashpoint.sh"</code>).
 
=== Installation ===
# Download [https://download.unstable.life/upload/fp13_linux_20240425i.7z this archive file].
# Extract the contents of the file to an '''empty''' folder that your user has read & write permissions for. This can be done graphically, or in the terminal by entering the following in the directory the file is in:<pre>$ 7zr x fp13_linux_*.7z -oFlashpoint</pre>
# Open the folder you extracted Flashpoint to, then run <code>start-flashpoint.sh</code> to open the launcher.
After the installation is complete, you should not move any files in the Flashpoint folder at all. Moving the wrong file/folder could break the entire program until it is moved back.
 
A README document is provided that has some additional notes.
 
== Mutable Version ==
 
=== Compatibility ===
Since the Flashpoint launcher is based on Electron, the minimum requirements are identical to Chromium. According to Google, they are as follows:
* 64-bit Ubuntu 18.04+, Debian 10+, or Fedora 32+
* An Intel Pentium 4 or later processor that's SSE3 capable
Rolling-release distros like Arch and Gentoo are also supported.
 
<small>It is possible for a distro that doesn't meet these requirements to still be able to run Flashpoint if the system packages are new enough. If you use an older distro than the listed minimums and are unable to open the launcher, you could try adding a repository from a newer, supported version of the same distro and updating your packages that way. Beware though, because doing so could cause damage to your system if not done carefully.</small>


=== Dependencies ===
=== Dependencies ===
First, install Flashpoint's dependencies.
This version of Flashpoint for Linux requires the following dependencies to be installed at runtime:
{| class="wikitable"
{| class="wikitable"
!colspan="9"|Dependency package names on various distros
!colspan="9"|Dependency package names on various distros
|-
|-
!Library/command name
!Distro
!Docker
!PulseAudio<small><sup><span style="color:#0000ff">1</span></sup></small>
!PulseAudio<span style="color:#0000ff">*</span>
!X11<small><sup><span style="color:#0000ff">2</span></sup></small>
!X11<span style="color:#0000ff">**</span>
!32-bit Xcomposite
!XHost
!GTK3
!NSS
!NSS
!PHP
!PHP
!Wine
!bash
!bash
|-
|-
!Debian-like<span style="color:#0000ff"><small><sup>a</sup></small></span>
!Debian-like<span style="color:#0000ff"><small><sup>a</sup></small></span>
|(see [https://docs.docker.com/engine/install/debian/ this page])
|pulseaudio
|pulseaudio
|xserver-xorg-core
|xserver-xorg-core
|x11-xserver-utils
|libxcomposite1:i386
|libgtk-3-0
|libnss3
|libnss3
|php
|php
|(see [https://wiki.winehq.org/Debian this page])
|bash
|bash
|-
|-
!Ubuntu-like<span style="color:#0000ff"><small><sup>b</sup></small></span>
!Ubuntu-like<span style="color:#0000ff"><small><sup>b</sup></small></span>
|(see [https://docs.docker.com/engine/install/ubuntu/ this page])
|pulseaudio
|pulseaudio
|xserver-xorg-core
|xserver-xorg-core
|x11-xserver-utils
|libxcomposite1:i386
|libgtk-3-0
|libnss3
|libnss3
|php
|php
|(see [https://wiki.winehq.org/Ubuntu this page])
|bash
|bash
|-
|-
!Fedora-like
!Fedora-like
|(see [https://docs.docker.com/engine/install/fedora/ this page])
|pulseaudio
|pulseaudio
|xorg-x11-server-Xorg
|xorg-x11-server-Xorg
|xhost
|libXcomposite.i686
|gtk3
|nss
|nss
|php
|php
|(see [https://wiki.winehq.org/Fedora this page])
|bash
|bash
|-
|-
!Arch-like<span style="color:#0000ff"><small><sup>c</sup></small></span>
!Arch-like<span style="color:#0000ff"><small><sup>c</sup></small></span>
|docker
|pulseaudio
|pulseaudio
|xorg-server
|xorg-server
|xorg-xhost
|lib32-libxcomposite
|gtk3
|nss
|nss
|php
|php
|wine
|bash
|bash
|}
|}
<small><span style="color:#0000ff">a</span> : E.g. ChromeOS Terminal, MX Linux | <span style="color:#0000ff">b</span> : E.g. Linux Mint, Pop!_OS, Zorin OS | <span style="color:#0000ff">c</span> : E.g. Manjaro, SteamOS >=3.0</small>
<small><span style="color:#0000ff">a</span>: E.g. ChromeOS Terminal, MX Linux | <span style="color:#0000ff">b</span>: E.g. Linux Mint, Pop!_OS, Zorin OS | <span style="color:#0000ff">c</span>: E.g. Manjaro, EndeavourOS</small>


'''Note:''' Chances are that Docker and PHP will be the only packages that you'll need to install, as most distributions come with the rest of the packages already pre-installed.
'''Note:''' Chances are that Wine and PHP will be the only packages that you'll need to install, as most distributions come with the rest of the packages already pre-installed.


<span style="color:#0000ff">*</span> : PipeWire can also be used in place of PulseAudio by installing the <code>pipewire-pulse</code> package on Ubuntu-like and Arch-like distros, or <code>pipewire-pulseaudio</code> on Fedora-like distros. For Debian-like distros, see [https://wiki.debian.org/PipeWire#Using_as_a_substitute_for_PulseAudio.2FJACK.2FALSA this link].
There are also some packages that aren't required, but can enhance your experience:
{| class="wikitable"
! colspan="6" |Optional dependencies
|-
!Distro
!GTK2<small><sup><span style="color:#0000ff">3</span></sup></small>
!LibXt<small><sup><span style="color:#0000ff">3</span></sup></small>
|-
!Debian-like
|libgtk2.0-0
|libxt6
|-
!Fedora-like
|gtk2
|libXt
|-
!Arch-like
|gtk2
|libxt
|}
<small><span style="color:#0000ff">1</span>: PipeWire can also be used in place of PulseAudio by installing the <code>pipewire-pulse</code> package on Ubuntu-like and Arch-like distros, or <code>pipewire-pulseaudio</code> on Fedora-like distros. For Debian-like distros, see [https://wiki.debian.org/PipeWire#Using_as_a_substitute_for_PulseAudio.2FJACK.2FALSA this link].


<span style="color:#0000ff">**</span> : X11 can also be used within Wayland by installing the <code>xwayland</code> package on Debian-like and Ubuntu-like distros, <code>xorg-x11-server-Xwayland</code> on Fedora-like distros, or <code>xorg-xwayland</code> on Arch-like distros.
<span style="color:#0000ff">2</span>: X11 can also be used within Wayland by installing the <code>xwayland</code> package on Debian-like and Ubuntu-like distros, <code>xorg-x11-server-Xwayland</code> on Fedora-like distros, or <code>xorg-xwayland</code> on Arch-like distros.


<span style="color:#0000ff">3</span>: Required for native Flash support. To support versions <27, the 32-bit version of this package must be installed instead.</small>


To install them, use your distro's package manager:
To install them, use your distro's package manager:
Line 75: Line 124:
|-
|-
!Debian-like
!Debian-like
|<code>sudo apt-get install {PACKAGE}</code>
|-
!Ubuntu-like
|<code>sudo apt-get install {PACKAGE}</code>
|<code>sudo apt-get install {PACKAGE}</code>
|-
|-
!Fedora-like
!Fedora-like
|<code>sudo dnf install {PACKAGE}</code>
|<code>sudo dnf install {PACKAGE}</code>
|-
!Fedora-like (old)
|<code>sudo yum install {PACKAGE}</code>
|-
|-
!Arch-like
!Arch-like
Line 91: Line 134:


=== Setup ===
=== Setup ===
Before you start, you need to [https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user configure Docker to be managed by a non-root user]. Once finished, you may have to relog if the permissions aren't applied properly when trying to run Docker commands as a non-root user.
Make sure you have at least 4 GB of free space, and that you have <code>p7zip</code> installed to be able to extract from 7z files.
 
If you don't want to add your user to the <code>docker</code> group as above (e.g., for security: doing this allows all programs on your computer to have unrestricted administrator access to everything at all times) then there is an alternative, it just takes a bit more work.
 
==== Optional: Configuring non-root Flashpoint ====
 
Start by creating a wrapper script for Docker that will automatically use <code>sudo</code> when you are not invoking Docker as root. Name it <code>docker</code>, make it executable and place it on your <code>$PATH</code>:
 
<pre>
#!/usr/bin/env bash
export PATH="${PATH/$(dirname "$0"):/}"
askpass=()
if [[ -n "${SUDO_ASKPASS:-}" ]]; then
    askpass+=("-A")
fi
if [[ "$OSTYPE" != darwin* ]] && [[ "$EUID" != 0 ]]; then
    exec sudo "${askpass[@]}" -E -- "$0" "$@"
fi
exec docker "$@"
</pre>
 
Then you need to create an askpass script for <code>sudo</code>. Create a script that will print your sudo password to stdout. For example, your script could retrieve the password from a password manager like <code>pass</code>, which will force authentication through a graphical dialog before retrieving it. Technically you could just hardcode your password in the script, but this would defeat the point of trying to be more secure in the first place.
 
Now, you can simply export the <code>SUDO_ASKPASS</code> environment variable to the path of your askpass script (make sure it is executable), make sure that your <code>docker</code> wrapper is on <code>$PATH</code>, and invoke <code>./flashpoint</code> as normal once you get to that step below.
 
==== Nvidia GPUs ====
If you have an Nvidia GPU and use a distro that isn't Arch-like, you will need to add Nvidia's repository and install the <code>nvidia-docker2</code> package. Follow the "Setting up NVIDIA Container Toolkit" instructions under the heading corresponding to your distro [https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker here].
 
If you use an Arch-like distro, install either [https://aur.archlinux.org/packages/nvidia-container-toolkit <code>nvidia-container-toolkit</code>] or [https://aur.archlinux.org/packages/nvidia-docker <code>nvidia-docker</code>] from the AUR if you did or didn't already install Docker respectively.
 
In both cases, you may have to restart the Docker service or reboot your computer to apply the toolkit.


=== Installation ===
=== Installation ===
Download the [https://drive.google.com/file/d/1zgBrmyiMpSfW9xsZ9A4ejvR0lktWlTRR/view?usp=sharing latest Docker Flashpoint package] if you haven't already and extract it somewhere.
# Download [https://download.unstable.life/upload/fp13_linux_20240425m.7z this archive file].
# Extract the contents of the file to an '''empty''' folder that your user has read & write permissions for. This can be done graphically, or in the terminal by entering the following in the directory the file is in:<pre>$ 7zr x fp13_linux_*.7z -oFlashpoint</pre>
# Open the folder you extracted Flashpoint to, then run <code>start-flashpoint.sh</code> to open the launcher.
After the installation is complete, you should not move any files in the Flashpoint folder at all. Moving the wrong file/folder could break the entire program until it is moved back.


Go to the place where you extracted it, and pull the docker images by running <code>./pull.sh</code>. They'll take ~3.5 GB.
A README document is provided that has a recap of some instructions shown in this section, as well as some additional notes.


Finally, run the <code>./flashpoint</code> executable script to start the launcher.
=== Nix Shell ===


The mutable version of Flashpoint can also be launched under a Nix shell if Nix is installed:


Config files can be found in <code>./LinuxConf/</code> and <code>./FPSoftware/FSPConfigs/</code>.
<pre>
{ pkgs ? import <nixpkgs> {} }:


Save data is stored in <code>./SaveData</code>. Java save data isn't persistent, because there's no standardized location for it.
(pkgs.buildFHSEnv {
    name = "flashpoint";
    targetPkgs = pkgs: (with pkgs; [
        # Shell utils
        toybox
        # Electron for the launcher.
        electron
        # Flashpoint requirements
        pipewire pulseaudio
        gtk3 gtk2 nss php wine
        xorg.libX11 xorg.libXt xorg.libXcomposite
        # ldd requirements
        mesa #libgbm
        glib nspr at-spi2-atk cups dbus libdrm pango cairo expat libxkbcommon alsa-lib
        xorg.libXdamage xorg.libXext xorg.libXfixes xorg.libXrandr xorg.libxcb
        udev
    ]);
}).env
</pre>


== Troubleshooting ==
Simply save this code into a .nix file and run it with <code>nix-shell {file}.nix --run ./start-flashpoint.sh</code>.


=== proxy.sh: "Permission denied" error ===
You can also use <code>steam-run</code> (<code>nix-shell -p steam-run --run "steam-run ./start-flashpoint.sh"</code>).


Depending on your system's permissions, the <code>proxy.sh</code> script may throw a "permission denied" error in the launcher logs when launching a game, causing it to fail to start. To fix this, follow these steps:
== Minimal-Dependency Version ==
# Close the Flashpoint launcher.
If you are looking for a fully-native or minimal setup Flashpoint experience on Linux, ''Flashpoint Nano'' exists as a lightweight (albeit heavily limited) script-based alternative to the other installation options.
# Open <code>./LinuxConf/proxy.sh</code> in a text editor.
# Change <code>/var/lock/flashpoint-networking.lock</code> to <code>/tmp/flashpoint-networking.lock</code> and save the file.
# Relaunch Flashpoint.


=== cgroup subsystem devices not found: unknown ===
Only two platforms are supported: Flash (using [https://ruffle.rs/ Ruffle]; non-embedded entries only) and HTML5 (using [https://www.palemoon.org/ Pale Moon]). Each software is Linux-native, downloaded upon first launch and updated automatically.


This error occurs most frequently on Pop!_OS 22.04, due to an outdated version of the Nvidia container runtime being packaged in the default repositories. If this applies to you, follow these steps:
'''Due to the inherently barebones nature of this option, do not expect to receive help in the Discord if a specific game does not work.'''
# Close the Flashpoint launcher and stop the Docker service.
# Remove your current <code>nvidia-docker2</code> package, then remove its dependencies and configuration files by typing <code>sudo apt-get autoremove --purge</code> in the terminal.
# Create a text file in <code>/etc/apt/preferences.d</code> with the following contents:
Package: *
Pin: origin nvidia.github.io
Pin-Priority: 1002
Then save the file, update the package index using <code>sudo apt-get update</code>, reinstall the package, start the Docker service again, and relaunch Flashpoint.


=== Docker Fix for Firewalld Users ===
=== Dependencies ===
Only a few command-line utilities that may not be available on your system by default are required: <code>tar</code>, <code>curl</code>, <code>sqlite3</code>, and <code>unxz</code> (from XZ Utils). You should be able to install these using your distro's package manager.


Users of [https://firewalld.org/ Firewalld] may run into issues with Docker when launching games. In this case, follow these steps:
=== Installation ===
<ol>
# Download Nano from [https://github.com/WumboSpasm/flashpoint-nano the GitHub repository] by clicking the ''Code'' button and then ''Download ZIP''. Alternatively, if you have git installed, you can use the <code>git clone <nowiki>https://github.com/WumboSpasm/flashpoint-nano.git</nowiki></code> command to download the repository. The latter option may be preferable so you can download updates to the scripts using <code>git pull</code>.
<li>
# If you downloaded the ZIP archive, extract it using your method of choice.
Run <code>sudo systemctl status docker</code> and look for the location of Docker's service file in the output. It is usually <code>/usr/lib/systemd/system/docker.service</code>.
# Enter the created directory and run the following command in the terminal: <code>./flashpoint.sh <entry-id></code>. You can find the ID of the desired entry using the [https://flashpointproject.github.io/flashpoint-database/ Flashpoint Database] search tool. If you wish to launch an additional application, simply append its ID to the end of your command (with a space separating it from the entry ID).
</li>
<li>
Open the file in a text editor with root privileges and change the following line from:
<pre>ExecStart=/usr/bin/dockerd -H fd://</pre>
to:
<pre>ExecStart=/usr/bin/dockerd -H fd:// --ip-tables=false</pre>
</li>
<li>
Restart the Docker service by running <code>sudo systemctl restart docker</code>.
</li>
<li>
Run Flashpoint and install the content of your choosing, then close the launcher when finished.
</li>
<li>
Open the Docker service file again and revert the previous change to the line, then restart the Docker service again.
</li>
<li>
Relaunch Flashpoint and run the installed content again. It should now work.
</li>
</ol>


== Optional Enhancements ==
== Windows Version Using Wine ==


=== Wayland Support ===
Alternatively, you can attempt to run the Windows version of Flashpoint using Wine, which is a Windows compatibility layer. There are several advantages to doing this, like being able to run more up-to-date versions of Flashpoint that have only been made for Windows. However, it is not guaranteed that Wine will work properly, as the experience varies greatly depending on the hardware, choice of distribution, and packages you have installed. For this to work, you currently need to install either the development or staging versions of Wine running a completely fresh prefix. How to install them depends on the distro, so consult WineHQ's [https://wiki.winehq.org/Download download page] for instructions on yours. Additionally, you will also need the <code>php</code> package for Flashpoint to work post-install.


The Flashpoint launcher is based on a version of Electron that has experimental support for running through Wayland instead of X11/Xwayland. If you use a Wayland compositor, like Mutter or Kwin, then you can enable this feature by opening the <code>flashpoint</code> script in a text editor and changing the following line from:
As of now, you can install the latest Windows version of Flashpoint Infinity by running the [https://github.com/FlashpointProject/FlashpointComponentTools/releases/latest/download/FlashpointInstaller.exe installer] through Wine. To be able to run the installer, you need to install a recent version of the .NET framework via Wine Mono, which should be provided upon creating a new Wine prefix or installed as a package on most distros. The process for installing Flashpoint this way is similar to how it is on Windows, except you may have to change the installation path to a location that can be written to, like your home folder. An example of a proper installation path would be <code>Z:\home\$USER\Flashpoint</code>, where you replace <code>$USER</code> with your username. You may get an error upon finishing the installation; this is expected behavior. Quit the installer and kill it from your process manager if needed, and all of the files should be where you installed them.
"${FP_LOC}/Launcher/flashpoint-launcher"
to:
"${FP_LOC}/Launcher/flashpoint-launcher" --ozone-platform-hint=auto
After making this change, the launcher should now open through Wayland when running the script. This only affects the launcher; content that runs in X11/Xwayland will continue to do so.


If you are following the [[#Using_Wine|Wine installation instructions]] below, you will have to make your own script and give it execute permissions to do this.
At this point, you can try to run the Windows version of the launcher through Wine, but it's recommended that you download the [https://github.com/FlashpointProject/launcher/releases/latest native Linux launcher] as a 7z file and replace everything in the <code>Launcher</code> folder with the files that are extracted from it. You may need to install the <code>p7zip</code> package to be able to extract the contents of the file. Once done, you can then run <code>Launcher/flashpoint-launcher</code> and set the "Flashpoint Path" in the launcher's config to <code>..</code>, then click "Save and Restart" on the bottom of the page. If everything has been done correctly, you should now have a working Flashpoint install! Note that not all platforms will work when installing Flashpoint this way, as Wine is not a perfect simulation of a typical Windows environment.
 
== Using Wine ==
 
Alternatively, you can attempt to run the Windows version of Flashpoint using [https://www.winehq.org/ Wine], which is a Windows compatibility layer. There are several advantages to doing this, like being able to run more up-to-date versions of Flashpoint that have only been made for Windows. However, it is not guaranteed that Wine will work properly, as the experience varies greatly depending on the hardware, choice of distribution, and packages you have installed. For this to work, you will need to install the QEMU x86 (e.g. <code>qemu-system-x86</code> on Arch) and <code>php</code> packages for your distro.
 
As of now, you can install the latest Windows version of Flashpoint Infinity by running the [https://github.com/FlashpointProject/FlashpointComponentTools/releases/latest/download/FlashpointInstaller.exe installer] through Wine. To be able to run the installer, you need to install a recent version of the .NET framework via Wine Mono, which should be provided upon creating a new Wine prefix or installed as a package on most distros. The process for installing Flashpoint this way is similar to how it is on Windows, except you may have to change the installation path to a location that can be written to, like your home folder. An example of a proper installation path would be <code>Z:\home\$name\Flashpoint</code>, where you replace <code>$name</code> with your username. You may get an error upon finishing the installation; this is expected behavior. Quit the installer and kill it from your process manager if needed, and most of the files (including all of the ones that are needed for Flashpoint to work) should be where you installed them.
 
At this point, you can try to run the Windows version of the launcher through Wine, but it's recommended that you download the [https://github.com/FlashpointProject/launcher/releases/latest/download/Flashpoint-12.0.0_linux-x64.7z native Linux launcher] and replace everything in the <code>Launcher</code> folder with the files that are extracted from the downloaded file. You may need to install a 7-Zip package to be able to extract the contents of the file. Once done, open <code>./Data/services.json</code> in a text editor and change the following line from:
"filename": "qemu-system-i386.exe",
to:
"filename": "qemu-system-i386",
This will start your installed QEMU program instead of attempting to run the bundled EXE file. You can then run <code>./Launcher/flashpoint-launcher</code> and set the "Flashpoint Path" in the launcher's config to <code>..</code>, then click "Save and Restart" on the bottom of the page. If everything has been done correctly, you should now have a working Flashpoint install! Note that not all platforms will work when installing Flashpoint this way, as Wine is not a perfect simulation of a typical Windows environment.


If you are having issues running Flashpoint with Wine, you can instead try using various other "flavors" such as [https://github.com/GloriousEggroll/wine-ge-custom Wine GE], which has extra patches applied that aren't in mainline Wine. Users of Arch-based distros can install Wine GE as a [https://aur.archlinux.org/packages/wine-ge-custom package from the AUR], however no binary is provided, so the package must be compiled.
If you are having issues running Flashpoint with Wine, you can instead try using various other "flavors" such as [https://github.com/GloriousEggroll/wine-ge-custom Wine GE], which has extra patches applied that aren't in mainline Wine. Users of Arch-based distros can install Wine GE as a [https://aur.archlinux.org/packages/wine-ge-custom package from the AUR], however no binary is provided, so the package must be compiled.


== Technologies ==
== Optional Enhancements ==
 
Flashpoint Infinity, like its Windows counterpart, uses <code>router.php</code> as a proxy server. But unlike Windows, Linux provides native ways to set per-application proxy settings, so no equivalent to the [https://github.com/FlashpointProject/FlashpointProxy Flashpoint Proxy library] is used. On Linux, each application is simply told via environment variables to use <code>localhost:22500</code> as a proxy server. For example, before Flashpoint Launcher opens the Flash projector, it sets the <code>http_proxy</code> environment variable to <code>http://localhost:22500/</code> in the docker container.
 
The [http://bluemaxima.org/flashpoint/faq/ Flashpoint FAQ] contains a list of all web game technologies ("Platforms") supported in the Windows version of Flashpoint. The Linux version currently supports a subset of these platforms. This is explained in detail below.
 
=== Supported Platforms ===
* Flash: Supported through Wine by default. Although a Linux Flash Projector exists, it suffers from graphical glitches on many systems. If you'd like to try your luck with the native projector, then tick it as a 'Native Platform' on the Config page.
* Shockwave: Supported through Wine.
* HTML5: Supported natively through the Basilisk browser.
* Java Applets: Supported natively using the Oracle JDK.
* Unity Web Player: Supported through Pipelight.
 
<noinclude>[[Category:Technologies]]</noinclude>
 
== Using the standalone projector ==
 
If you would like to run your own <code>.swf</code> file that is not packaged for Flashpoint, you can use the built-in Flash projector that is shipped with Flashpoint. Locate the Windows executable <code>FPSoftware/Flash/flashplayer_32_sa.exe</code> in the Flashpoint distribution you installed, and execute it with <code>wine</code> (you will have to install it separately, since Flashpoint on Linux invokes Wine through Docker). Make sure you have a 32-bit Wine installation. Pass the <code>.swf</code> file as a second argument to <code>wine</code>, after the <code>.exe</code>.
 
It's probably possible to use the native projector through the Docker setup, to avoid two separate Wine installations, but I haven't worked out how to do that quite yet.


Obviously, this only works for games that are using the Flash technology, and are single-file and not site-locked. Flashpoint exists because many games are not like this, and require extra work.
=== Wine Wayland Support ===
'''Enabling this feature could cause unforeseen bugs and break compatibility with some games/animations. Do so at your own risk.'''


As an alternative to the standalone projector bundled with Flashpoint, you can use the Linux native projector, which can be downloaded from a previous version of the Adobe website [https://web.archive.org/web/20220331041116/https://www.adobe.com/support/flashplayer/debug_downloads.html here].
Starting with Wine 8.4, a display driver was added that can be used to run Windows programs through Wayland instead of X11/Xwayland. To enable it, run the following command to modify the registry of the Wine prefix you want to use it on:
$ WINEPREFIX=/path/to/wine/prefix wine reg add "HKCU\\Software\\Wine\\Drivers" /v "Graphics" /d "wayland,x11"
Make sure to replace <code>/path/to/wine/prefix</code> with the actual path of the prefix you wish to modify. For examples, the default path is <code>$HOME/.wine</code> and the mutable version's path relative to the location of the Flashpoint directory is <code>FPSoftware/Wine</code>. After making this change, all programs running in Wine from now on should be using Wayland.
<noinclude>
[[Category:Technologies]]
</noinclude>

Latest revision as of 00:26, 28 July 2024

Linux support in Flashpoint is currently experimental due to a lack of maintainers. This page describes the current state of our Linux support. If you need assistance with installing or playing, ask in the #help channel on the Discord server.

Flashpoint for Linux supports Flash, HTML5, Shockwave, Unity, Java and various other web platforms. Not everything is supported, such as DevalVR and Viscape. If you want support for platforms that are Windows-exclusive, there are a few options to get the Windows version of Flashpoint running on Linux:

Otherwise, if you do not need support for those platforms, try any of the methods of launching Flashpoint listed below.

Immutable Version

Notes

This is an old build is designed for use on distros with an immutable rootfs, such as SteamOS, NixOS, Fedora Silverblue, etc. Most of the dependencies, including Wine, PHP and GTK3, are already included within the installation directory. No packages should need to be installed in order for this version to work, but due to compatibility issues with specific configurations, your system may still complain about missing libraries. More space will be needed to run this compared to the mutable version, so if you are able and willing to install a couple packages to save space, use the mutable version instead.

If you have Nix on your system, you can also launch the mutable version of Flashpoint under a Nix shell or with steam-run (nix-shell -p steam-run --run "steam-run ./start-flashpoint.sh").

Installation

  1. Download this archive file.
  2. Extract the contents of the file to an empty folder that your user has read & write permissions for. This can be done graphically, or in the terminal by entering the following in the directory the file is in:
    $ 7zr x fp13_linux_*.7z -oFlashpoint
  3. Open the folder you extracted Flashpoint to, then run start-flashpoint.sh to open the launcher.

After the installation is complete, you should not move any files in the Flashpoint folder at all. Moving the wrong file/folder could break the entire program until it is moved back.

A README document is provided that has some additional notes.

Mutable Version

Compatibility

Since the Flashpoint launcher is based on Electron, the minimum requirements are identical to Chromium. According to Google, they are as follows:

  • 64-bit Ubuntu 18.04+, Debian 10+, or Fedora 32+
  • An Intel Pentium 4 or later processor that's SSE3 capable

Rolling-release distros like Arch and Gentoo are also supported.

It is possible for a distro that doesn't meet these requirements to still be able to run Flashpoint if the system packages are new enough. If you use an older distro than the listed minimums and are unable to open the launcher, you could try adding a repository from a newer, supported version of the same distro and updating your packages that way. Beware though, because doing so could cause damage to your system if not done carefully.

Dependencies

This version of Flashpoint for Linux requires the following dependencies to be installed at runtime:

Dependency package names on various distros
Distro PulseAudio1 X112 32-bit Xcomposite GTK3 NSS PHP Wine bash
Debian-likea pulseaudio xserver-xorg-core libxcomposite1:i386 libgtk-3-0 libnss3 php (see this page) bash
Ubuntu-likeb pulseaudio xserver-xorg-core libxcomposite1:i386 libgtk-3-0 libnss3 php (see this page) bash
Fedora-like pulseaudio xorg-x11-server-Xorg libXcomposite.i686 gtk3 nss php (see this page) bash
Arch-likec pulseaudio xorg-server lib32-libxcomposite gtk3 nss php wine bash

a: E.g. ChromeOS Terminal, MX Linux | b: E.g. Linux Mint, Pop!_OS, Zorin OS | c: E.g. Manjaro, EndeavourOS

Note: Chances are that Wine and PHP will be the only packages that you'll need to install, as most distributions come with the rest of the packages already pre-installed.

There are also some packages that aren't required, but can enhance your experience:

Optional dependencies
Distro GTK23 LibXt3
Debian-like libgtk2.0-0 libxt6
Fedora-like gtk2 libXt
Arch-like gtk2 libxt

1: PipeWire can also be used in place of PulseAudio by installing the pipewire-pulse package on Ubuntu-like and Arch-like distros, or pipewire-pulseaudio on Fedora-like distros. For Debian-like distros, see this link.

2: X11 can also be used within Wayland by installing the xwayland package on Debian-like and Ubuntu-like distros, xorg-x11-server-Xwayland on Fedora-like distros, or xorg-xwayland on Arch-like distros.

3: Required for native Flash support. To support versions <27, the 32-bit version of this package must be installed instead.

To install them, use your distro's package manager:

Distro Package manager install command
Debian-like sudo apt-get install {PACKAGE}
Fedora-like sudo dnf install {PACKAGE}
Arch-like sudo pacman -S {PACKAGE}

Setup

Make sure you have at least 4 GB of free space, and that you have p7zip installed to be able to extract from 7z files.

Installation

  1. Download this archive file.
  2. Extract the contents of the file to an empty folder that your user has read & write permissions for. This can be done graphically, or in the terminal by entering the following in the directory the file is in:
    $ 7zr x fp13_linux_*.7z -oFlashpoint
  3. Open the folder you extracted Flashpoint to, then run start-flashpoint.sh to open the launcher.

After the installation is complete, you should not move any files in the Flashpoint folder at all. Moving the wrong file/folder could break the entire program until it is moved back.

A README document is provided that has a recap of some instructions shown in this section, as well as some additional notes.

Nix Shell

The mutable version of Flashpoint can also be launched under a Nix shell if Nix is installed:

{ pkgs ? import <nixpkgs> {} }:

(pkgs.buildFHSEnv {
    name = "flashpoint";
    targetPkgs = pkgs: (with pkgs; [
        # Shell utils
        toybox
        # Electron for the launcher.
        electron
        # Flashpoint requirements
        pipewire pulseaudio
        gtk3 gtk2 nss php wine
        xorg.libX11 xorg.libXt xorg.libXcomposite
        # ldd requirements
        mesa #libgbm
        glib nspr at-spi2-atk cups dbus libdrm pango cairo expat libxkbcommon alsa-lib
        xorg.libXdamage xorg.libXext xorg.libXfixes xorg.libXrandr xorg.libxcb
        udev
    ]);
}).env

Simply save this code into a .nix file and run it with nix-shell {file}.nix --run ./start-flashpoint.sh.

You can also use steam-run (nix-shell -p steam-run --run "steam-run ./start-flashpoint.sh").

Minimal-Dependency Version

If you are looking for a fully-native or minimal setup Flashpoint experience on Linux, Flashpoint Nano exists as a lightweight (albeit heavily limited) script-based alternative to the other installation options.

Only two platforms are supported: Flash (using Ruffle; non-embedded entries only) and HTML5 (using Pale Moon). Each software is Linux-native, downloaded upon first launch and updated automatically.

Due to the inherently barebones nature of this option, do not expect to receive help in the Discord if a specific game does not work.

Dependencies

Only a few command-line utilities that may not be available on your system by default are required: tar, curl, sqlite3, and unxz (from XZ Utils). You should be able to install these using your distro's package manager.

Installation

  1. Download Nano from the GitHub repository by clicking the Code button and then Download ZIP. Alternatively, if you have git installed, you can use the git clone https://github.com/WumboSpasm/flashpoint-nano.git command to download the repository. The latter option may be preferable so you can download updates to the scripts using git pull.
  2. If you downloaded the ZIP archive, extract it using your method of choice.
  3. Enter the created directory and run the following command in the terminal: ./flashpoint.sh <entry-id>. You can find the ID of the desired entry using the Flashpoint Database search tool. If you wish to launch an additional application, simply append its ID to the end of your command (with a space separating it from the entry ID).

Windows Version Using Wine

Alternatively, you can attempt to run the Windows version of Flashpoint using Wine, which is a Windows compatibility layer. There are several advantages to doing this, like being able to run more up-to-date versions of Flashpoint that have only been made for Windows. However, it is not guaranteed that Wine will work properly, as the experience varies greatly depending on the hardware, choice of distribution, and packages you have installed. For this to work, you currently need to install either the development or staging versions of Wine running a completely fresh prefix. How to install them depends on the distro, so consult WineHQ's download page for instructions on yours. Additionally, you will also need the php package for Flashpoint to work post-install.

As of now, you can install the latest Windows version of Flashpoint Infinity by running the installer through Wine. To be able to run the installer, you need to install a recent version of the .NET framework via Wine Mono, which should be provided upon creating a new Wine prefix or installed as a package on most distros. The process for installing Flashpoint this way is similar to how it is on Windows, except you may have to change the installation path to a location that can be written to, like your home folder. An example of a proper installation path would be Z:\home\$USER\Flashpoint, where you replace $USER with your username. You may get an error upon finishing the installation; this is expected behavior. Quit the installer and kill it from your process manager if needed, and all of the files should be where you installed them.

At this point, you can try to run the Windows version of the launcher through Wine, but it's recommended that you download the native Linux launcher as a 7z file and replace everything in the Launcher folder with the files that are extracted from it. You may need to install the p7zip package to be able to extract the contents of the file. Once done, you can then run Launcher/flashpoint-launcher and set the "Flashpoint Path" in the launcher's config to .., then click "Save and Restart" on the bottom of the page. If everything has been done correctly, you should now have a working Flashpoint install! Note that not all platforms will work when installing Flashpoint this way, as Wine is not a perfect simulation of a typical Windows environment.

If you are having issues running Flashpoint with Wine, you can instead try using various other "flavors" such as Wine GE, which has extra patches applied that aren't in mainline Wine. Users of Arch-based distros can install Wine GE as a package from the AUR, however no binary is provided, so the package must be compiled.

Optional Enhancements

Wine Wayland Support

Enabling this feature could cause unforeseen bugs and break compatibility with some games/animations. Do so at your own risk.

Starting with Wine 8.4, a display driver was added that can be used to run Windows programs through Wayland instead of X11/Xwayland. To enable it, run the following command to modify the registry of the Wine prefix you want to use it on:

$ WINEPREFIX=/path/to/wine/prefix wine reg add "HKCU\\Software\\Wine\\Drivers" /v "Graphics" /d "wayland,x11"

Make sure to replace /path/to/wine/prefix with the actual path of the prefix you wish to modify. For examples, the default path is $HOME/.wine and the mutable version's path relative to the location of the Flashpoint directory is FPSoftware/Wine. After making this change, all programs running in Wine from now on should be using Wayland.