Add a script to install Linux/*BSD dependencies for building

[Calinou]

This closes godotengine/godot-proposals#1614.

The list of commands is taken from Compiling for Linux/*BSD, but with Wayland packages added and unattended CLI arguments (such as -y) added.

For Alpine, libexecinfo-dev has been removed from the package list due to DataDog/dd-trace-php#1824. See also #91817.

godotengine/godot-docs#9357 updates the commands in the documentation to be a perfect match for the ones in this script.

Command to test on a fresh system:

# Install `curl` using the distribution's package manager, then run:
curl -LO https://github.com/Calinou/godot/archive/add-linux-dependencies-install-script.tar.gz && tar xf add-linux-dependencies-install-script.tar.gz && cd godot-add-linux-dependencies-install-script && misc/scripts/install_linuxbsd_deps.sh && scons
# (triple-click to select the whole line)

All systems listed below are fresh Docker containers.

Successfully tested on

• Alpine 3.19.1
  • Script is now written in POSIX sh to work out of the box on Alpine, which doesn't ship with Bash.
• Debian 11 (oldstable), 12 (stable), 13 (testing)
• Fedora 39, 40
• Ubuntu 20.04, 22.04, 24.04
• Arch Linux (May 2024)
• Mageia 9
• openSUSE Leap, Tumbleweed
• Solus 4.5

Not tested on

Please test on these platforms if you can!

• Gentoo
• FreeBSD
• OpenBSD
• NetBSD

[fire]

What is missing to get this approved and merged?

[Calinou]

What is missing to get this approved and merged?

This should be ready to merge, but testing on the various BSDs would be appreciated. I haven't had much luck installing any of them in VirtualBox.

If someone knows their way around Gentoo, they could also test this PR.

[kdiduk]

OpenBSD build is broken.

I've tried to build it on freshly installed OpenBSD in QEMU (in VirtualBox I couldn't install it) using the command in the description, and the build is broken. I've found 2 main problems:

1. With the default scons build command it fails because it can't find the definition of quick_exit function in the file platform/linuxbsd/x11/detect_prime_x11.cpp, although the header <stdlib.h> is included.
2. If I build with OpenGL disabled with scons opengl3=no (that way the source file above won't be included in the build), in fails with another error: it can't find the header file #include <linux/input-event-codes.h> (which is included in platform/linuxbsd/wayland/wayland_thread.cpp.

Maybe it would make sense to create a separate ticket (GitHib issue) for fixing the build in OpenBSD?

[Calinou]

Maybe it would make sense to create a separate ticket (GitHib issue) for fixing the build in OpenBSD?

Yes, I suggest creating a separate issue.

Ideally, we should have some kind of CI for BSD (Cirrus CI can do it for instance), so that the build doesn't break again in the future. The issue is that we'd have to use another CI service than GitHub Actions specifically for this, as GitHub Actions doesn't have BSD instances.

[kdiduk]

Yes, I suggest creating a separate issue.

I've created #92130 to fix the build on OpenBSD

By the way, the script itself, to install the dependencies, seems working well in OpenBSD 🙂 I tried it in OpenBSD 7.5 amd64

[fire]

Seems like there's a lot of people successfully testing this dependency installer.

There's one review comment that needs to be resolved regarding the sudo message but looks good to me.

[fire]

The issue is that we'd have to use another CI service than GitHub Actions specifically for this, as GitHub Actions doesn't have BSD instances.

I found a cursed github action for freebsd https://github.com/marketplace/actions/freebsd-vm

[akien-mga]

In general, adding such a script seems fine to me.

But the list of dependencies is actually outdated, most of the libs listed are now dlopen'd and we don't need their development packages installed to compile Godot.

From the Fedora list:

dnf install -y \
		scons \
		pkgconfig \
		libX11-devel \
		libXcursor-devel \
		libXrandr-devel \
		libXinerama-devel \
		libXi-devel \
		wayland-devel \
		mesa-libGL-devel \
		mesa-libGLU-devel \
		alsa-lib-devel \
		pulseaudio-libs-devel \
		libudev-devel \
		gcc-c++ \
		libstdc++-static \
		libatomic-static

The actual dependencies I have installed locally on Fedora 40 to compile Godot:

scons
pkgconfig
wayland-devel
gcc-c++
libstdc++-static

And if I want to use use_llvm, I would have to add:

clang
libatomic-static

So I think we should review the list and remove what's not actually needed anymore to compile Godot.

[leandro-benedet-garcia]

The command inlined above, if executed without root in Gentoo I have this output:

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100 39.4M    0 39.4M    0     0  3286k      0 --:--:--  0:00:12 --:--:-- 3047k
Detected Linux/*BSD distribution: Gentoo
Installing dependencies...
This action requires portage group access...
*** WARNING ***  For security reasons, only system administrators should be
*** WARNING ***  allowed in the portage group.  Untrusted users or processes
*** WARNING ***  can potentially exploit the portage group for attacks such as
*** WARNING ***  local privilege escalation.

Would you like to add --pretend to options? [Yes/No] y
emerge: The 'sync' action does not support '--pretend'.

You normally shouldn't put a sync in gentoo because sync command tends to take a bit, more than other distros, so I would recommend not syncinc and just outright going for the install, just make sure that the --ask parameter is included in the emerge command.

[Calinou]

just make sure that the --ask parameter is included in the emerge command.

I would prefer the script to be able to work in an unattended manner regardless of the distribution currently being used. This is important for CI use cases and the like.

This could be done by adding a -y argument to the script, but it's quite a bit of added code just to handle this for all distributions.

Ideally, package managers would stop asking for confirmation for safe operations (those that don't remove or downgrade any packages), but I'm not holding my breath for it 🙂

[leandro-benedet-garcia]

I would prefer the script to be able to work in an unattended manner regardless of the distribution currently being used. This is important for CI use cases and the like.

Oh boy, CI with gentoo? I think they would just make a ebuild based off the script instead. And a couple hundred cached things... But I can only shiver at the complexity.

I think what you could do instead, which I think would be better then, is having an argument like --package-manager-arguments="--ask".

But again, to be fair now that I can think about it, you can alias very easily in portage for the command to always have --ask included.

[fire]

In general, adding such a script is fine. @akien-mga wrote support for this, and I also think it will help new Godot Engine contributors be able to start quickly.

However, it is out of date. @Calinou, Are you interested in updating the pull request?