uxn/README.md

106 lines
3.2 KiB
Markdown
Raw Normal View History

2021-01-29 14:17:59 -05:00
# Uxn
An assembler and emulator for the [Uxn stack-machine](https://wiki.xxiivv.com/site/uxn.html), written in ANSI C.
2021-01-29 14:35:59 -05:00
## Download binaries
2021-11-09 11:09:06 -05:00
Binaries are available for 64-bit x86 computers running [Linux](https://rabbits.srht.site/uxn-linux-amd64.tar.gz), [Windows](https://rabbits.srht.site/uxn-windows-64bit.zip) and [macOS](https://rabbits.srht.site/uxn-macos.tar.gz).
2021-03-22 22:04:31 -04:00
## Build
2021-02-11 21:48:45 -05:00
2021-08-27 14:00:34 -04:00
### Linux/OS X
2021-05-24 23:39:40 -04:00
2021-08-25 18:55:57 -04:00
To build the Uxn emulator, you must install [SDL2](https://wiki.libsdl.org/) for your distro. If you are using a package manager:
2021-08-25 18:53:37 -04:00
```sh
sudo pacman -Sy sdl2 # Arch
sudo apt install libsdl2-dev # Ubuntu
sudo xbps-install SDL2-devel # Void Linux
2021-08-29 22:38:42 -04:00
brew install sdl2 # OS X
2021-08-25 18:53:37 -04:00
```
Build the assembler and emulator by running the `build.sh` script. The assembler(`uxnasm`) and emulator(`uxnemu`) are created in the `./bin` folder.
2021-02-11 21:48:45 -05:00
2021-03-22 22:04:31 -04:00
```sh
./build.sh
--debug # Add debug flags to compiler
2021-08-27 14:00:34 -04:00
--format # Format source code
2021-02-11 21:48:45 -05:00
```
2021-08-25 18:55:57 -04:00
If you wish to build the emulator without graphics mode:
2021-08-25 18:53:37 -04:00
```sh
cc src/uxn.c -DNDEBUG -Os -g0 -s src/uxncli.c -o bin/uxncli
```
2021-05-24 23:39:40 -04:00
### Plan 9
2021-05-17 18:15:40 -04:00
To build the Uxn emulator on [9front](http://9front.org/), via [npe](https://git.sr.ht/~ft/npe):
2021-05-17 18:07:20 -04:00
```rc
mk
```
If the build fails on 9front because of missing headers or functions, try again after `rm -r /sys/include/npe`.
2021-05-17 18:07:20 -04:00
### Windows
Uxn can be built on Windows with [MSYS2](https://www.msys2.org/). Install by downloading from their website or with Chocolatey with `choco install msys2`. In the MSYS shell, type:
```sh
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
```
To run the emulator _outside_ of the MSYS2 environment, download the [SDL runtime binary for Windows](https://libsdl.org/download-2.0.php) and place the `SDL2.dll` file in the same directory as the emulator (`bin/`).
2021-05-24 23:39:40 -04:00
## Getting Started
2021-08-25 18:53:37 -04:00
### Emulator
2021-08-25 18:53:37 -04:00
To launch a `.rom` in the emulator, point the emulator to the target rom file:
2021-05-24 23:39:40 -04:00
2021-08-25 18:53:37 -04:00
```sh
bin/uxnemu bin/piano.rom
2021-05-24 23:39:40 -04:00
```
2021-08-25 18:53:37 -04:00
You can also use the emulator without graphics by using `uxncli`. You can find additional roms [here](https://sr.ht/~rabbits/uxn/sources), you can find prebuilt rom files [here](https://itch.io/c/248074/uxn-roms).
2021-05-24 23:39:40 -04:00
2021-08-25 18:53:37 -04:00
### Assembler
2021-05-24 23:39:40 -04:00
2021-08-25 18:53:37 -04:00
The following command will create an Uxn-compatible rom from an [uxntal file](https://wiki.xxiivv.com/site/uxntal.html). Point the assembler to a `.tal` file, followed by and the rom name:
2021-08-16 10:22:53 -04:00
2021-08-25 18:53:37 -04:00
```sh
bin/uxnasm projects/examples/demos/life.tal bin/life.rom
2021-08-16 10:22:53 -04:00
```
2021-05-25 00:31:53 -04:00
### 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](https://git.sr.ht/~rabbits/shim).
2021-08-25 18:53:37 -04:00
```sh
uxnemu orca.rom | shim
```
2021-09-21 16:22:58 -04:00
## Emulator Options
- `-s 1`, `-s 2` or `-s 3` set zoom (default 1)
2021-03-24 12:39:19 -04:00
## Emulator Controls
2021-06-25 11:57:25 -04:00
- `F1` toggle zoom
- `F2` toggle debug
- `F3` capture screen
2021-11-08 11:21:23 -05:00
- `F4` load boot.rom
2021-03-24 12:39:19 -04:00
2021-05-25 00:23:59 -04:00
## Need a hand?
2021-01-29 14:35:59 -05:00
2021-11-29 16:28:15 -05:00
Find us in [`#uxn` on irc.esper.net](ircs://irc.esper.net:6697/#uxn).
2021-12-13 17:42:21 -05:00
## Contributing
Submit patches using [`git send-email`](https://git-send-email.io/) to the [~rabbits/public-inbox mailing list](https://lists.sr.ht/~rabbits/public-inbox).