Go to file

neauoire 606c7707ff Only format when clang-format is present		2021-06-25 19:03:56 -07:00
etc	Improved syntax highlight	2021-06-20 09:21:15 -07:00
projects	Improved the keys example top reflect mods	2021-06-25 08:36:33 -07:00
src	Brought back portmidi with conditional compilation	2021-06-25 23:20:36 +01: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	Brought back portmidi with conditional compilation	2021-06-25 23:20:36 +01:00
build.sh	Only format when clang-format is present	2021-06-25 19:03:56 -07:00
mkfile	remove chr2img (see https://git.sr.ht/~rabbits/chr-format instead)	2021-06-23 17:45:13 +00: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. If you wish to use the Midi device, you must also have Portmidi installed. The build script indicates whether it has detected Portmidi or not, but will build Uxn either way.

./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

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

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.

Emulator Controls

F1 toggle zoom
F2 toggle debug
F3 capture screen

Need a hand?

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