Building from Source

Building from Source

This guide explains how to build ryu_ldn_nx from source.

Prerequisites

Using Docker (Recommended)

• Docker
• Docker Compose

Native Build

• devkitPro with devkitA64
• libnx
• Atmosphere-libs (submodule)
• libultrahand (submodule, for overlay)

Docker Build

The easiest way to build is using Docker:

# Clone the repository
git clone --recursive https://github.com/Ethiquema/ryu_ldn_nx.git
cd ryu_ldn_nx

# Build sysmodule + overlay + dist ZIP + output/ directory
docker compose run --rm build

# Run host unit tests
docker compose run --rm test

# Clean all build artifacts and output/
docker compose run --rm clean

Per-Suite Test Targets

Run individual test suites:

cd tests && make test-ldn-state-machine
# Available: protocol, config, config-manager, log, socket,
# tcp-client, connection-state, reconnect, client, ldn-types,
# ldn-state-machine, ldn-proxy, ldn-error, ldn-integration,
# overlay, ipc-config, config-ipc-service, shared-state,
# packet-dispatcher, session-handler, proxy-handler,
# handler-integration, upnp, p2p-proxy, p2p-client,
# p2p-integration, p2p-create-network

# Coverage report
make COVERAGE=1 coverage

Build Outputs

After building:

| Output | Path | Description | |--------|------|-------------| | Sysmodule (.nsp) | sysmodule/ryu_ldn_nx.nsp | Main sysmodule binary | | Overlay (.ovl) | overlay/ryu_ldn_nx_overlay.ovl | Tesla overlay | | Debug symbols | sysmodule/ryu_ldn_nx.elf | Debug ELF | | Dist package | output/ | SD card directory structure | | Release ZIP | sysmodule/ryu_ldn_nx-release.zip | Release package |

The output/ directory contains the full SD card layout:

output/
├── atmosphere/contents/4200000000000010/
│   ├── exefs.nsp
│   ├── main.npdm
│   ├── toolbox.json
│   └── flags/boot2.flag
├── config/ryu_ldn_nx/
│   ├── config.ini.example
│   └── gamelist.txt
└── switch/.overlays/
    └── ryu_ldn_nx_overlay.ovl

Native Build

If you prefer building natively (requires devkitPro toolchain):

1. Install devkitPro

Follow the devkitPro getting started guide.

dkp-pacman -S switch-dev libnx

2. Clone Repository

git clone --recursive https://github.com/Ethiquema/ryu_ldn_nx.git
cd ryu_ldn_nx

3. Build Sysmodule

cd sysmodule
make -j$(nproc)

4. Build Overlay

The overlay uses libultrahand (included as a submodule in overlay/libultrahand/):

cd overlay
make -j$(nproc)

5. Distribution Package

cd sysmodule && make dist

This produces the output/ directory and ryu_ldn_nx-release.zip with the correct SD card layout. The config file is not included in dist because ensure_config_exists() in config.cpp auto-creates it on first boot.

Creating a Release Package

The recommended way is using the dist target:

# Build everything + dist
docker compose run --rm build    # includes dist

# Or natively:
cd sysmodule && make dist

This produces the correct directory structure with all required files including boot2.flag and toolbox.json.

Debugging

Interactive GDB against a running Switch:

docker compose run --rm debugger <SWITCH_IP> [PID]

GDB presets and component-specific debug scripts live in scripts/debugger/.

Troubleshooting Build Issues

Submodules not initialized

git submodule update --init --recursive

Missing libnx

dkp-pacman -S libnx

Atmosphere-libs errors

Make sure you have the correct version:

cd sysmodule/Atmosphere-libs
git checkout <required-version>

libultrahand not found

The overlay uses libultrahand as a submodule in overlay/libultrahand/. Make sure submodules are initialized:

git submodule update --init --recursive