Go to file

Andrew Alderwick d5b2bd9895 Revert "Removed second texture of PPU"		2021-05-30 23:15:37 +01:00
etc	Improved uxncli and moved all demos into examples	2021-05-26 10:02:13 -07:00
projects	Added piano samples in project	2021-05-28 12:37:59 -07:00
src	Revert "Removed second texture of PPU"	2021-05-30 23:15:37 +01:00
.clang-format	*	2021-01-30 14:25:48 -08:00
.gitignore	Added test suite for asma	2021-05-16 10:20:42 +01:00
LICENSE	init	2021-01-29 11:17:59 -08:00
README.md	Improved uxncli and moved all demos into examples	2021-05-26 10:02:13 -07:00
build.sh	Improved uxncli and moved all demos into examples	2021-05-26 10:02:13 -07:00
mkfile	Improved uxncli and moved all demos into examples	2021-05-26 10:02:13 -07: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

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

bin/uxnasm projects/examples/demos/life.usm 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

ctrl+h toggle inspector
alt+h toggle zoom

Need a hand?

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