Flashpoint Datahub - User contributions [en]

Linux Support

2023-05-20T18:00:06Z

Raxod502: Fixed wiki formatting

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:
* [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.
* Run the Windows version of Flashpoint with [[#Wine|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]].

== Manual Installation ==

=== Dependencies ===
First, install Flashpoint's dependencies.
{| class="wikitable"
!colspan="9"|Dependency package names on various distros
|-
!Library/command name
!Docker
!PulseAudio*
!X11**
!XHost
!NSS
!PHP
!bash
|-
!Debian-likea
|(see [https://docs.docker.com/engine/install/debian/ this page])
|pulseaudio
|xserver-xorg-core
|x11-xserver-utils
|libnss3
|php
|bash
|-
!Ubuntu-likeb
|(see [https://docs.docker.com/engine/install/ubuntu/ this page])
|pulseaudio
|xserver-xorg-core
|x11-xserver-utils
|libnss3
|php
|bash
|-
!Fedora-like
|(see [https://docs.docker.com/engine/install/fedora/ this page])
|pulseaudio
|xorg-x11-server-Xorg
|xhost
|nss
|php
|bash
|-
!Arch-likec
|docker
|pulseaudio
|xorg-server
|xorg-xhost
|nss
|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 <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].

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

To install them, use your distro's package manager:
{|class="wikitable"
!Distro
!Package manager install command
|-
!Debian-like
|<code>sudo apt-get install {PACKAGE}</code>
|-
!Ubuntu-like
|<code>sudo apt-get install {PACKAGE}</code>
|-
!Fedora-like
|<code>sudo dnf install {PACKAGE}</code>
|-
!Fedora-like (old)
|<code>sudo yum install {PACKAGE}</code>
|-
!Arch-like
|<code>sudo pacman -S {PACKAGE}</code>
|}

=== Pre-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 be managed by a non-root user]. Once finished, you may have to reboot your computer if the permissions aren't applied properly when trying to run Docker commands as a non-root user.

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 <code>docker</code> 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, my script retrieves my password from my password manager, <code>pass</code>, which will force authentication through a graphical dialog before retrieving the password. Technically you could just hardcode your password in the script, but this would sort of 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 ===
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.

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.

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

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

Save data is stored in <code>./SaveData</code>. 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 <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:
# Close the Flashpoint launcher.
# 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 ===

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:
# 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.
== Technologies ==

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.

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

Linux Support

2023-05-17T02:41:04Z

Raxod502: Add info about configuring Docker for Flashpoint more securely, and add a section on using the standalone projector. Discussed in the Discord

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:
* [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.
* Run the Windows version of Flashpoint with [[#Wine|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]].

== Manual Installation ==

=== Dependencies ===
First, install Flashpoint's dependencies.
{| class="wikitable"
!colspan="9"|Dependency package names on various distros
|-
!Library/command name
!Docker
!PulseAudio*
!X11**
!XHost
!NSS
!PHP
!bash
|-
!Debian-likea
|(see [https://docs.docker.com/engine/install/debian/ this page])
|pulseaudio
|xserver-xorg-core
|x11-xserver-utils
|libnss3
|php
|bash
|-
!Ubuntu-likeb
|(see [https://docs.docker.com/engine/install/ubuntu/ this page])
|pulseaudio
|xserver-xorg-core
|x11-xserver-utils
|libnss3
|php
|bash
|-
!Fedora-like
|(see [https://docs.docker.com/engine/install/fedora/ this page])
|pulseaudio
|xorg-x11-server-Xorg
|xhost
|nss
|php
|bash
|-
!Arch-likec
|docker
|pulseaudio
|xorg-server
|xorg-xhost
|nss
|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 <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].

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

To install them, use your distro's package manager:
{|class="wikitable"
!Distro
!Package manager install command
|-
!Debian-like
|<code>sudo apt-get install {PACKAGE}</code>
|-
!Ubuntu-like
|<code>sudo apt-get install {PACKAGE}</code>
|-
!Fedora-like
|<code>sudo dnf install {PACKAGE}</code>
|-
!Fedora-like (old)
|<code>sudo yum install {PACKAGE}</code>
|-
!Arch-like
|<code>sudo pacman -S {PACKAGE}</code>
|}

=== Pre-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 be managed by a non-root user]. Once finished, you may have to reboot your computer if the permissions aren't applied properly when trying to run Docker commands as a non-root user.

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 <code>docker</code> 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>:

#!/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 "$@"

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, my script retrieves my password from my password manager, <code>pass</code>, which will force authentication through a graphical dialog before retrieving the password. Technically you could just hardcode your password in the script, but this would sort of 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 ===
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.

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.

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

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

Save data is stored in <code>./SaveData</code>. 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 <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:
# Close the Flashpoint launcher.
# 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 ===

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:
# 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.
== Technologies ==

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.

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