Installation

Serial Loops is available for Windows, macOS, and Linux. You can get the latest release from here.

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
  • macOS: Installer (also installs devkitARM and Xcode tools for make)
  • Windows: Installer (also installs Windows Subsystem for Linux and is bundled with the Docker installer and devkitPro installer for devkitARM)

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.

View prerequisites for non-Flatpak/installer distributions

Installing devkitARM

devkitARM 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 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. 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 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). 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, .deb, or .rpm), you will also need to install SDL2 which is used for audio processing.

Running the installer on macOS

Because we do not sign our installer, macOS will by default prevent you from running it. In order to give macOS explicit approval to run the file, you will need to open a terminal and run xattr -cr ~/Downloads/[name_of_installer].pkg, replacing [name_of_installer] with the name of the installer file you downloaded. Every release has the specific command you need to run.

A Nintendo DS Emulator

To test the game easily, you will want to have a Nintendo DS emulator installed. We recommend using melonDS for its accuracy.

On Linux, you can install the official melonDS Flatpak from Flathub to use as your emulator. We recommend installing it from the flathub-beta repository as that is where the most up-to-date versions tend to be pushed.

Download & Install

Once you have installed any necessary prerequisites, to install Serial Loops, download the latest release for your platform from the Releases tab.