Support more architectures, remove dependencies on devkitARM/make in favor of LLVM/ninja (#558)

Author: jonko0493

.github/workflows/official-build.yml

@@ -17,6 +17,8 @@ jobs:
     steps:
       - name: Check out Serial Loops
         uses: actions/checkout@v4
+        with:
+          submodules: true
       - name: Setup .NET
         uses: actions/setup-dotnet@v4.1.0
         with:

.github/workflows/pr.yml

@@ -0,0 +1,3 @@
+[submodule "submodules/NitroPacker.SymTableHelper"]
+	path = submodules/NitroPacker.SymTableHelper
+	url = https://github.com/haroohie-club/NitroPacker.SymTableHelper.git

.gitmodules

@@ -48,56 +48,22 @@ Documentation for how to use Serial Loops can be found on [our website](https://
 ### Prerequisites
 It is recommended that you use a distribution of Serial Loops that automatically installs or comes with the necessary prerequisites. For each platform these are:
 
-* Linux: Flatpak
+* Linux: [Flatpak from Flathub](https://flathub.org/apps/club.haroohie.SerialLoops)
+  - The AppImage, deb, and rpm packages are also easy to use, but if you're not sure which to choose, go with the Flatpak
 * macOS: Installer
 * Windows: Installer
 
-Using these will ensure Serial Loops is ready to use after installation. However, if you would rather use a portable build on Windows/Linux, please check the information on installing
-these prerequisites below.
+Using these will ensure Serial Loops is ready to use after installation. However, if you would rather use a portable build on Windows/Linux, please check the information on installing these prerequisites in the next section.
 
-<details>
-    <summary>View prerequisites for non-Flatpak/installer distributions</summary>
+#### Dependencies for Non-Packages Releases
+If you opt to use one of the non-packaged releases on Windows or Linux, you will need to install a few dependencies. These are:
 
-#### Installing devkitARM
-[devkitARM](https://devkitpro.org/wiki/Getting_Started) is required to use Serial Loops on all platforms.
-
-* Using the Windows graphical installer, you can simply select the devkitARM (Nintendo DS) workloads
-* On macOS and Linux, run `sudo dkp-pacman -S nds-dev` from the terminal after installing the devkitPro pacman distribution.
-
-#### Installing Make or Docker
-To assemble ASM hacks you want to apply, you will need to decide whether to use Make or Docker. Make is automatically installed when using the Debian and RPM
-packages we distribute, so you don't need to worry about this step if you're using either of those.
-
-Currently, the Docker path is **only supported on Windows** due to operating system and framework limitations. It is possible to get Docker running
-just fine on Linux distros by running SerialLoops as root (e.g. `sudo SerialLoops`), but it's easier to just use Make. On macOS, there is no known
-way of getting the Docker path to work, so you will have to use Make.
-
-* [Make](https://www.gnu.org/software/make/) is the software used to assemble assembly hacks. Installing Make allows you to build the hacks
-  directly on your system.
-    - To install on Windows, you will have to use a terminal and a package manager. Your options are Winget (installed by default on Win10+) or
-      [Chocolatey](https://chocolatey.org/). Open an admin PowerShell or Terminal window (Winkey + X + A) and enter `winget install GnuWin32.make`
-      for Winget or `choco install make` for Chocolatey. If using Winget, you will then have to go into system preferences and add Make to the path.
-    - Installation on macOS can be done through Xcode or Homebrew. If using Xcode, open a terminal and type `xcode-select --install`. If you would
-      rather use Homebrew, open a terminal after installing Homebrew and type `brew install make`.
-    - Make comes preinstalled on many Linux distributions, and if you're using the Debian or RPM package, it was definitely installed when you installed
-      Serial Loops. If you're using the tar.gz it is not installed on yours, you will likely be able to install it as simply as
-      `[packagemanger] install make` from a terminal.
-
-  To test if make is installed properly, type `make --verison` into a terminal and see if it produces the version of make.
-* If you would rather not install Make, or if it is not working properly, you can instead run it through a Docker container. To do this, you should
-  install [Docker Desktop](https://www.docker.com/products/docker-desktop/) or the Docker Engine. Ensure the Docker engine is running and make sure
-  to check the "Use Docker for ASM Hacks" option in Preferences. You may want to occasionally clean up containers created by Serial Loops, as it will
-  create many of them.
-    - On Windows, you will additionally need to install [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install).
-      From an admin PowerShell or Terminal window (Winkey + X + A), simply type `wsl --install` to install it.
-
-#### Installing SDL2 (Linux)
-If you're running on Linux and _not using one of the package releases_ (the Flatpak, AppImage, `.deb` or `.rpm`), you will also need to install SDL2 which is used for audio processing.
-
-</details>
+* Clang and LLD from [LLVM](http://llvm.org) (on Windows, it's best to just use the LLVM installer as it will install both of these; on Linux, you can opt to install just the `clang`, `lld`, and possibly `llvm` packages from your package manager)
+* [Ninja](https://ninja-build.org)
+* On Linux, you will also need SDL2
 
 #### A Nintendo DS Emulator
-To test the game easily, you will want to have a Nintendo DS emulator installed. We recommend using [melonDS](https://melonds.kuribo64.net/) for its accuracy.
+To test the game easily, you will want to have a Nintendo DS emulator installed. We recommend using [melonDS](https://melonds.kuribo64.net/) for its accuracy. If you are using the Flatpak release, melonDS comes pre-packaged with it.
 
 ### Download & Install
 Once you have installed any necessary prerequisites, to install Serial Loops, download the latest release for your platform from the [Releases tab](https://github.com/haroohie-club/SerialLoops/releases).
@@ -108,17 +74,16 @@ Be sure to [read the Serial Loops documentation](https://haroohie.club/chokurets
 Uninstalling Serial Loops itself is quite simple; however, you may also want to uninstall the packaged dependencies. Follow the instructions below for each platform to do this.
 
 #### Linux
-* If you installed the Flatpak, simply run `flatpak uninstall --delete-data club.haroohie.SerialLoops` to remove the Flatpak and all its associated data. If you don't want to keep your project data,
-ensure you delete the `~/SerialLoops` directory as well.
-* If you installed the deb or rpm package, run your package manager's uninstall command for the `SerialLoops` package. Afterwards, you can uninstall devkitARM by running the uninstall command for the `devkitpro-pacman` package.
-Finally, run `sudo rm -r /opt/devkitpro && sudo rm -r /etc/apt/sources.list.d/devkitpro.list` to delete the remainder of the devkitARM files on your system.
-* If you downloaded the tarball, delete the unpacked files from your system and then run the above commands to remove devkitARM from your system as well. You may also run your package manager's uninstallation command for SDL2.
+* If you installed the Flatpak, simply run uninstall it via the Warehouse app or your software/app store application. Alternatively, you can run `flatpak uninstall --delete-data club.haroohie.SerialLoops` to remove the Flatpak and all its associated data. If you don't want to keep your project data, ensure you delete the `~/SerialLoops` directory as well.
+* If you installed the AppImage, simply delete it from your machine.
+* If you installed the deb or rpm package, run your package manager's uninstall command for the `SerialLoops` package.
+* If you downloaded the tarball, delete the unpacked files from your system. You may also run your package manager's uninstallation command for Clang, LLD, Ninja, and SDL2.
 
 #### macOS
-Simply drag the Serial Loops application from the Applications folder to the trash. Afterwards, you can remove devkitARM from your system, you can open a terminal and run `sudo rm -rf /opt/devkitpro`.
+Simply drag the Serial Loops application from the Applications folder to the trash. Then run `brew uninstall llvm` and `brew uninstall ninja-build` to remove LLVM and Ninja (if you want to do so). Finally, if you also want to uninstall Homebrew, you can run `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/uninstall.sh)"`.
 
 #### Windows
-Go into Add or Remove Programs and remove Serial Loops, the devkitPro installer, and Docker Desktop. Then, open an administrator PowerShell or CMD terminal (Win+X,A) and run `wsl --uninstall` to uninstall WSL.
+Go into Add or Remove Programs and remove Serial Loops and (if you don't want it anymore) LLVM.
 
 ## Bugs
 Please file bugs in the Issues tab in this repository. Please include the following information:
@@ -139,7 +104,8 @@ Additionally, on macOS, you will have to install CMake so that the build can com
 ```bash
 sudo /Applications/CMake.app/Contents/bin/cmake-gui --install
 ```
-This will symlink the CMake binaries to `/usr/local/bin` which is necessary for the build to work.
+This will symlink the CMake binaries to `/usr/local/bin` which is necessary for the build to work. Alternatively, you can install
+cmake via Homebrew with `brew install cmake`.
 
 On Linux, you will need to install the SDL2 binaries for your distribution.
 
@@ -161,8 +127,6 @@ to the MSBuild global properties field. This has the same effect as specifying `
 If you'd like to contribute new features or fixes, we recommend [getting in touch on Discord first](https://discord.gg/nesRSbpeFM) before submitting a pull request!
 
 ### Testing
-Serial Loops has headless tests that run to test the UI and other functionality of the program. To run tests locally, you will need to define either a `ui_vals.json` file or set an environment variable.
-
-First, download [these test assets](https://haroohie.nyc3.cdn.digitaloceanspaces.com/bootstrap/serial-loops/test-assets.zip) -OutFile $(Build.ArtifactStagingDirectory)/test-assets.zip) and unzip them to a directory somewhere. Then, specify that directory in the `ui_vals.json` as `AssetsDirectory` or set the environment variable `ASSETS_DIRECTORY` to that path.
+Serial Loops has headless tests that run to test the UI and other functionality of the program.
 
 Tests can be run via `dotnet test` (make sure to add `-f net8.0` on Linux or Mac) or through the test runners in Rider or Visual Studio.

README.md

@@ -15,6 +15,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SerialLoops.Tests.Headless"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SerialLoops.Tests.Shared", "test\SerialLoops.Tests.Shared\SerialLoops.Tests.Shared.csproj", "{AAACA3F0-3DB5-4C45-83BE-5B0D87A32486}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "z_submodules", "z_submodules", "{8092BC8D-7D40-48E2-853E-2999DC2A9D09}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HaroohieClub.NitroPacker.SymTableHelper", "submodules\NitroPacker.SymTableHelper\HaroohieClub.NitroPacker.SymTableHelper.csproj", "{24BB519A-0F53-4A99-BB8C-942BEE580DE0}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -37,6 +41,10 @@ Global
 		{AAACA3F0-3DB5-4C45-83BE-5B0D87A32486}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{AAACA3F0-3DB5-4C45-83BE-5B0D87A32486}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{AAACA3F0-3DB5-4C45-83BE-5B0D87A32486}.Release|Any CPU.Build.0 = Release|Any CPU
+		{24BB519A-0F53-4A99-BB8C-942BEE580DE0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{24BB519A-0F53-4A99-BB8C-942BEE580DE0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{24BB519A-0F53-4A99-BB8C-942BEE580DE0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{24BB519A-0F53-4A99-BB8C-942BEE580DE0}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -46,6 +54,7 @@ Global
 		{D0A6E736-5240-4CD6-8F6F-CAA3F73330D3} = {D53AAD08-D78C-400E-A01D-85E1117D465A}
 		{88779AB0-A349-4131-B7AF-FBC3B8FF4FCE} = {0E408EA9-D3DE-4568-A8E4-8E3A6D791C46}
 		{AAACA3F0-3DB5-4C45-83BE-5B0D87A32486} = {0E408EA9-D3DE-4568-A8E4-8E3A6D791C46}
+		{24BB519A-0F53-4A99-BB8C-942BEE580DE0} = {8092BC8D-7D40-48E2-853E-2999DC2A9D09}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {BD2CAAA3-1F0F-451A-ABB8-DDD82A59815B}

SerialLoops.sln

@@ -11,24 +11,20 @@ AppDir:
     exec_args: $@
   apt:
     arch:
-    - amd64
+    - #APT_ARCH#
     allow_unauthenticated: true
     sources:
-    - sourceline: deb http://archive.ubuntu.com/ubuntu/ bionic main restricted
-    - sourceline: deb http://archive.ubuntu.com/ubuntu/ bionic-updates main restricted
-    - sourceline: deb http://archive.ubuntu.com/ubuntu/ bionic universe
-    - sourceline: deb http://archive.ubuntu.com/ubuntu/ bionic-updates universe
-    - sourceline: deb http://archive.ubuntu.com/ubuntu/ bionic multiverse
-    - sourceline: deb http://archive.ubuntu.com/ubuntu/ bionic-updates multiverse
-    - sourceline: deb http://archive.ubuntu.com/ubuntu/ bionic-backports main restricted
-        universe multiverse
-    - sourceline: deb http://security.ubuntu.com/ubuntu/ bionic-security main restricted
-    - sourceline: deb http://security.ubuntu.com/ubuntu/ bionic-security universe
-    - sourceline: deb http://security.ubuntu.com/ubuntu/ bionic-security multiverse
+    - sourceline: deb #URI# noble main restricted universe multiverse
+    - sourceline: deb #URI# noble-updates main restricted universe multiverse
+    - sourceline: deb #URI# noble-security main restricted universe multiverse
+    - sourceline: deb #URI# noble-backports main restricted universe multiverse
     include:
-    - libc6:amd64
-    - libsdl2-dev:amd64
-    - make:amd64
+    - libc6:#APT_ARCH#
+    - libsdl2-dev:#APT_ARCH#
+    - clang-19:#APT_ARCH#
+    - lld-19:#APT_ARCH#
+    - llvm-19:#APT_ARCH#
+    - ninja-build:#APT_ARCH#
   files:
     include: []
     exclude:
@@ -37,6 +33,13 @@ AppDir:
     - usr/share/doc/*/changelog.*
     - usr/share/doc/*/NEWS.*
     - usr/share/doc/*/TODO.*
+
+  runtime:
+    env:
+      SL_LLVM_PATH: $APPDIR/usr/lib/llvm-19
+      SL_NINJA_PATH: $APPDIR/usr/bin/ninja
+      SL_STORE_SYS_CONFIG: "false"
+
   test:
     fedora-30:
       image: appimagecrafters/tests-env:fedora-30
@@ -59,7 +62,7 @@ AppDir:
       command: ./AppRun
       use_host_x: true
 AppImage:
-  arch: x86_64
+  arch: #ARCH#
   comp: gzip
   update-information: guess
-  file_name: SerialLoops.AppImage
+  file_name: SerialLoops-#ARCH#.AppImage

install/linux/appimage/AppImageBuilder.yml

@@ -2,9 +2,9 @@ Package: SerialLoops
 Version: #VERSION#
 Section: custom
 Priority: optional
-Architecture: amd64
+Architecture: #ARCH#
 Essential: no
-Depends: libsdl2-dev, make, dotnet-sdk-8.0
+Depends: libsdl2-dev, dotnet-sdk-8.0, clang, lld, ninja-build
 Maintainer: The Haroohie Translation Club <haroohietranslation@gmail.com>
 Homepage: https://haroohie.club/chokurestu/serial-loops/
 Description: Editor for Suzumiya Haruhi no Chokuretsu