Difference between revisions of "Linux Support"

From Flashpoint Database
Jump to: navigation, search
(Current build relies on xhost, which some distros do not come with. Added xhost to dependency table.)
m (Pushing further with the idea: using core server instead of server + drivers for Debian/Ubuntu (Equivalent package to those for Fedora & Arch))
(5 intermediate revisions by the same user not shown)
Line 23: Line 23:
 
!bash
 
!bash
 
|-
 
|-
!Debian
+
!Debian-like<span style="color:#0000ff"><small><sup>a</sup></small></span>
 
|(see [https://docs.docker.com/engine/install/debian/ this page])
 
|(see [https://docs.docker.com/engine/install/debian/ this page])
 
|pulseaudio
 
|pulseaudio
|xorg
+
|xserver-xorg-core
 
|x11-xserver-utils
 
|x11-xserver-utils
 
|php
 
|php
 
|bash
 
|bash
 
|-
 
|-
!Ubuntu, Linux Mint
+
!Ubuntu-like<span style="color:#0000ff"><small><sup>b</sup></small></span>
 
|(see [https://docs.docker.com/engine/install/ubuntu/ this page])
 
|(see [https://docs.docker.com/engine/install/ubuntu/ this page])
 
|pulseaudio
 
|pulseaudio
|xorg
+
|xserver-xorg-core
 
|x11-xserver-utils
 
|x11-xserver-utils
 
|php
 
|php
Line 47: Line 47:
 
|bash
 
|bash
 
|-
 
|-
!Arch-like
+
!Arch-like<span style="color:#0000ff"><small><sup>c</sup></small></span>
 
|docker
 
|docker
 
|pulseaudio
 
|pulseaudio
Line 55: Line 55:
 
|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>
  
 
'''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 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.
  
<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. For Debian, see [https://wiki.debian.org/PipeWire#Using_as_a_substitute_for_PulseAudio.2FJACK.2FALSA this link].
+
<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].
  
<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, and <code>xorg-xwayland</code> on Arch-like distros.
+
<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.
  
  
Line 68: Line 69:
 
!Package manager install command
 
!Package manager install command
 
|-
 
|-
!Debian
+
!Debian-like
 
|<code>sudo apt-get install {PACKAGE}</code>
 
|<code>sudo apt-get install {PACKAGE}</code>
 
|-
 
|-
!Ubuntu, Linux Mint
+
!Ubuntu-like
 
|<code>sudo apt-get install {PACKAGE}</code>
 
|<code>sudo apt-get install {PACKAGE}</code>
 
|-
 
|-
Line 83: Line 84:
 
|<code>sudo pacman -S {PACKAGE}</code>
 
|<code>sudo pacman -S {PACKAGE}</code>
 
|}
 
|}
 
 
=== Installation ===
 
=== Installation ===
 
Before you start, you need to [https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user configure Docker to run as a non-root user], then reboot your computer.
 
Before you start, you need to [https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user configure Docker to run as a non-root user], then reboot your computer.
  
If you have an Nvidia GPU, 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 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.
  
 
Then, 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.
 
Then, 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.
Line 112: Line 112:
 
== Technologies ==
 
== Technologies ==
  
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> in the docker container.
+
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.
 
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.

Revision as of 06:23, 24 September 2022

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.

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

  • Download the Windows version of Flashpoint and run it in a Windows virtual machine. This is the recommended non-native option.
  • Run the Windows version of Flashpoint with Wine. This works well on some computers, but does not work consistently.

Otherwise, download the latest Docker Flashpoint package and install it.

Manual Installation

Dependencies

First, install Flashpoint's dependencies.

Dependency package names on various distros
Library/command name Docker PulseAudio* X11** XHost PHP bash
Debian-likea (see this page) pulseaudio xserver-xorg-core x11-xserver-utils php bash
Ubuntu-likeb (see this page) pulseaudio xserver-xorg-core x11-xserver-utils php bash
Fedora-like (see this page) pulseaudio xorg-x11-server-Xorg xhost php bash
Arch-likec docker pulseaudio xorg-server xorg-xhost php bash

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

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.

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

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


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

Distro Package manager install command
Debian-like sudo apt-get install {PACKAGE}
Ubuntu-like sudo apt-get install {PACKAGE}
Fedora-like sudo dnf install {PACKAGE}
Fedora-like (old) sudo yum install {PACKAGE}
Arch-like sudo pacman -S {PACKAGE}

Installation

Before you start, you need to configure Docker to run as a non-root user, then reboot your computer.

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 nvidia-docker2 package. Follow the "Setting up NVIDIA Container Toolkit" instructions under the heading corresponding to your distro here. If you use an Arch-like distro, install either nvidia-container-toolkit or nvidia-docker from the AUR if you did or didn't already install Docker respectively.

Then, download the latest Docker Flashpoint package if you haven't already and extract it somewhere.

Go to the place where you extracted it, and pull the docker images by running ./pull.sh. They'll take ~3.5 GB.

Finally, run the ./flashpoint executable script to start the launcher.


Config files can be found in ./LinuxConf/ and ./FPSoftware/FSPConfigs/.

Save data is stored in ./SaveData. Java save data isn't persistent, because there's no standardized location for it.

Troubleshooting

proxy.sh: "Permission denied" error

Depending on your system's permissions, the proxy.sh 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:

  1. Close the Flashpoint launcher.
  2. Open ./LinuxConf/proxy.sh in a text editor.
  3. Change /var/lock/flashpoint-networking.lock to /tmp/flashpoint-networking.lock and save the file.
  4. Relaunch Flashpoint.

Technologies

Flashpoint Infinity, like its Windows counterpart, uses router.php as a proxy server. But unlike Windows, Linux provides native ways to set per-application proxy settings, so no equivalent to the Flashpoint Proxy library is used. On Linux, each application is simply told via environment variables to use localhost:22500 as a proxy server. For example, before Flashpoint Launcher opens the Flash projector, it sets the http_proxy environment variable to http://localhost:22500/ in the docker container.

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