Go to file

neauoire 7369f5fb52 Improved README		2021-05-24 21:23:59 -07:00
etc	Formatted uxn-fast.c according to clang-format	2021-05-23 19:05:17 +01:00
projects	Removed left/orca from the repo	2021-05-24 20:53:08 -07:00
src	Formatted uxn-fast.c according to clang-format	2021-05-23 19:05:17 +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 README	2021-05-24 21:23:59 -07:00
build.sh	Added more details to the README	2021-05-24 20:39:40 -07:00
mkfile	mkfile: profiling (disabled by default)	2021-05-19 07:29:23 +00:00

README.md

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