bijman / srb2bld

POSIX shell script that eases compiling, installing or creating AppImage/Flatpak/App Bundle/Android APKs of Sonic Robo Blast 2 related builds.

srb2bld is a shell script, that automates and simplifies process of downloading source code, configuring, compilation, installation to system or creating portable executable bundles of various SRB2 related builds.

srb2bld.mp4

Features

• Compiling and installing 32-bit/64-bit binaries of SRB2, SRB2 Uncapped Plus, SRB2 NetPlus, SRB2 rphys, SRB2 TSoURDt3rd, SRB2 VR, SRB2 v2.1 Legacy, SRB2 v2.0, SRB2 Final Demo, SRB2 JTE, SRB2 Persona, SRB2 Kart, SRB2 Kart Moe Mansion, SRB2 Kart Galaxy, SRB2 Kart HEP, SRB2 Kart Saturn, SRB2 Kart VR, wadcli, kartmaker, SLADE and Ultimate Zone Builder on Linux, macOS (tested on version 10.14/Mojave, 10.15/Catalina and 11/Big Sur) and Windows. Check "Compatibility" section or enter the script's -c/--compatibility option for information about which build compiles and run for each system and CPU architecture,
• Compiling and installing custom SRB2 builds from local or remote Git repository,
• Ability to set user's flags before compiling,
• Installing missing dependencies on host system (mostly binaries, except for SRB2 builds on macOS) based on user's set compilation flags,
• Supports installing SRB2 builds and its dependencies for glibc based Linux distros like: Debian, Ubuntu, Arch, Manjaro, Gentoo, OpenSUSE, Fedora, Void and musl based like: Void, Alpine,
• Systems with immutable root filesystems (Steam Deck's SteamOS, Fedora Silverblue/Kinoite) are supported too,
• Compiling builds on ARM CPU too (tested on ODROID XU4 with Ubuntu Linux 18.04),
• Creating customizable AppImages (Linux only), Flatpaks (Linux only) and App Bundles (macOS only) for x86/x64 and ARM CPUs,
• Building Android APKs (Linux and Windows only),
• Removing installed SRB2 builds, source code and assets,
• Upgrading installed SRB2 builds,
• Runs on Linux, macOS and Windows (Git Bash).

Dependencies

• Basic system utilities like GNU Coreutils, BusyBox or macOS out-of-the-box system utilities,
• Bash or any POSIX compliant shell,
• Findutils,
• Which,
• Curl,
• Git,
• Gawk,
• Ncurses,
• Docker or Podman (Linux and Windows only),
• GNU Stow (Linux and macOS only),
• FUSE or Libfuse2/Fuse-libs (Linux only),
• Patchelf (Linux only),
• GDK-Pixbuf (Linux only),
• Flatpak (Linux only),
• Flatpak-builder (Linux only),
• Optionally for updating icons and menu entries: gtk-update-icon-cache or kservice (can be part of GNOME or KDE desktop environment package) (Linux only). Windows users need to also have installed Git Bash or MSYS to run this script.

As for macOS users, they need to install these additional dependencies:

• Cmake,
• Autoconf,
• Automake,
• Pkg-config,
• Libtool,
• P7zip,
• Unrar/Rar,
• Makeicns.

Dependencies Installation

Linux:

1. In terminal enter this following command:

• Debian/Ubuntu/Debian based/Ubuntu based: sudo apt install make git debianutils coreutils findutils ncurses-bin curl gawk docker.io stow libfuse2 patchelf libgdk-pixbuf2.0-bin flatpak flatpak-builder,

• Arch/Arch based: sudo pacman -S --needed make git which coreutils findutils ncurses curl gawk docker stow fuse2 patchelf gdk-pixbuf2 flatpak flatpak-builder,

• Gentoo/Gentoo based: sudo emerge -av dev-vcs/git sys-apps/which sys-apps/coreutils sys-apps/findutils sys-libs/ncurses net-misc/curl sys-apps/gawk app-containers/docker app-admin/stow sys-fs/fuse:0 dev-util/patchelf x11-libs/gdk-pixbuf sys-apps/flatpak dev-util/flatpak-builder,

• Fedora/Fedora based: sudo dnf install make git which coreutils findutils ncurses curl gawk docker stow fuse-libs patchelf gdk-pixbuf2 flatpak flatpak-builder,

• Fedora Silverblue/Fedora Kinoite/Fedora Onyx/Fedora Sericea: rpm-ostree install -A --allow-inactive make git which coreutils findutils ncurses curl gawk docker stow fuse-libs patchelf gdk-pixbuf2 flatpak flatpak-builder,

• RHEL/RHEL based: sudo dnf install make git which coreutils findutils ncurses curl gawk docker stow fuse-libs patchelf gdk-pixbuf2 flatpak flatpak-builder,

• openSUSE Leap/openSUSE Tumbleweed/openSUSE Leap based/openSUSE Tumbleweed based: sudo zypper in make git which coreutils findutils ncurses curl gawk docker stow libfuse2 patchelf gdk-pixbuf-query-loaders flatpak flatpak-builder,

• openSUSE MicroOS/openSUSE MicroOS based: sudo transactional-update pkg in make git which coreutils findutils ncurses curl gawk docker stow libfuse2 patchelf gdk-pixbuf-query-loaders flatpak flatpak-builder && sudo transactional-update apply,

• Void/Void based: sudo xbps-install -S make git which coreutils findutils ncurses curl gawk docker stow fuse patchelf gdk-pixbuf flatpak flatpak-builder,

• Alpine/Alpine based: sudo apk add make git which coreutils findutils ncurses curl gawk docker stow fuse patchelf gdk-pixbuf flatpak flatpak-builder,

• Solus/Solus based: sudo eopkg it make git which coreutils findutils ncurses curl gawk docker stow fuse2 patchelf gdk-pixbuf flatpak flatpak-builder,

• NixOS/NixOS based: sudo nix profile install nixpkgs#gnumake nixpkgs#git nixpkgs#which nixpkgs#coreutils nixpkgs#findutils nixpkgs#ncurses nixpkgs#curl nixpkgs#gawk nixpkgs#stow nixpkgs#fuse nixpkgs#patchelf nixpkgs#gdk-pixbuf nixpkgs#flatpak nixpkgs#flatpak-builder --extra-experimental-features 'nix-command flakes' or set those packages in "environment.systemPackages = with pkgs;". For Docker, set "virtualisation.docker.enable = true;", so this should install and enable Docker as service running in the background of system with sudo nixos-rebuild switch. For Flatpak, set "services.flatpak.enable = true;" in "/etc/nixos/configuration.nix".

• Systems with immutable root filesystems (with exception of home directory and others depending on distro) like Steam Deck's SteamOS need rootless method of getting dependencies to avoid issues with wiping out installed packages after system's update or not to be able to write to certain path, like "/usr/local":

  1. Docker (Rootless mode): run curl -fsSL https://get.docker.com/rootless | sh to install Docker to user's home directory. For more details read HERE,
  2. Package managers:
     • Homebrew: brew install make git coreutils findutils ncurses curl gawk stow libfuse@2 patchelf gdk-pixbuf,
     • Nix Portable: nix profile install nixpkgs#gnumake nixpkgs#git nixpkgs#which nixpkgs#coreutils nixpkgs#findutils nixpkgs#ncurses nixpkgs#curl nixpkgs#gawk nixpkgs#stow nixpkgs#fuse nixpkgs#patchelf nixpkgs#gdk-pixbuf nixpkgs#flatpak nixpkgs#flatpak-builder --extra-experimental-features 'nix-command flakes'.

Windows:

1. Installing Git Bash:

• Download from HERE,
• Watch this video from 7:19 to 9:33 in HERE,

2. Git Bash can be found on start menu,

3. The rest of dependencies are installed, if you followed video,

4. Installing Docker Desktop:

• Download from HERE,
• Watch this video from 6:05 to 8:36 in HERE.

macOS:

1. In terminal enter this following command:

• Homebrew: brew install cmake autoconf automake pkgconfig libtool gawk stow p7zip rar curl makeicns,
• MacPorts: sudo port -Ncb install cmake autoconf automake pkgconfig libtool gawk stow perl5.28 libiconv p7zip unrar curl makeicns.

Installation

Linux:

1. Open terminal,

2. Enter git clone https://github.com/Bijman/srb2bld,

3. Go to downloaded directory: cd srb2bld,

4. Enter sudo make install, which will install to "/usr/local/bin". You can specify your path with variable PREFIX, for example make install PREFIX=$HOME/.local, which will copy script to "$HOME/.local/bin". Alternatively manually place script to your path, which is readable by shell (PATH environment variable), and change script's permissions to be executable: chmod 755 [path to srb2bld script],

5. Check if you set properly other settings from "Configuration" section of README.

Windows:

1. Open Git Bash,

2. Go to your user directory (usually "C:/Users/[your username]"): cd ~,

3. Enter git clone https://github.com/Bijman/srb2bld,

4. Create directory "bin" with command: mkdir ~/bin,

5. Copy script to "~/bin": cp ~/srb2bld/srb2bld ~/bin,

6. Change script's permissions to be executable: chmod 755 ~/bin/srb2bld,

7. Open text editor for "~/.bash_profile": nano ~/.bash_profile,

8. In the opened text editor from previous step write new path to executables with environment variable PATH like export PATH="~/bin:$PATH" in "~/.bash_profile",

9. Enter source ~/.bash_profile or restart Git Bash.

macOS:

1. Open terminal,

2. Enter git clone https://github.com/Bijman/srb2bld,

3. Go to downloaded directory: cd srb2bld,

4. Enter sudo make install, which will install to "/usr/local/bin". You can specify your path with variable PREFIX, for example make install PREFIX=$HOME/.local, which will copy script to "$HOME/.local/bin". Alternatively manually place script to your path, which is readable by shell (PATH environment variable), and change script's permissions to be executable: chmod 755 [path to srb2bld script],

5. Check if you set properly other settings from "Configuration" section of README.

Configuration

Linux (Notice: This part can be skipped, if you have installed podman.):

1. Add user to the "docker" group sudo usermod -aG docker [username] and enable Docker service with sudo systemctl enable docker or sudo rc-update add docker default or sudo ln -s /etc/sv/docker /var/service/, and then start the service with sudo systemctl start docker or sudo rc-service docker start or sudo sv up docker. For immutable systems (Steam Deck's SteamOS, Fedora Silverblue/Kinoite) enter: systemctl --user enable docker and systemctl --user start docker. After that, logout or reboot the system.

Windows:

1. User is already added to "docker" group and service will run, if Docker Desktop is installed and the system is logged out or rebooted.

macOS:

1. Set SDKROOT environment variable in "~/.zshrc" or "~/.bash_profile": export SDKROOT=[path to .sdk file] (usually macOS .sdk file is located in "/Library/Developer/CommandLineTools/SDKs" path, if you installed Homebrew or entered sudo xcode-select --install),
2. Enter source ~/.bash_profile or source ~/.zshrc or restart terminal.

Compatibility (as of 12-02-2024)

	Linux (glibc) x86/x64	Linux (musl) x86/x64	Linux (glibc) ARM	Windows x86/x64	macOS x86/x64
SRB2	✅	✅	✅	✅	✅
SRB2 Uncapped PLUS	✅	✅	✅	✅	🟨**
SRB2 NetPlus	✅	✅	✅	✅	⛔
SRB2 rphys	✅	✅	✅	✅	✅
SRB2 TSoURDt3rd	✅	✅	🟨	✅	⛔
SRB2 VR	✅	✅	✅	✅*	⛔
SRB2 v2.1 Legacy	✅	✅	✅	✅	✅
SRB2 v2.0	✅	✅	✅	✅*	⛔
SRB2 Final Demo	✅*	✅*	✅*	✅*	⛔
SRB2 JTE (1.09)	🟨*	🟨*	🟨*	⛔	⛔
SRB2 Persona	✅	✅	✅	✅	✅
SRB2 Kart	✅	✅	✅	✅	🟨***
SRB2 Kart Moe Mansion	✅	✅	✅	✅	⛔
SRB2 Kart Galaxy	✅	✅	🟨	✅	⛔
SRB2 Kart HEP	✅	✅	🟨	✅	⛔
SRB2 Kart Saturn	✅	✅	✅	✅	⛔
SRB2 Kart VR	✅	✅	✅	✅*	⛔
wadcli	✅	✅	✅	⛔	⛔
kartmaker	✅	✅	✅	✅	✅
SLADE	✅	✅	⛔	⛔	✅
Ultimate Zone Builder	✅	✅	⛔	✅	⛔

Legend:

✅ - Builds and runs successfully.

🟨 - Builds successfully, but may encounter errors, when starting game, or get performance issues. Patches may apply.

⛔ - Building failure.

❔ - Not tested.

*Only 32-bit binaries are currently supported. SRB2 v2.0 has graphical issues when running with OpenGL on Linux and Windows.

**Compiles successfully with patch for commit d4d1181ec6f without setting -DSRB2_CONFIG_HAVE_DISCORDRPC=ON compilation flag, but there may be some slowdowns, when running game.

***Compiles successfully, but it can throw SIGABRT error on some macOS versions. Compiled build runs fine on macOS 10.14/Mojave.

Usage (from help text)

Build and install SRB2/SRB2Kart from source.

Usage: srb2bld [OPTIONS]
  OPTIONS:
     -h, --help                             Show this help text.
     -ab, --appbundle                       Compile and create distributable App Bundle of SRB2/SRB2Kart build, which is packaged in DMG file (macOS only).
     -ad, --android                         Compile and create distributable APK file of SRB2 build (Linux and Windows only).
     -ai, --appimage                        Compile and create distributable AppImage of SRB2/SRB2Kart build (Linux only).
     -c, --compatibility                    Display compatibility table of compiling SRB2/SRB2Kart builds for each operating system.
     -f, --flatpak                          Compile and create distributable Flatpak of SRB2/SRB2Kart build (Linux only).
     -i, --install                          Compile and install SRB2/SRB2Kart build to system.
     -la, --listasset                       List downloaded SRB2/SRB2Kart assets.
     -lb, --listbuild                       List downloaded SRB2/SRB2Kart builds.
     -lc, --listconfig                      List compilation flags of installed SRB2/SRB2Kart builds.
     -ld, --listdep                         List compiled and installed dependencies for builds.
     -li, --listinstalled                   List installed SRB2/SRB2Kart builds.
     -ra, --removeasset                     Remove downloaded asset for SRB2/SRB2Kart build.
     -rb, --removebuild                     Remove downloaded source code for SRB2/SRB2Kart build.
     -rd, --removedep                       Remove compiled and installed dependencies for builds.
     -t, --tag                              Compile and install build with chosen tag instead of branch (only works with -i/--install, -ab/--appbundle, -ai/--appimage, -f/--flatpak).
     -u, --user                             Set installation path to user's home directory (only works with -i/--install, -ui/--uninstall, -rd/--removedep).
     -ui, --uninstall                       Uninstall SRB2/SRB2Kart build.
     -up, --upgrade                         Upgrade installed SRB2/SRB2Kart build.

  EXAMPLES:
     1. Compile and install SRB2/SRB2Kart build to system:
            srb2bld --install

     2. Compile and install SRB2/SRB2Kart build to user's home directory:
            srb2bld --install --user

     3. Compile and install SRB2/SRB2Kart build to system with chosen tag:
            srb2bld --install --tag

     4. Compile and create AppImage of SRB2/SRB2Kart build (Linux only):
            srb2bld --appimage

     5. List installed SRB2/SRB2Kart builds:
            srb2bld --listinstalled

     6. Uninstall SRB2/SRB2Kart build:
            srb2bld --uninstall

     7. Display compatibility table of compiling SRB2/SRB2Kart builds for each operating system:
            srb2bld --compatibility

  NOTES:
     1. Old builds like SRB2 v2.0, SRB2 Final Demo, SRB2 JTE may not build/run properly on modern Linux distributions/macOS/Windows.

     2. WARNING for macOS users! This script makes changes from rpath to absolute paths within some libraries installed from Homebrew, MacPorts or compiled (mostly should affects libraries compiled by user), that are associated with SRB2 binary, so installing or making App Bundles would be successful. In the future this could make unexpected results with apps or SRB2 builds, that depend on those libraries.

     3. If you want to compile some builds with DiscordRPC support (SRB2 Uncapped Plus, SRB2 NetPlus, SRB2 Kart, SRB2 Kart Moe Mansion and SRB2 Kart VR), then type "HAVE_DISCORDRPC=1" (Linux/Windows) or "-DSRB2_CONFIG_HAVE_DISCORDRPC=ON" (macOS), when the script asks about optional compilation flags (using "srb2bld --install" command).

     4. If on Linux you get error with "/dev/fuse" or FUSE when running script, then load fuse module with "sudo modprobe fuse". You can write "fuse" in configuration file, usually in file "/etc/modules" or "/etc/modules-load.d/fuse.conf" or "/etc/conf.d/modules/fuse.conf", to automatically load this module at boot.

     5. If 64-bit Linux system has issues with creating or loading "Sonic Robo Blast 2 Final Demo" (AppImage or installed), make sure you have installed 32-bit versions of FUSE and glibc:

         - Debian/Ubuntu/Debian based/Ubuntu based: "sudo dpkg --add-architecture i386 && sudo apt update && sudo apt install fuse:i386 libc6:i386 zlib1g:i386",

         - Arch/Arch based: uncomment the [multilib] section in /etc/pacman.conf and do "sudo pacman -Syu --needed" and then use one of the AUR helpers that you have installed - "pikaur -S --needed lib32-fuse2 lib32-glibc" or "paru -S --needed lib32-fuse2 lib32-glibc" or "yay -S --needed lib32-fuse2 lib32-glibc",

         - Gentoo/Gentoo based: "ABI_X86=32 sudo -E emerge -av sys-fs/fuse sys-libs/glibc",

         - Fedora/Fedora based: "sudo dnf install fuse-libs.i686 glibc.i686" for Fedora Workstation/Server or "rpm-ostree install -A --allow-inactive fuse-libs.i686 glibc.i686" for Fedora Silverblue/Kinoite,

         - OpenSUSE/OpenSUSE based: "sudo zypper in libfuse2-32bit glibc-32bit",

         - Void: "sudo xbps-install -S void-repo-multilib && sudo xbps-install -Su && sudo xbps-install -S fuse-32bit glibc-32bit".

     6. If Linux system has issue with running build because of not found compiled libraries, even though they are installed, set: export LD_LIBRARY_PATH="/usr/local/lib:$LD_LIBRARY_PATH" in "~/.bash_profile" or "~/.zshrc".

     7. There are couple of patches applied within source code of games. Their purpose is to prevent conflicts of installing/running of multiple builds overlapping each other with the same names of directories for storing assets and configuration/saves. Other patches include fixing compilation for some builds on particular systems.

     8. If you choose branch other than default, configuration directory's name will be changed, for example ".srb2" will become ".srb2udmf", if "udmf" was chosen. Still remember to make backup of configuration/save files, before upgrading to next release of SRB2/SRB2Kart build, if you chose default branch or kept previously chosen different branch.

     9. If you have error "invalid file system type on '/sys/fs/cgroup'", while running script, issue could be with not running cgroups service "sudo systemctl enable cgconfig && sudo systemctl start cgconfig" or "sudo systemctl enable cgmanager && sudo systemctl start cgmanager" or "sudo rc-update add cgroups && sudo rc-service cgroups start" and reboot system.

     10. If you receive permission issues or errors related to /etc/subuid, /etc/subgid, UID and GID, please check if you have set UIDs/GIDs for user in path /etc/subuid and /etc/subgid. For example "testuser:231072:65536" will assign 65,536 subordinate UIDs/GIDs (231072-296607) to user called "testuser", so configure to user you are logged to. If you still have permission errors, increase range for user you are logged to in files /etc/subuid and /etc/subgid, for example "testuser:231072:200000". Additionally, if you have podman installed, enter "podman system migrate".

     11. If you get "unhandled exception" when running Ultimate Zone Builder, uninstall mono in your system.

     12. Building Android APKs require gradlew script in the path "[SRB2 build path]/android".

     13. For built Flatpak bundles for 32-bit builds (SRB2 Final Demo, SRB2 JTE), you need to install Flatpak "org.freedesktop.Platform.Compat.i386" with command "flatpak --user install org.freedesktop.Platform.Compat.i386".

     14. In order to compile and install custom SRB2/SRB2Kart build (assuming it is not a very old one) from local or remote repository, write environment variables in shell's configuration file, like ".bash_profile" or ".zshrc", which are:

          - SRB2BLDGITPATH - path to local or remote repository,

          - SRB2BLDGITVER - chosen branch to download build from remote repository,

          - SRB2BLDASSETPATH - path to assets from local or remote path (supported links/paths:
               - websites with direct link to file, for example, "https://github.com/STJr/SRB2/releases/download/SRB2_release_2.2.10/SRB2-v2210-Full.zip",
               - mega.nz,
               - drive.google.com,
               - dropbox.com,
               - full path to downloaded archived file in formats supported by p7zip (https://www.7-zip.org) or full path to directory with build's assets, for example $HOME/Downloads/SRB2.zip for Linux and macOS or C:\Downloads\SRB2.zip for Windows.)

          - SRB2BLDEXTRAASSETPATH - path to extra assets from local or remote path, in case build requires it. The same supported links/paths applies as SRB2BLDASSETPATH.

          EXAMPLES:
               1. export SRB2BLDGITPATH="https://github.com/STJr/SRB2"

               2. export SRB2BLDGITPATH="https://git.do.srb2.org/TehRealSalt/SRB2"

               3. export SRB2BLDGITPATH="$HOME/Builds/SRB2"

               4. export SRB2BLDGITPATH="C:\Builds\SRB2"

               5. export SRB2BLDGITVER="udmf"

               6. export SRB2BLDGITVER="master"

               7. export SRB2BLDASSETPATH="https://github.com/STJr/SRB2/releases/download/SRB2_release_2.2.10/SRB2-v2210-Full.zip"

               8. export SRB2BLDASSETPATH="https://mega.nz/file/JQswBDAA#IPXWeTmrXrI9YZx6zUznJQ2uIAHryv_WP1JxWfnKbts"

               9. export SRB2BLDASSETPATH="https://drive.google.com/file/d/1Vc-lHph8MxlnfaBZnv0NNpoFKhehmce6"

               10. export SRB2BLDASSETPATH="https://www.dropbox.com/s/5neoderzan6mbh3/SRB2PERSONA%20v1.3.3%20Full%20Installer.exe"

               11. export SRB2BLDASSETPATH="$HOME/Downloads/SRB2-Full.zip"

               12. export SRB2BLDASSETPATH="C:\Downloads\SRB2-Full.zip"

               13. export SRB2BLDASSETPATH="$HOME/Downloads/SRB2-Full"

               14. export SRB2BLDASSETPATH="C:\Downloads\SRB2-Full"

          Then choose "Build SRB2 Custom", when running script.

     15. Other environment variables to use. To activate them with value "1", do for example "export SRB2BLDDEBUG=1":

         - SRB2BLDDEBUG - Getting verbose output from script. Useful for reporting issues in https://github.com/bijman/srb2bld/issues.

         - SRB2BLDDEVMODE - For developers, who want to modify build's source code. Disables cleaning build and resetting changes to build's source code.

         - SRB2BLDNOCCACHE - Disable ccache.

         - SRB2BLDNOGRADLECACHE - Disable gradle cache, when building Android APK.

         - GITHUB_TOKEN - Increase hourly limit of request to GitHub API. Useful, if connecting to SRB2/SRB2Kart assets and downloading is blocked after many attempts. Current default number of requests without GitHub personal access token is 60 requests per hour and with GitHub personal access token - 5000 requests per hour. For more details and how to, please read https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api and https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens. You need GitHub account to do this.

Notes

1. Old builds like SRB2 v2.0, SRB2 Final Demo, SRB2 JTE may not build/run properly on modern Linux distributions/macOS/Windows.

2. WARNING for macOS users! This script makes changes from rpath to absolute paths within some libraries installed from Homebrew, MacPorts or compiled (mostly should affects libraries compiled by user), that are associated with SRB2 binary, so installing or making App Bundles would be successful. In the future this could make unexpected results with apps or SRB2 builds, that depend on those libraries.

3. If you want to compile some builds with DiscordRPC support (SRB2 Uncapped Plus, SRB2 NetPlus, SRB2 Kart, SRB2 Kart Moe Mansion and SRB2 Kart VR), then type "HAVE_DISCORDRPC=1" (Linux/Windows) or "-DSRB2_CONFIG_HAVE_DISCORDRPC=ON" (macOS), when the script asks about optional compilation flags (using "srb2bld --install" command).

4. If on Linux you get error with "/dev/fuse" or FUSE when running script, then load fuse module with sudo modprobe fuse. You can write "fuse" in configuration file, usually in file "/etc/modules" or "/etc/modules-load.d/fuse.conf" or "/etc/conf.d/modules/fuse.conf", to automatically load this module at boot.

5. If 64-bit Linux system has issues with creating or loading "Sonic Robo Blast 2 Final Demo" (AppImage or installed), make sure you have installed 32-bit versions of FUSE and glibc:

     - Debian/Ubuntu/Debian based/Ubuntu based: `sudo dpkg --add-architecture i386 && sudo apt update && sudo apt install fuse:i386 libc6:i386 zlib1g:i386`,
   
     - Arch/Arch based: uncomment the [multilib] section in /etc/pacman.conf and do `sudo pacman -Syu --needed` and then use one of the AUR helpers that you have installed - `pikaur -S --needed lib32-fuse2 lib32-glibc` or `paru -S --needed lib32-fuse2 lib32-glibc` or `yay -S --needed lib32-fuse2 lib32-glibc`,
   
     - Gentoo/Gentoo based: `ABI_X86=32 sudo -E emerge -av sys-fs/fuse sys-libs/glibc`,
   
     - Fedora/Fedora based: `sudo dnf install fuse-libs.i686 glibc.i686` for Fedora Workstation/Server or `rpm-ostree install -A --allow-inactive fuse-libs.i686 glibc.i686` for Fedora Silverblue/Kinoite,
   
     - OpenSUSE/OpenSUSE based: `sudo zypper in libfuse2-32bit glibc-32bit`,
   
     - Void: `sudo xbps-install -S void-repo-multilib && sudo xbps-install -Su && sudo xbps-install -S fuse-32bit glibc-32bit`.
   

6. If Linux system has issue with running build because of not found compiled libraries, even though they are installed, set export LD_LIBRARY_PATH="/usr/local/lib:$LD_LIBRARY_PATH" in "~/.bash_profile" or "~/.zshrc".

7. There are couple of patches applied within source code of games. Their purpose is to prevent conflicts of installing/running of multiple builds overlapping each other with the same names of directories for storing assets and configuration/saves. Other patches include fixing compilation for some builds on particular systems.

8. If you choose branch other than default, configuration directory's name will be changed, for example ".srb2" will become ".srb2udmf", if "udmf" was chosen. Still remember to make backup of configuration/save files, before upgrading to next release of SRB2/SRB2Kart build, if you chose default branch or kept previously chosen different branch.

9. If you have error "invalid file system type on '/sys/fs/cgroup'", while running script, issue could be with not running cgroups service "sudo systemctl enable cgconfig && sudo systemctl start cgconfig" or "sudo systemctl enable cgmanager && sudo systemctl start cgmanager" or "sudo rc-update add cgroups && sudo rc-service cgroups start" and reboot system.

10. If you receive permission issues or errors related to /etc/subuid, /etc/subgid, UID and GID, please check if you have set UIDs/GIDs for user in path /etc/subuid and /etc/subgid. For example "testuser:231072:65536" will assign 65,536 subordinate UIDs/GIDs (231072-296607) to user called "testuser", so configure to user you are logged to. If you still have permission errors, increase range for user you are logged to in files /etc/subuid and /etc/subgid, for example "testuser:231072:200000". Additionally, if you have podman installed, enter "podman system migrate".

11. If you get "unhandled exception" when running Ultimate Zone Builder, uninstall mono in your system.

12. Building Android APKs require gradlew script in the path "[SRB2 build path]/android".

13. For built Flatpak bundles for 32-bit builds (SRB2 Final Demo, SRB2 JTE), you need to install Flatpak "org.freedesktop.Platform.Compat.i386" with command "flatpak --user install org.freedesktop.Platform.Compat.i386".

14. In order to compile and install custom SRB2/SRB2Kart build (assuming it is not a very old one) from local or remote repository, write environment variables in shell's configuration file, like ".bash_profile" or ".zshrc", which are:

    • SRB2BLDGITPATH - path to local or remote repository,

    • SRB2BLDGITVER - chosen branch to download build from remote repository,

    • SRB2BLDASSETPATH - path to assets from local or remote path (supported links/paths:

      • websites with direct link to file, for example, "https://github.com/STJr/SRB2/releases/download/SRB2_release_2.2.10/SRB2-v2210-Full.zip",
      • mega.nz,
      • drive.google.com,
      • dropbox.com,
      • full path to downloaded archived file in formats supported by p7zip (https://www.7-zip.org) or full path to directory with build's assets, for example $HOME/Downloads/SRB2.zip for Linux and macOS or C:\Downloads\SRB2.zip for Windows.)

    • SRB2BLDEXTRAASSETPATH - path to extra assets from local or remote path, in case build requires it. The same supported links/paths applies as SRB2BLDASSETPATH.

    EXAMPLES:
        1. export SRB2BLDGITPATH="https://github.com/STJr/SRB2"

        2. export SRB2BLDGITPATH="https://git.do.srb2.org/TehRealSalt/SRB2"

        3. export SRB2BLDGITPATH="$HOME/Builds/SRB2"

        4. export SRB2BLDGITPATH="C:\Builds\SRB2"

        5. export SRB2BLDGITVER="udmf"

        6. export SRB2BLDGITVER="master"

        7. export SRB2BLDASSETPATH="https://github.com/STJr/SRB2/releases/download/SRB2_release_2.2.10/SRB2-v2210-Full.zip"

        8. export SRB2BLDASSETPATH="https://mega.nz/file/JQswBDAA#IPXWeTmrXrI9YZx6zUznJQ2uIAHryv_WP1JxWfnKbts"

        9. export SRB2BLDASSETPATH="https://drive.google.com/file/d/1Vc-lHph8MxlnfaBZnv0NNpoFKhehmce6"

        10. export SRB2BLDASSETPATH="https://www.dropbox.com/s/5neoderzan6mbh3/SRB2PERSONA%20v1.3.3%20Full%20Installer.exe"

        11. export SRB2BLDASSETPATH="$HOME/Downloads/SRB2-Full.zip"

        12. export SRB2BLDASSETPATH="C:\Downloads\SRB2-Full.zip"

        13. export SRB2BLDASSETPATH="$HOME/Downloads/SRB2-Full"

        14. export SRB2BLDASSETPATH="C:\Downloads\SRB2-Full"

Then choose "Build SRB2 Custom", when running script.

15. Other environment variables to use. To activate them with value "1", do for example "export SRB2BLDDEBUG=1":

    - SRB2BLDDEBUG - Getting verbose output from script. Useful for reporting issues in https://github.com/bijman/srb2bld/issues.
    
    - SRB2BLDDEVMODE - For developers, who want to modify build's source code. Disables cleaning build and resetting changes to build's source code.
    
    - SRB2BLDNOCCACHE - Disable ccache.
    
    - SRB2BLDNOGRADLECACHE - Disable gradle cache, when building Android APK.
    
    - GITHUB_TOKEN - Increase hourly limit of request to GitHub API. Useful, if connecting to SRB2/SRB2Kart assets and downloading is blocked after many attempts. Current default number of requests without GitHub personal access token is 60 requests per hour and with GitHub personal access token - 5000 requests per hour. For more details and how to, please read https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api and https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens. You need GitHub account to do this.
    

srb2bld's Issues

[SDL_Mixer_X] binary unable to locate library

built Uncapped Plus with Discord RPC and Mixer X
I get this error when trying to launch:

srb2ucp: error while loading shared libraries: libSDL2_mixer_ext.so.2: cannot open shared object file: No such file or directory

[enhancement/refactor] switch from docker to podman

podman doesn't have a daemon and is rootless

[Nix] switch from nix-env

To nix profile install as nix-env is now deprecated

SRB2 rphys uses .srb2 rather than its own folder

v2.1.12 pre-3 doesn't compile, for some reason (using the new docker build)

I'm wholly unsure why this doesn't compile, since it compiles just fine on opensuse, and someone else's machine (not with srb2bld), using the docker found in the commit 6c34f02

Here's a crash log:
crash-log.txt
And maybe some relevant compiler errors:
message.txt

Custom builds change folder after updating

Example, using Spectrum's uncapped remake, it uses the folder .srb2customuncapped-remake but after updating the build using srb2bld -up a new folder is created .srb2custom

[Suggestion] Multiple custom builds

the name of the binary for custom builds is static, which makes it harder if not impossible to have multiple builds

[Suggestion] Flatpak build option for Linux

This is both a question and a feature request. Is it possible to add a build option to create a Flatpak?

Error installing dependencies on nixos-unstable

Installing missing dependencies for Sonic Robo Blast 2 Custom srb2ucpr to the system. Please wait...
installing 'nix-index-unstable-2022-03-07'
this derivation will be built:
  /nix/store/2x8m03b23kw9cxmi209xy89v6js0r45s-nix-index-unstable-2022-03-07.drv
this path will be fetched (2.37 MiB download, 11.20 MiB unpacked):
  /nix/store/ir90192wdrk5da5p880cxxz8kd06f8lq-nix-index-unstable-2022-03-07
copying path '/nix/store/ir90192wdrk5da5p880cxxz8kd06f8lq-nix-index-unstable-2022-03-07' from 'https://cache.nixos.org'...
building '/nix/store/2x8m03b23kw9cxmi209xy89v6js0r45s-nix-index-unstable-2022-03-07.drv'...
error: this derivation has bad 'meta.outputsToInstall'

[Enhancement] Option to build with SDL_Mixer_X

[Enhancement] Alternative installation locations

e.g. $HOME/.local/bin or $HOME/bin
As NixOS doesn't have /usr

[far fetched feature suggestion] Nix flake support

Being able to add builds as a flake

[Enhancement] Support for MSYS environment and MSYS2 program

srb2bld does not recognize "msys" as valid environment in MSYS2, since only MINGW from Git Bash is supported.
This screenshot, which was uploaded by user, illustrates that:

Error on line 895 - "arch: command not found"

Preparing directories to store Sonic Robo Blast 2's source code, assets and libraries. Please wait...
/usr/local/bin/srb2bld: line 895: arch: command not found
/usr/local/bin/srb2bld: line 895: arch: command not found
/usr/local/bin/srb2bld: line 895: arch: command not found

2.2.12 won't be supported due to outdated SDL2 version, lacking "SDL_OpenURL"

Linking lsdl2srb2.debug...
../make/linux/64/SDL/objs/sdl/i_system.o: In function `I_ReportSignal':
/home/zesi/.local/share/srb2bld/builds/srb2/src/sdl/i_system.c:411: undefined reference to `SDL_OpenURL'
collect2: error: ld returned 1 exit status
Makefile:325: recipe for target '../bin/lsdl2srb2.debug' failed
make: *** [../bin/lsdl2srb2.debug] Error 1
make: Target 'all' not remade because of errors.
make: Leaving directory '/home/zesi/.local/share/srb2bld/builds/srb2/src'

This is an issue that occurs when trying to compile SRB2 2.2.12, that happens due to the SDL2 version in this being outdated, and not supporting SDL_OpenURL. If I remove the offending line, then SRB2 successfully compiles despite this. Had to resort to doing this to upload a compatible appimage to the SRB2 discord, since I'm unfamiliar with how docker works.

For clarity, I'm using the "2212-pre1" branch to compile this, you'll encounter the same issue if you try this branch.

[Custom Builds] .desktop files are both software mode

[kart] update assets for 1.5

"x86_64-w64-mingw32-gcc-10-win32: No such file or directory" when compiling on Windows

          https://github.com/Bijman/srb2bld/assets/146545399/56568f7a-bfad-4fb4-8474-2445fb59976a

its not fixed (somehow)

Originally posted by @LegoLuigiJumpscare in #24 (comment)

[Enhancement] Add Dr. Robotnik’s Ring Racers to build targets

With the announcement and release as of 24.04.2024 of next generation of SRB2 Kart - Ring Racers - and how much this game differentiate from original SRB2 Kart v1.0, this game will be included to build targets in the next update of srb2bld.

[SDL_Mixer-X] use custom libgme

include a custom libgme that uses MAME rather than Nuked-OPN2 when building with Mixer X

Installing HEP on Almalinux loops a DNF error message

This happens post compilation while trying to install HEP on Almalinux 9

Refreshing package database for Sonic Robo Blast 2 Kart HEP to find packages matching missing library. Please wait...

Installing missing dependencies for Sonic Robo Blast 2 Kart HEP to the system. Please wait...
Error: No matches found. If searching for a file, try specifying the full path or using a wildcard prefix ("*/") at the beginning.
Error: No matches found. If searching for a file, try specifying the full path or using a wildcard prefix ("*/") at the beginning.
usage: dnf install [-c [config file]] [-q] [-v] [--version] [--installroot [path]] [--nodocs] [--noplugins]
                   [--enableplugin [plugin]] [--disableplugin [plugin]] [--releasever RELEASEVER] [--setopt SETOPTS]
                   [--skip-broken] [-h] [--allowerasing] [-b | --nobest] [-C] [-R [minutes]] [-d [debug level]]
                   [--debugsolver] [--showduplicates] [-e ERRORLEVEL] [--obsoletes]
                   [--rpmverbosity [debug level name]] [-y] [--assumeno] [--enablerepo [repo]] [--disablerepo [repo] |
                   --repo [repo]] [--enable | --disable] [-x [package]] [--disableexcludes [repo]]
                   [--repofrompath [repo,path]] [--noautoremove] [--nogpgcheck] [--color COLOR] [--refresh] [-4] [-6]
                   [--destdir DESTDIR] [--downloadonly] [--comment COMMENT] [--bugfix] [--enhancement] [--newpackage]
                   [--security] [--advisory ADVISORY] [--bz BUGZILLA] [--cve CVES]
                   [--sec-severity {Critical,Important,Moderate,Low}] [--forcearch ARCH]
                   PACKAGE [PACKAGE ...]
dnf install: error: the following arguments are required: PACKAGE

Refreshing package database for Sonic Robo Blast 2 Kart HEP to find packages matching missing library. Please wait...

Installing missing dependencies for Sonic Robo Blast 2 Kart HEP to the system. Please wait...
Error: No matches found. If searching for a file, try specifying the full path or using a wildcard prefix ("*/") at the beginning.
Error: No matches found. If searching for a file, try specifying the full path or using a wildcard prefix ("*/") at the beginning.
usage: dnf install [-c [config file]] [-q] [-v] [--version] [--installroot [path]] [--nodocs] [--noplugins]
                   [--enableplugin [plugin]] [--disableplugin [plugin]] [--releasever RELEASEVER] [--setopt SETOPTS]
                   [--skip-broken] [-h] [--allowerasing] [-b | --nobest] [-C] [-R [minutes]] [-d [debug level]]
                   [--debugsolver] [--showduplicates] [-e ERRORLEVEL] [--obsoletes]
                   [--rpmverbosity [debug level name]] [-y] [--assumeno] [--enablerepo [repo]] [--disablerepo [repo] |
                   --repo [repo]] [--enable | --disable] [-x [package]] [--disableexcludes [repo]]
                   [--repofrompath [repo,path]] [--noautoremove] [--nogpgcheck] [--color COLOR] [--refresh] [-4] [-6]
                   [--destdir DESTDIR] [--downloadonly] [--comment COMMENT] [--bugfix] [--enhancement] [--newpackage]
                   [--security] [--advisory ADVISORY] [--bz BUGZILLA] [--cve CVES]
                   [--sec-severity {Critical,Important,Moderate,Low}] [--forcearch ARCH]
                   PACKAGE [PACKAGE ...]
dnf install: error: the following arguments are required: PACKAGE

[...]

Local Asset Path isn't actually supported when making AppImages

While trying to compile srb2 2212 pre2 (still isn't working, had to remove that sdl_openurl line) I tried to point the asset file to a local one, since the prompt for it claims it supports it:

Please enter Sonic Robo Blast 2's assets path, or just press enter to download and extract the latest SRB2/SRB2Kart stable release assets. Supported links/paths:

        ...

        - full path to downloaded archived file in formats supported by p7zip (https://www.7-zip.org) or full path to directory with build's assets, for example /home/zesi/Downloads/SRB2.zip for Linux and macOS or C:\Downloads\SRB2.zip for Windows.

When I try to do just that, i.e. point to /home/zesi/Downloads/srb2win_v2212-pre2.zip, it straight up doesn't work, and produces an AppImage without those assets bundled in. However when I supply, say, a Google Drive link, that works fine. Not sure what's up with that, but, it's definitely a bug.

[Suggestion] Adding SRB2Kart-Galaxy as a Build Target

https://mb.srb2.org/addons/srb2kart-galaxy.4500/
https://git.do.srb2.org/Galactice/Kart-Public/-/tree/Galaxy-Redux

Issue building SLADE - connection error with ppa.launchpad.net in Docker container

https://asciinema.org/a/D2WWzdBaOfyikHTubQEnAovOv

[Security Vulnerability] docker group is root equivalent

See moby/moby#9976