Uxn

An assembler and emulator for the Uxn stack-machine, written in ANSI C.

Build

Linux

To build the Uxn emulator, you must have SDL2.

./build.sh 
	--debug # Add debug flags to compiler

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.

Windows

Uxn can be built on Windows with MSYS2. Install by downloading from their website or with Chocolatey with choco install msys2. In the MSYS shell, type:

pacman -S git mingw-w64-x86_64-gcc mingw64/mingw-w64-x86_64-SDL2
export PATH="${PATH}:/mingw64/bin"
git clone https://git.sr.ht/~rabbits/uxn
cd uxn
./build.sh

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

Assembler

The following command will create an Uxn-compatible rom from an uxntal file, point to a different .tal file in /projects to assemble a different rom.

bin/uxnasm projects/examples/demos/life.tal bin/life.rom

Emulator

To start the rom, point the emulator to the newly created rom:

bin/uxnemu bin/life.rom

You can also use the emulator without graphics by using uxncli. You can find additional roms here.

I/O

You can send events from Uxn to another application, or another instance of uxn, with the Unix pipe. For a companion application that translates notes data into midi, see the shim.

uxnemu orca.rom | shim

Emulator Controls

F1 toggle zoom
F2 toggle debug
F3 capture screen

Need a hand?

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

2 KiB Raw Blame History

Uxn