uxn/README.md

1.2 KiB

Uxn

An 8-bit stack-based computer, written in ANSI C.

Build

Linux

To build the Uxn emulator, you must have SDL2.

./build.sh 
	--debug # Add debug flags to compiler
	--cli # Run rom without graphics

Plan 9

To build the Uxn emulator on 9front, via npe:

mk

If the build fails on 9front because of missing headers or functions, try again after rm -r /sys/include/npe.

Getting Started

Begin by building the assembler and emulator by running the build script. The assembler(uxnasm) and emulator(uxnemu) are created in the bin folder.

./build.sh

This example will create the life.rom from the life.usm uxambly file, point to a different usm file to assemble a different rom. You can find additional roms here. To create a rom, from a usm file, use the following command:

bin/uxnasm projects/demos/life.usm bin/life.rom

To launch the rom:

bin/uxnemu bin/life.rom

Emulator Controls

  • ctrl+h toggle debugger
  • alt+h toggle zoom

Need a hand?

Find us in #uxn, on irc.esper.net