Linux Support: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
(Updates and Nix details)
 
(139 intermediate revisions by 15 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.
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].


= Important note about Wine =
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:
* [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.
* [[#Windows_Version_Using_Wine|Run the Windows version of Flashpoint with Wine]]. This works well on some computers, but does not work consistently.


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.  
Otherwise, if you do not need support for those platforms, try any of the methods of launching Flashpoint listed below.


<s>As of Wine 5.22, the Shockwave wrappers are no longer launching. Avoid updating Wine until a fix is found.</s>
== Immutable Version ==


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


These are experimental packages for specific Linux distros. If you don't see a package for your system here, '''please use the [[#Latest_Stand-Alone_Package|stand-alone package]] instead!''' If you can help update these packages, please visit the Discord server and join #development-chat. If you need assistance with installing or playing, visit us at #flashpoint-mac-linux-help.
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>).


* '''Flashpoint Infinity 8.2-2 .deb (Debian / Ubuntu):
=== Installation ===
https://bluepload.unstable.life/flashpoint-infinity-8-2-2-amd64-deb.7z
# Download [https://download.unstable.life/upload/fp13_linux_20240425i.7z this archive file].
* PPA Repository - In Consideration.
# 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>
* AUR package currently not available - '''please use the [[#Latest_Stand-Alone_Package|stand-alone package]] instead'''
# 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.


== Debian Installation Procedure ==
A README document is provided that has some additional notes.


# Download and extract the .7z file above into any folder - /Downloads is fine.
== Mutable Version ==
# It's recommended to run the .deb from the command line so the install progress is clear. From the folder where the .deb is: <code>sudo apt install ./flashpoint-infinity_8.2-2_amd64.deb</code> and it will install. The install can take a while as it has wine and php as dependencies. Graphical installer (from just double-clicking in the .deb) might not show much info as dependencies are being installed and so it might appear frozen.


== First Run Procedure ==
=== Compatibility ===
After installation, start Flashpoint Infinity either from the command line as <code>flashpoint-infinity</code> or from your desktop environment (it should be listed in Games). At first run you'll get two popups: click 'Yes' on 'You must install the Upgrade on the home screen', and then 'yes' again to 'The Flashpoint folder is not set or is invalid. Do you want to choose a folder?'. Anywhere in your home directory is fine to install it (you need write access to it). Click 'yes' again to 'Is this correct?' if the directory is correct. You should see the download/extract progress, and then a prompt to restart. When it comes back up after restart all (60k!) games should be visible.
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+
It's recommended to use the native Basilisk for HTML5. To enable this change go to the config tab and in the Native Platforms drop-down, select the box for HTML5. For Flash it's still recommended to go through Wine (this is the default), though native Flash projectors can be enabled in the Native Platforms drop-down too if desired.  
* An Intel Pentium 4 or later processor that's SSE3 capable
Rolling-release distros like Arch and Gentoo are also supported.


On the first time using Wine to launch a game, it does some configuration so it could take some time.  
<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>


Flash, HTML5, and Shockwave games run well generally. More about other platforms below.
=== Dependencies ===
This version of Flashpoint for Linux requires the following dependencies to be installed at runtime:
{| class="wikitable"
!colspan="9"|Dependency package names on various distros
|-
!Distro
!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>


== Debian Update Procedure ==
'''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.
If you are updating the Debian package from a previous version, first back up your favorites and save data if you'd like to keep them.
Then run the .deb file same as above. Once the update is completed, open the launcher and click on Download, which will install the new Flashpoint folder.
Once it restarts the update is complete and all features of this version should be available.


== Notes about the Debian package ==
There are also some packages that aren't required, but can enhance your experience:
* The 'Flashpoint folder' above can go anywhere the user can write to - home is a convenient place for it
{| class="wikitable"
* It installs binaries into /usr/lib/flashpoint-infinity/, and /usr/bin/flashpoint-infinity links to the launcher
! colspan="6" |Optional dependencies
* Extreme games are disabled by default in version 8.2-1 which was up from October 23, 2020 until November 7, 2020. To enable them or change other configuration options, edit <code>config.json</code> in the <code>/usr/lib/flashpoint-infinity/</code> folder.
|-
* Debian source package: https://bluepload.unstable.life/flashpoint-infinity82-2debsrc.7z. The source lives as a branch 'debian' off of Launcher's /master (on one of Launcher's forks). This is the commit that is tagged "Infinity-8.2-2"
!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].


= Latest Stand-Alone Package =
<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.
'''Download''': https://bluepload.unstable.life/flashpoint81infinitylinux.7z
* This is the latest experimental stand-alone package of Flashpoint Infinity (8.1) for Linux, created on July 4, 2020. Currently everything is going through Wine.


'''Installation instructions''':
<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>
# Download and extract the .7z file.
# Install PHP and the 32-bit version of Wine if you do not have them. See [[#Wine|Wine installation instructions]] below.
# Change to the Launcher folder and run the flashpoint-launcher binary


''Previous link''
To install them, use your distro's package manager:
# Still needed if you want to make some of the platforms native
{|class="wikitable"
https://drive.google.com/file/d/1eai0nFWe0XNc8WbsIg-koOzLc7jk_b_k/view?usp=sharing
!Distro
!Package manager install command
|-
!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>
|}


'''Changelog''':
=== Setup ===
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.


2020-11-07
=== Installation ===
* Updated .deb to Flashpoint 8.2-2 Infinity
# Download [https://download.unstable.life/upload/fp13_linux_20240425m.7z this archive file].
* Added native executables for Flash and HTML5
# 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>
* Replaced modified Flash Projectors with the unmodified ones
# Open the folder you extracted Flashpoint to, then run <code>start-flashpoint.sh</code> to open the launcher.
* Fixed extreme games option being disabled in config.json
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.


2020-10-23
A README document is provided that has a recap of some instructions shown in this section, as well as some additional notes.
* Updated .deb to Flashpoint 8.2-1 Infinity


2020-07-04:
=== Nix Shell ===
* Updated to Flashpoint 8.1 Infinity
* Updated to Flashpoint Launcher 9.0.2


2019-09-28:
The mutable version of Flashpoint can also be launched under a Nix shell if Nix is installed:
* 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:
<pre>
* Added new SPR version (see update-spr.sh) and Shockwave XMLs
{ pkgs ? import <nixpkgs> {} }:
* 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:
(pkgs.buildFHSEnv {
* Configure Flash games to run using the Windows player, flashplayer_32_sa.exe
    name = "flashpoint";
** The Linux flash player suffers from too many graphical glitches
    targetPkgs = pkgs: (with pkgs; [
** Requires Wine to be installed and enabled to play
        # Shell utils
* Updated JDK to version 8u212
        toybox
** startJava.sh instructions and script updated
        # Electron for the launcher.
** Made startJava.sh executable
        electron
* Added support for Authorware Platform
        # Flashpoint requirements
* Adds Linux versions of the Save Manager scripts
        pipewire pulseaudio
* Adds a "Flashpoint" shortcut (replacing the Windows version)
        gtk3 gtk2 nss php wine
* Adds Flashpoint 6.2 games
        xorg.libX11 xorg.libXt xorg.libXcomposite
* Removed the game logos, as in Flashpoint Infinity 6.2 for Windows
        # ldd requirements
* Removed the Wineprefix because it was not used
        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>


'''To-Do List'''
Simply save this code into a .nix file and run it with <code>nix-shell {file}.nix --run ./start-flashpoint.sh</code>.
* Test Unity 2.x and 3.x games
* Fix startUnity.sh, since it modifies K-Meleon's config, which is no longer necessary
* AMF support for games like Neon Rider for the community levels


= Technologies =
You can also use <code>steam-run</code> (<code>nix-shell -p steam-run --run "steam-run ./start-flashpoint.sh"</code>).


Currently, only Flashpoint Infinity is available for Linux. 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>.
== 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.


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


== Supported Platforms ==
'''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.'''
* 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 JDK.
* 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 ==
=== Dependencies ===
* 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.
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.
* 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.
* 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]
* 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.


== Launcher Issues ==
=== Installation ===
A lot of work has been done to allow Flashpoint Launcher to support Linux, but there's a lot of room for improvement. This [https://trello.com/c/iriUET1L/51-path-rewriting-rules-for-multi-platform-support Trello post] outlines some potential improvements.
# 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).


== Wine ==
== Windows Version Using Wine ==
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.


You may choose to use the native versions, in which case tick the platform under Native Platforms in Config.
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.


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


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


== Pipelight ==
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.
Some work has been done on getting Pipelight working with flashpoint. Currently the pipelight plugin itself is figured out and shockwave has been tested working, but every NPAPI plugin has it's quirks and they have to made into pipelight versions one at a time.  


=== General Information ===
== Optional Enhancements ==
https://en.wikipedia.org/wiki/Pipelight


https://wiki.archlinux.org/index.php/Pipelight
=== Wine Wayland Support ===
'''Enabling this feature could cause unforeseen bugs and break compatibility with some games/animations. Do so at your own risk.'''


https://web.archive.org/web/20161120025536/fds-team.de/cms/articles/2013-08/pipelight-using-silverlight-in-linux-browsers.html
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"
=== Download Links ===
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.
Source: https://github.com/keithbowes/pipelight
<noinclude>
 
[[Category:Technologies]]
All in one package with instructions: https://mega.nz/file/38ZWBYQK#l-Wro8amBZ72iziegOFVOLrU_N2QwYFZQfsZ3m3naG0
</noinclude>
 
=== Problems Encountered ===
Unity gives "Failed to update Unity Web Player"
 
== Next Version ==
WIP Changelog:
* New Launcher features from Master
** Splash Screen while loading (no half loaded XMLs when browsing anymore)
** Search Overhaul
** Background Services in Developer (Restart/stop/start the Router on the fly)
* Removed 'Use Wine' option, effectively enabled by default, use 'Native Platforms' to use native execs instead.
* Partial ActiveX support, requires heavy testing. '''ThwartPoker, Butterfly Escape, Big City Adventure, Astro Avengers 2 and HamsterBall''' do not work yet.
* Updated startJava.sh to support multiple command-line parameters: replace <code>"$1"</code> with <code>"$@"</code> on line 8

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.