Go to file

Devine Lu Linvega e2a64438cd (calc.tal) Minor cleanup		2021-11-17 14:35:59 -05:00
etc	Exclude projects/assets in asma-test.sh	2021-11-07 00:48:14 +00:00
projects	(calc.tal) Minor cleanup	2021-11-17 14:35:59 -05:00
src	same fixes for uxncli	2021-11-17 14:29:36 +01:00
.build.yml	Build script maintenance	2021-11-10 07:10:42 +00:00
.clang-format	*	2021-01-30 14:25:48 -08:00
.gitignore	gitignore roms	2021-09-17 21:42:38 +02:00
LICENSE	init	2021-01-29 11:17:59 -08:00
README.md	Add link to macOS binary build.	2021-11-09 16:09:10 +00:00
build.sh	build: allow custom CFLAGS to be set	2021-11-17 14:12:48 +01:00
mkfile	add file device build dep to mkfile; fix file_delete prototype	2021-11-07 00:12:11 +01:00

README.md

Uxn

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

Download binaries

Binaries are available for 64-bit x86 computers running Linux, Windows and macOS.

Build

Linux/OS X

To build the Uxn emulator, you must install SDL2 for your distro. If you are using a package manager:

sudo pacman -Sy sdl2             # Arch
sudo apt install libsdl2-dev     # Ubuntu
brew install sdl2                # OS X

Build the assembler and emulator by running the build.sh script. The assembler(uxnasm) and emulator(uxnemu) are created in the /bin folder.

./build.sh 
	--debug # Add debug flags to compiler
	--format # Format source code

If you wish to build the emulator without graphics mode:

cc src/uxn.c -DNDEBUG -Os -g0 -s src/uxncli.c -o bin/uxncli

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

Emulator

To launch a .rom in the emulator, point the emulator to the target rom file:

bin/uxnemu bin/piano.rom

You can also use the emulator without graphics by using uxncli. You can find additional roms here, you can find prebuilt rom files here.

Assembler

The following command will create an Uxn-compatible rom from an uxntal file. Point the assembler to a .tal file, followed by and the rom name:

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

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 Options

-s 1, -s 2 or -s 3 set zoom (default 1)

Emulator Controls

F1 toggle zoom
F2 toggle debug
F3 capture screen
F4 load boot.rom

Need a hand?

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