Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HarbourMasters/Starship/llms.txt

Use this file to discover all available pages before exploring further.

The Nintendo Switch version of Starship is not compiled on the Switch itself — you build or download the PC release first to generate the required asset archives, then copy a small set of files to your SD card. A pre-built Switch package is also available from the nightly CI pipeline if you want to skip building from source entirely.
Starship does not include any copyrighted assets. You must provide your own legally obtained copy of Star Fox 64 (US 1.0 or US 1.1 Rev A) to generate the sf64.o2r file. We do not condone piracy.

​
Quick Start (Pre-built Nightly)

If you do not want to build from source, download the latest Switch build directly from the nightly CI pipeline:
This link always points to the most recent successful CI run from the main branch.
Download Starship-switch.zip (Nightly)

​
Generating Asset Archives on PC

The Switch build requires two .o2r asset archive files that are produced by running the PC version once. You can either build the PC release from source (see the Windows, Linux, or macOS guides) or download a PC release from the Releases page.
1

Run the PC release once

Launch the PC version of Starship (starship.exe on Windows, starship.appimage on Linux, or Starship on macOS) and select your US 1.0 or US 1.1 ROM when prompted.The launcher will extract assets and write the following files to the same directory as the executable:
  • sf64.o2r — game assets extracted from your ROM
  • starship.o2r — port-specific assets
2

Download the Switch NRO

Download the latest Switch package from the nightly link above (or from Releases) and extract the ZIP.The archive contains the starship.nro homebrew binary.
3

Copy files to your SD card

Copy all of the following files into a single folder on your Switch SD card (for example sdmc:/switch/starship/):
FileSource
starship.nroExtracted from the Switch ZIP
sf64.o2rGenerated by the PC release
starship.o2rGenerated by the PC release
Keep all three files in the same directory. Starship looks for the .o2r archives relative to the NRO location at launch.
4

Launch via the Homebrew Menu

Power on your Switch in homebrew mode and open starship.nro from the Homebrew Menu. The game will load your assets and start automatically.

​
CI Setup for Forks

Starship’s CI pipeline uses GitHub Actions. The Extract Assets step requires a self-hosted runner that has access to your ROM file. To configure this on your own fork:
  1. Go to Settings → Actions → Runners in your GitHub repository.
  2. Add a new self-hosted runner and assign it the asset-builder tag.
  3. Follow GitHub’s documentation to configure the runner as a service.

​
Windows CI Runners

On Windows runners you must allow unsigned scripts in PowerShell before the CI agent can execute build scripts. Open PowerShell as Administrator and run:
Set-ExecutionPolicy RemoteSigned
You will also need 7-Zip installed and available on PATH (e.g. via choco install 7zip). Most other dependencies are installed automatically as part of the CI process.

​
Linux / macOS CI Runners

Check apt-deps.txt (Linux) or macports-deps.txt (macOS) in the repository root for the complete list of packages that must be pre-installed on your runner machine.

Build docs developers (and LLMs) love

Get started for freeTalk to us