d6
/
uxn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,256 Commits 7 Branches 0 Tags 3.3 MiB
C 85.1%
Shell 5.6%
MoonScript 5.5%
Lua 2.4%
Makefile 1.3%
Other 0.1%
Go to file
~d6 f68ed452d4 Update file_stat to match the existing documentation. 
Previously, writing to the stat port would produce a line of text
similar to the listing used when reading a directory. This did not
match the documentation around the stat port.

After the change, writing an address to the stat port will fill that
address with bytes equal to the length parameter. These will either be
a hexadecimal file size, or else the same character repeated N times
according to the following logic:

 - path is a directory
 ? file size of path does not fit in N hexadecimal characters
 ! path is not readable

Note that unlike when reading a directory, the string will not include
the requested path, a newline, or a null terminator.
 		2024-09-18 22:58:45 -04:00
etc (uxnasm) Fixed issue with comments inside macros 2024-03-28 12:04:25 -07:00
projects (pond.tal) Added a little demo that draws circles 2024-08-24 16:31:37 -07:00
src Update file_stat to match the existing documentation. 2024-09-18 22:58:45 -04:00
.build.yml Fixed error in build 2024-03-16 14:05:05 -07:00
.clang-format * 2021-01-30 14:25:48 -08:00
.gitignore Merged conflicts 2024-02-22 14:17:42 -08:00
.wallpaper Added wallpaper for potato 2024-02-22 15:33:42 -08:00
LICENSE init 2021-01-29 11:17:59 -08:00
README.md Updated devices 2024-07-15 12:12:10 -07:00
boot.rom Added wallpaper for potato 2024-02-22 15:33:42 -08:00
build.sh Updated potato 2024-02-22 14:21:57 -08:00
mkfile Setting up stage to add versioning 2023-08-08 14:13:07 -07: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
sudo xbps-install SDL2-devel     # Void Linux
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
	--install # Copy to ~/bin

If you wish to build the emulator without graphics mode:

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

Plan 9

To build and install the Uxn emulator on 9front, via npe:

mk install

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

If you'd like to work with the Console device in uxnemu.exe, run ./build.sh --console instead: this will bring up an extra window for console I/O unless you run uxnemu.exe in Command Prompt or PowerShell.

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

GUI Emulator Options

  • -2x Force medium scale
  • -3x Force large scale
  • -f Force fullscreen mode
  • -- Force next argument to be read as ROM name. (This is useful if your ROM file is named -v, -2x, and so forth.)

GUI Emulator Controls

  • F1 toggle zoom
  • F2 toggle debugger
  • F3 quit
  • F4 reboot
  • F5 reboot(soft)
  • F11 toggle fullscreen
  • F12 toggle decorations

GUI 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.