Go to file

neauoire 2aaf936573 Minor optimization to piano		2021-06-27 16:48:38 -07:00
etc	Improved syntax highlight	2021-06-20 09:21:15 -07:00
projects	Minor optimization to piano	2021-06-27 16:48:38 -07:00
src	The console read byte is its own location	2021-06-27 16:42:47 -07:00
.clang-format	*	2021-01-30 14:25:48 -08:00
.gitignore	Added screenshot functionality, contributed by badd10de, thank you!	2021-06-11 09:18:52 +01:00
LICENSE	init	2021-01-29 11:17:59 -08:00
README.md	Removed the noisy prints in the assembler	2021-06-27 10:03:09 -07:00
build.sh	Minor updates	2021-06-27 18:56:21 +01:00
mkfile	fix Plan 9 build again	2021-06-27 17:23:27 +02:00

README.md

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.

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