#Uxn11-OpenBSD

An emulator for the Uxn stack-machine, written in ANSI C. This is a fork of Uxn11 for OpenBSD support.

#Building

#Makefile

For your convenience a Makefile is provided. You can run make install to build and install the files.

By default, files are installed into /usr/local but this can be overridden using PREFIX:

# installs files into /usr/local/bin and /usr/local/share
$ make install

# installs files into /opt/uxn/bin and /opt/uxn/share
$ make PREFIX=/opt/uxn install

#Graphical

All you need is X11.

gcc -Os -DNDEBUG -g0 -s -I/usr/X11R6/include src/uxn.c src/devices/system.c src/devices/console.c src/devices/screen.c src/devices/controller.c src/devices/mouse.c src/devices/file.c src/devices/datetime.c src/uxn11.c -o bin/uxn11 -L/usr/X11R6/lib -lX11

#Terminal

If you wish to build the emulator without graphics mode:

gcc -Os -DNDEBUG -g0 -s src/uxn.c src/devices/system.c src/devices/console.c src/devices/file.c src/devices/datetime.c src/uxncli.c -o bin/uxncli

#Usage

The first parameter is the rom file, the subsequent arguments will be accessible to the rom, via the Console vector.

bin/uxnemu bin/polycat.rom arg1 arg2

#Manual

A manual page is provided documenting the Uxntal language:

man ./doc/man/uxntal.7

After running make install the man page should be found by man uxntal.

#Devices

The file device is sandboxed, meaning that it should not be able to read or write outside of the working directory.

• 00 system
• 10 console(+)
• 20 screen
• 80 controller
• 90 mouse
• a0 file
• c0 datetime

#Emulator Controls

• F1 toggle zoom
• F2 toggle debugger
• F3 quit
• F4 reboot
• F5 reboot(soft)

#Buttons

• LCTRL A
• LALT B
• LSHIFT SEL
• HOME START

#Need a hand?

The following resources are a good place to start:

• XXIIVV — uxntal
• XXIIVV — uxntal reference
• compudanzas — uxn tutorial

#Contributing

If your patches are concerned with the OpenBSD functionality of this fork, you can submit them to the ~coyotes/public-inbox mailing list using git send-email, otherwise they should be submitted to the ~rabbits/public-inbox mailing list against the original repository.