Developer preview v1.1.2 — installation, packaging, and some platform support are still in progress. Read the status
Skip to content

Emulator workflow ​

Clorraine targets real 68K Amiga systems. The development loop runs on a modern host with two emulators:

ToolBest forSpeedROM
vamosConsole programs, output checks, CIFastNone
FS-UAEGraphics, audio, Intuition, timersSlowerAROS by default; original ROMs optional

vamos ​

vamos runs AmigaOS CLI binaries on the host. It is the default path for console programs and for the host-versus-m68k differential checks.

Inside the repository:

sh
make run FILE=examples/hello/hello.clo PROFILE=hosted-amiga

The command builds the program for hosted-amiga and runs it under vamos. The output is the same text the program prints on an Amiga.

Use CAPTURE=1 to write the output to a file instead of streaming it:

sh
make run FILE=examples/hello/hello.clo PROFILE=hosted-amiga CAPTURE=1

FS-UAE ​

FS-UAE is used for graphics, audio, Intuition, and the hardware gates. The SDK provides a wrapper that builds the program and boots the emulator:

sh
make run FILE=examples/amiga/boing.clo PROFILE=hosted-amiga-13 EMULATOR=1

The A500 profile needs a licensed Kickstart 1.3 ROM in ~/amiga/roms. The repository's make init creates the data folders and suggests values for detected ROMs.

For a headless capture:

sh
make run FILE=examples/amiga/boing.clo PROFILE=hosted-amiga-13 EMULATOR=1 CAPTURE=1

Media policy ​

  • No ROM is required for vamos.
  • FS-UAE defaults to its built-in AROS replacement ROM.
  • Original Kickstart and Workbench media is user-supplied. It is never downloaded, copied, or committed by the project.
  • The advanced Workbench gates need licensed media and are not part of a bare checkout's fast path.

Requirements ​

RequirementWhy
DockerThe pinned SDK image and toolchain
X displayFS-UAE needs a display; the SDK wraps it with Xvfb for headless gates
~/amiga/romsOnly for FS-UAE with original ROMs
~/amiga/adf, ~/amiga/hdfOnly for licensed Workbench media

If the emulator cannot open a display, see the X11 troubleshooting section in docker/README.md.

The full acceptance gate ​

make verify runs the host checks plus the Amiga legs: SDK builds, emulator runs, native captures, differential checks, and runtime-fault programs. It needs the SDK X display and the licensed media for the advanced gates.

For a quick check without the Amiga legs, use make check.

Learn more ​

Clorraine is an independent project. Amiga, AmigaOS, Kickstart, and Workbench are trademarks of Amiga Corporation. Not affiliated with or endorsed by Amiga Corporation or Hyperion Entertainment.