Uxn stack machine implemented in Rust. Includes:

• an assembler from the Tal assembly language to Uxn binary program files, [uxnasmlib], invoked from the uxnasm binary crate
• a command line based machine based around Uxn, [emulators::uxnclilib], invoked from the uxncli binary crate
• a graphical machine based around Uxn (known as Varvara), [emulators::uxnemulib], invoked from the uxnemu binary crate
• utility for turning png images into Varvara compatible sequences of bytes, [utils::spritemake], invoked from the spritemake crate

installation

cargo install --git https://github.com/John-Sharp/rusty_uxn.git --all-features

uxnasm

The uxnasm binary is the assembler for building Tal assembly files into uxn machine code.

Usage

USAGE:
    uxnasm <SRC_PATH> <DST_PATH>

ARGS:
    <SRC_PATH>    The path to the assembly file
    <DST_PATH>    The path to the output rom

OPTIONS:
    -h, --help    Print help information

Example

To assemble the example program located at example_assets/cli/name_echo.tal:

uxnasm example_assets/cli/name_echo.tal name_echo.rom

uxncli

The uxncli is a command line only virtual machine built around the Uxn stack machine. It has implementations of Varvara devices for console input/output, file system manipulation, and date-time retrieval.

Usage

USAGE:
    uxncli <ROM> [INPUT]...

ARGS:
    <ROM>         Rom to run
    <INPUT>...    Initial console input for uxn virtual machine

OPTIONS:
    -h, --help    Print help information

Example

To assemble and then run the name echo example:

uxnasm example_assets/cli/name_echo.tal name_echo.rom && \
uxncli name_echo.rom

Initial console input can also be provided on the command line, with each space separated string having a newline added at the end and being passed to the program:

uxncli name_echo.rom you everyone

uxnemu

The uxnemu is a graphical virtual machine built around the Uxn stack machine. It has implementations of Varvara devices for console input/output, file system manipulation, date-time retrieval, controller input, mouse input, and writing to the screen.

Usage

USAGE:
    uxnemu <ROM> [INPUT]...

ARGS:
    <ROM>         Rom to run
    <INPUT>...    Initial console input for uxn virtual machine

OPTIONS:
    -h, --help    Print help information

Example

To assemble and then run an example allowing you to place rabbits with a mouse:

uxnasm example_assets/emu/rabbit_test.tal rabbit_test.rom && \
uxnemu rabbit_test.rom

spritemake

The spritemake binary is a program for converting png images into a format that can be included in Tal assembly files and rendered as sprites.

Usage

USAGE:
    spritemake <IMG_PATH>

ARGS:
    <IMG_PATH>    Path to image file to be used as basis of sprite

OPTIONS:
    -h, --help    Print help information

Note that the image provided should be of dimensions (8n) * (8m+1) where both n amd m are integers. The first four pixels of the image define the four Uxn system colors that this image uses, the rest of the image should only use these four colors.

What is produced is some Tal assembly defining a function and some data representing the png image in the Uxn sprite format. The function pops x and y coordinates off the working stack and will paint the image using (x, y) as the top left coordinate, constructing the image out of a series of 8x8 sprites.