Linux Support: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
(Add non-destructive wineprefix switching method.)
(→‎Mutable Version: Updated to 20240226)
 
(101 intermediate revisions by 11 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 #flashpoint-mac-linux-help.
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 Discord server.


Unfortunately, no up-to-date Flashpoint packages are currently available. There are a few options to get Flashpoint running:
Flashpoint for Linux supports Flash, HTML5, Shockwave, Unity, Java and various other web platforms. The exceptions are content that uses the Chromium browser, and Shockwave content that plays in-browser.
* [https://bluemaxima.org/flashpoint/downloads/ Download the Windows version of Flashpoint] and run it in a Windows virtual machine. This is your best bet right now.
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:
* Run the Windows version of Flashpoint with [[#Wine|Wine]]. This works well on some computers, but does not work consistently.
* [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.
* Download the outdated Flashpoint 10.0 package and [[#Manual Installation (for advanced users)|manually update it]] to get it working. This should work more consistently, as long as you are able to follow all of the steps.
* [[#Windows_Version_Using_Wine|Run the Windows version of Flashpoint with Wine]]. This works well on some computers, but does not work consistently.


== Stand-Alone Packages ==
Otherwise, follow any of the instructions below.
== Immutable Version ==


These are standalone packages suitable for all common Linux distributions.
=== Notes ===


Unfortunately, no working packages are currently available. See the [[/Outdated Packages/]] page for previous builds, but be aware that they will not work properly. They are only useful as examples of completed builds, in case developers need them when working on future builds.
This build is recommended for use on distros with an immutable rootfs, such as SteamOS 3 for the Steam Deck. If you don't fit this criteria or don't know what that means, it is recommended that you install the [[#Mutable_Version|mutable version]] instead.


== Distro-specific Packages ==
QEMU and PHP are bundled in an included Junest Arch proot Appimage.


These are experimental packages for specific Linux distributions. If you don't see a package for your system here, '''please use the stand-alone package instead!''' If you can help update these packages, please visit the Discord server and join #development-chat.
=== Current Issues ===


Unfortunately, no working packages are currently available. See the [[/Outdated Packages|Outdated Packages]] page for previous builds, but be aware that they will not work properly. They are only useful as examples of completed builds, in case developers need them when working on future builds.
QEMU with the default <code>-display none</code> crashes upon launch, but displays fine allowing the GTK window to appear. The install script accounts for this.


== Manual Installation (for advanced users) ==
If running on the Steam Deck Game Mode session, mouse is locked to QEMU size and Flash games in Wine only render black. It is recommended to use desktop mode on the Deck.


No up-to-date Flashpoint packages for Linux are currently available, but with a few extra steps, you can download the outdated Flashpoint 10.0 package and update it to work again. The steps for doing so are below.
HTML5/Unity/browser games that use <code>FPSecure/Basilisk</code> are a hit and miss for compatibility. This is down to the browser interaction with Wine.


Dependencies: git, 7zip, tar, wine(32 bit), wget, glibc>=2.29, php, qemu (a qemu package that provide qemu-system-i386 is required)
=== Instructions ===


First open a new terminal and type the following commands:
# Download [https://download.unstable.life/upload/fp121autolinux.tar.gz this archive file] to a memorable folder.
# Change the working directory to your home directory
# Change directory to the folder it was moved to.
cd
#Run <code>tar xvf fp121autolinux.tar.gz && ./install_flashpoint.sh</code> within a terminal session to extract the archive and install Flashpoint.
# Create the required directories
mkdir --verbose --parents opt/flashpoint/{launcher,data}
# Get the new flashpoint launcher (version 10.1.1)
cd opt/flashpoint/launcher
wget https://github.com/FlashpointProject/launcher/releases/download/10.1.1/Flashpoint-10.1.1_linux-x64.7z
7z x ./Flashpoint-10.1.1_linux-x64.7z
rm -v Flashpoint-10.1.1_linux-x64.7z
# Because PHP and QEMU are not killed correctly upon exit, create this launch script:
cat << EOF > flashpoint
#!/bin/sh
cd $HOME/opt/flashpoint/launcher
$HOME/opt/flashpoint/launcher/flashpoint-launcher
killall php
killall qemu-system-i386
EOF
# Get Flashpoint 10.0 Infinity
cd ../data
wget https://bluepload.unstable.life/flashpoint-10-linux-x64.tar.gz
tar --extract --verbose --file=./flashpoint-10-linux-x64.tar.gz
rm --verbose ./flashpoint-10-linux-x64.tar.gz


=== Fix qemu failing to start ===
You will end up with a Flashpoint folder. Run <code>start-flashpoint.sh</code> within that folder to start the Launcher.
Execute the following command:
qemu-system-i386 -machine help | grep pc-i440fx-6.0
If that command outputs "pc-i440fx-6.0        Standard PC (i440FX + PIIX, 1996)" then open the file opt/flashpoint/data/services.json and change the line 34 from:
"arguments": ["-m", "512", "-net", "nic,model=e1000", "-net", "user,hostfwd=tcp:127.0.0.1:22500-:80", "-qmp", "tcp:127.0.0.1:4444,server,nowait", "-qmp", "tcp:127.0.0.1:4445,server,nowait", "-hda", "alpine.qcow2", "-loadvm", "quick", "-display", "none"],
to
"arguments": ["-m", "512", "-machine", "pc-i440fx-6.0", "-net", "nic,model=e1000", "-net", "user,hostfwd=tcp:127.0.0.1:22500-:80", "-qmp", "tcp:127.0.0.1:4444,server,nowait", "-qmp", "tcp:127.0.0.1:4445,server,nowait", "-hda", "alpine.qcow2", "-loadvm", "quick", "-display", "none"],
If there is no output to the command "qemu-system-i386 -machine help | grep pc-i440fx-6.0" start qemu with the following command:
qemu-system-i386 -m 512 -net nic,model=e1000 -net user,hostfwd=tcp:127.0.0.1:22500-:80 -hda ~/opt/flashpoint/data/Server/alpine.qcow2
Wait for the alpine system to boot up and open the View menu and select compatmonitor0 and type the commands:
delvm quick
savevm quick
quit
Open flashpoint with the command "flashpoint" and then go to Config and on the Flashpoint section set the Flashpoint Path to ../data then scroll down and click on the "Save & Restart" button.


== Troubleshooting ==
== Mutable Version ==


If the Flash Player crashes immediately when launched, there are a few possible solutions:
=== Compatibility ===
* Replace our hacked Flash projector with the original, unhacked Adobe Flash projector. Follow these steps:
Since the Flashpoint launcher is based on Electron, the minimum requirements are identical to Chromium. According to Google, they are as follows:
*# [https://drive.google.com/file/d/1Dt3EGqB6SmfM1hkGszUMnYYlNo7RtlhD/view?usp=sharing Download the projector from here]
* 64-bit Ubuntu 18.04+, Debian 10+, or Fedora 32+
*# In your Flashpoint folder, open <code>FPSoftware/Flash</code>
* An Intel Pentium 4 or later processor that's SSE3 capable
*# Replace the <code>flashplayer_32_sa.exe</code> file with the one you downloaded.
Rolling-release distros like Arch and Gentoo are also supported.
* Remove wine-dxvk from your system. This causes problems with the Flash projector on some computers.


<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>


In some cases, a problem with Wine may prevent games in Flashpoint from working. Look for the following error in the Logs tab of the launcher:
=== Dependencies ===
wine: 'examplewinedirectory/.wine' is a 64-bit installation, it cannot be used with a 32-bit wineserver.
This version of Flashpoint for Linux requires the following dependencies to be installed at runtime:
If you see this error, then run the following command to change the wineprefix that FP is trying to use.
{| class="wikitable"
sed -i "2 i export WINEPREFIX=$HOME/.wine_fp" "$HOME/opt/flashpoint/launcher/flashpoint"
!colspan="9"|Dependency package names on various distros
Alternatively, you can take a more destructive route: navigate to your Wine directory and run the commands below to resolve the problem. Note that this deletes your current wineprefix.
|-
rm -r .wine/
!Distro
winecfg
!PulseAudio<small><sup><span style="color:#0000ff">1</span></sup></small>
!X11<small><sup><span style="color:#0000ff">2</span></sup></small>
!32-bit Xcomposite
!GTK3
!NSS
!PHP
!Wine
!bash
|-
!Debian-like<span style="color:#0000ff"><small><sup>a</sup></small></span>
|pulseaudio
|xserver-xorg-core
|libxcomposite1:i386
|libgtk-3-0
|libnss3
|php
|(see [https://wiki.winehq.org/Debian this page])
|bash
|-
!Ubuntu-like<span style="color:#0000ff"><small><sup>b</sup></small></span>
|pulseaudio
|xserver-xorg-core
|libxcomposite1:i386
|libgtk-3-0
|libnss3
|php
|(see [https://wiki.winehq.org/Ubuntu this page])
|bash
|-
!Fedora-like
|pulseaudio
|xorg-x11-server-Xorg
|libXcomposite.i686
|gtk3
|nss
|php
|(see [https://wiki.winehq.org/Fedora this page])
|bash
|-
!Arch-like<span style="color:#0000ff"><small><sup>c</sup></small></span>
|pulseaudio
|xorg-server
|lib32-libxcomposite
|gtk3
|nss
|php
|wine
|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, EndeavourOS</small>


== Technologies ==
'''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.


Flashpoint Infinity, like its Windows counterpart, it 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>.
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].


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.
<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.


=== Supported Platforms ===
<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>
* 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 either turn off use Wine, or tick it as a 'Native Platform' on the Config page.
* Shockwave: Supported through Wine.
* HTML5: Supported natively through the Basilisk browser. To update Basilisk, download it from [http://us.basilisk-browser.org/release/basilisk-latest.linux64.tar.bz2 here] and extract it such that the executable is located at <code>FPSoftware/Basilisk-Portable/linux/basilisk</code>. By default, Basilisk will store its configuration in the location defined by <code>XDG_CONFIG_DIR</code>, so Flashpoint uses a shell script to set the configuration location. A pre-configured copy of Basilisk, along with the shell script, is packaged and also available [https://drive.google.com/file/d/1Y5Mgm9dCa4gCc6UF5WFPqQruzsO81xhf/view?usp=sharing here]. This [https://cdn.discordapp.com/attachments/516027726851735632/612891261665411073/BasiliskSetup.txt text file] describes Basilisk's configuration.
* Java Applets: Supported natively using the OpenJDK. This support is not currently working, however.
* Unity Web Player: Supported through Wine. Unity 2.x and 3.x games may not work; this needs further testing.
* PopCap Plugin: Supported through Wine.
* Authorware Web Player: Supported through Wine.
* GoBit Plugin: Supported through Wine.


=== Unsupported Platforms ===
To install them, use your distro's package manager:
* Silverlight: In the past, [http://www.webupd8.org/2013/08/pipelight-use-silverlight-in-your-linux.html Pipelight] allowed Linux users to use Silverlight, but the repository is no longer available for most Linux distros. [https://www.maketecheasier.com/install-and-run-silverlight-in-linux/ Moonlight] was another option, but is also no longer available. Attempts to use Silverlight in K-Meleon using Wine have failed.
{|class="wikitable"
* 3DVIA Player: A previous tester received this error, which crashed K-Meleon: <code>Error: Access was denied while trying to open files in your profile directory</code>. We need another tester to help us narrow this down.
!Distro
* 3D Groove GX: When the http_proxy variable is set, Groove Player downloads but fails to load the file. Maybe the registry method described [https://wiki.winehq.org/FAQ#How_do_I_configure_a_proxy.3F here] would work better, but this needs to be tested. Two of our testers received the following set of errors: [https://media.discordapp.net/attachments/496132309498724391/577330595609444352/unknown.png 1] [https://media.discordapp.net/attachments/496132309498724391/577330680678055948/unknown.png 2] [https://media.discordapp.net/attachments/496132309498724391/577330740396556309/unknown.png 3]
!Package manager install command
* ActiveX: The most promising method so far was to install Internet Explorer 8 and each ActiveX plugin into the Wine prefix, but this needs considerable work.
|-
!Debian-like
|<code>sudo apt-get install {PACKAGE}</code>
|-
!Fedora-like
|<code>sudo dnf install {PACKAGE}</code>
|-
!Arch-like
|<code>sudo pacman -S {PACKAGE}</code>
|}


== Wine ==
=== Setup ===
Most games rely on technology only available on Windows. A lot of these however can be run through Wine. If there is no native executable, or you have the Native Platform option unticked for the game's platform then the launcher will run it through Wine.
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.


You may choose to use the native versions, in which case tick the platform under Native Platforms in Config.
=== Installation ===
# Download [https://download.unstable.life/upload/fp121_linux_20240226.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 fp121_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.


If you wish to play games that rely on Wine, be sure to install the 32-bit version of Wine. There are links below to distro specific install guides:
A README document is provided that has a recap of some instructions shown in this section, as well as some additional notes.


* Ubuntu - https://wiki.winehq.org/Ubuntu
== Minimal-Dependency Version ==
* Debian - https://wiki.debian.org/Wine#Installation_on_Debian_Jessie_and_newer
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.
* Arch Linux - https://wiki.archlinux.org/index.php/Wine#Installation


=== Important Note ===
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.


Update: As of Wine 6.0-rc1, Shockwave appears to be working again. If you are on 5.22, keep an eye out for an update from your distribution.  
'''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.'''


<s>As of Wine 5.22, the Shockwave wrappers are no longer launching. Avoid updating Wine until a fix is found.</s>
=== 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.


== Changelog ==
=== Installation ===
# 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>.
# If you downloaded the ZIP archive, extract it using your method of choice.
# 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).


; 2021-07-26
== Windows Version Using Wine ==
: Added 10.0 Infinity package


; 2021-02-16
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.
: Added Core/Ultimate standalone package for 9.0 based on 8.1 Infinity standalone


; 2020-11-07
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.
: Updated .deb to Flashpoint 8.2-2 Infinity
: Added native executables for Flash and HTML5
: Replaced modified Flash Projectors with the unmodified ones
: Fixed extreme games option being disabled in config.json


; 2020-10-23
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.
: Updated .deb to Flashpoint 8.2-1 Infinity


; 2020-07-04
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.
: Updated to Flashpoint 8.1 Infinity
: Updated to Flashpoint Launcher 9.0.2


; 2019-09-28
== Optional Enhancements ==
: Updated to Flashpoint 6.3
: Bundled WIP Launcher with better Multi-Platform Support:
:* Proper linux argument escaping (Supersonic RC works now, yay!)
:* SPR games automatically use port 22500 (Hacky, may be removed later)
:* Wine will always (and only) be used for running .exe files (even if use Wine is turned off in Config)
:* .bat files will always run their .sh equivalents (even if use Wine is turned on in Config)
:* Windows execs are mapped to native execs (if existing), so Windows game XMLs should work out the box. (See execs.json)
:* Can mark a platform as 'native' in Config, will force native execs to be used instead of Windows execs even if use Wine is turned on.
:** If no native execs are available (like Shockwave) then it will fallback to running the Windows exec with Wine.
: Added native Basilisk support files
: Updated SPR files
: Updated router.php


; 2019-09-18
=== Wayland Support ===
: Added new SPR version (see update-spr.sh) and Shockwave XMLs
'''Neither of these apply to the minimal-dependency version.'''
: Added interim Launcher hack to make Shockwave games that use SPR work properly
: Made the save manager scripts use a valid interpreter (/bin/sh)
:* TODO: they still need further work/testing


; 2019-07-21 and prior
==== Launcher ====
: Configure Flash games to run using the Windows player, flashplayer_32_sa.exe
'''This enhancement is already applied in the mutable version.'''
:* The Linux flash player suffers from too many graphical glitches
:* Requires Wine to be installed and enabled to play
: Updated JDK to version 8u212
:* startJava.sh instructions and script updated
:* Made startJava.sh executable
: Added support for Authorware Platform
: Adds Linux versions of the Save Manager scripts
: Adds a "Flashpoint" shortcut (replacing the Windows version)
: Adds Flashpoint 6.2 games
: Removed the game logos, as in Flashpoint Infinity 6.2 for Windows
: Removed the Wineprefix because it was not used


'''To-Do List'''
The Flashpoint launcher is based on a version of Electron that has experimental support for running through Wayland instead of X11/Xwayland. To enable this feature, open the script used to run the launcher in a text editor and change the following line from:
* Allow the launcher to automatically start/stop the flashpoint server on Linux
Launcher/flashpoint-launcher
* Rewrite and test startUnity.sh and startJava.sh scripts
to:
* Find a way to get Basilisk working better in Wine, or use an alternative browser like K-Meleon
Launcher/flashpoint-launcher --ozone-platform-hint=auto
* Get Java working natively again with OpenJDK 8
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.
* Test Unity 2.x and 3.x games
* AMF support for games like Neon Rider for the community levels


<noinclude>[[Category:Technologies]]</noinclude>
If you are using Wine to run the Windows version with the native launcher [[Linux Support#Windows Version Using Wine|as explained above]], you will have to make your own script and give it execute permissions to do this.
 
==== Wine ====
'''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 <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 04:44, 27 February 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. The exceptions are content that uses the Chromium browser, and Shockwave content that plays in-browser. 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, follow any of the instructions below.

Immutable Version

Notes

This build is recommended for use on distros with an immutable rootfs, such as SteamOS 3 for the Steam Deck. If you don't fit this criteria or don't know what that means, it is recommended that you install the mutable version instead.

QEMU and PHP are bundled in an included Junest Arch proot Appimage.

Current Issues

QEMU with the default -display none crashes upon launch, but displays fine allowing the GTK window to appear. The install script accounts for this.

If running on the Steam Deck Game Mode session, mouse is locked to QEMU size and Flash games in Wine only render black. It is recommended to use desktop mode on the Deck.

HTML5/Unity/browser games that use FPSecure/Basilisk are a hit and miss for compatibility. This is down to the browser interaction with Wine.

Instructions

  1. Download this archive file to a memorable folder.
  2. Change directory to the folder it was moved to.
  3. Run tar xvf fp121autolinux.tar.gz && ./install_flashpoint.sh within a terminal session to extract the archive and install Flashpoint.

You will end up with a Flashpoint folder. Run start-flashpoint.sh within that folder to start the Launcher.

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 fp121_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.

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

Wayland Support

Neither of these apply to the minimal-dependency version.

Launcher

This enhancement is already applied in the mutable version.

The Flashpoint launcher is based on a version of Electron that has experimental support for running through Wayland instead of X11/Xwayland. To enable this feature, open the script used to run the launcher in a text editor and change the following line from:

Launcher/flashpoint-launcher

to:

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 using Wine to run the Windows version with the native launcher as explained above, you will have to make your own script and give it execute permissions to do this.

Wine

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.