Go to file
neauoire 2c560686d8 Moved masks to system 2023-08-25 09:40:25 -07:00
etc Boilerplate threads 2023-08-25 09:18:37 -07:00
src Moved masks to system 2023-08-25 09:40:25 -07:00
.build.yml Fixed issue with links to binaries 2023-06-08 11:17:47 -07:00
.clang-format Added Fn keys controls 2022-04-05 20:06:42 -07:00
.gitignore Init 2022-03-26 17:23:52 -07:00
LICENSE Init 2022-03-26 17:23:52 -07:00
README.md Updated build instructions in README 2023-08-08 17:00:48 -07:00
makefile Boilerplate threads 2023-08-25 09:18:37 -07:00

README.md

Uxn11

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

Building

Graphical

All you need is X11.

gcc -Os -DNDEBUG -g0 -s 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 -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

If do not wish to build it yourself, you can download linux binaries for uxnasm, uxncli and uxn11.

builds.sr.ht status

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

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

  • F2 toggle on-screen debugger
  • F4 load boot.rom, or reload rom

Buttons

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

Need a hand?

The following resources are a good place to start:

Contributing

Submit patches using git send-email to the ~rabbits/public-inbox mailing list.