Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kivutar/uxn
https://github.com/kivutar/uxn
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kivutar/uxn
- Owner: kivutar
- License: mit
- Created: 2021-10-17T16:47:43.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-07T05:06:10.000Z (about 3 years ago)
- Last Synced: 2024-10-12T02:06:14.802Z (27 days ago)
- Language: C
- Size: 1.66 MB
- Stars: 16
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-uxn - Libretro port - [Libretro](https://www.libretro.com/) emulation layer. (Emulators)
README
# Uxn
An assembler and emulator for the [Uxn stack-machine](https://wiki.xxiivv.com/site/uxn.html), written in ANSI C.
## Download binaries
Binaries are available for 64-bit x86 computers running [Linux](https://rabbits.srht.site/uxn-linux-amd64.tar.gz) and [Windows](https://rabbits.srht.site/uxn-windows-64bit.zip).
## Build
### Linux/OS X
To build the Uxn emulator, you must install [SDL2](https://wiki.libsdl.org/) for your distro. If you are using a package manager:
```sh
sudo pacman -Sy sdl2 # Arch
sudo apt install libsdl2-dev # Ubuntu
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.
```sh
./build.sh
--debug # Add debug flags to compiler
--format # Format source code
```
If you wish to build the emulator without graphics mode:
```sh
cc src/uxn.c -DNDEBUG -Os -g0 -s src/uxncli.c -o bin/uxncli
```
### Plan 9
To build the Uxn emulator on [9front](http://9front.org/), via [npe](https://git.sr.ht/~ft/npe):
```rc
mk
```
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](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
```
## Getting Started
### Emulator
To launch a `.rom` in the emulator, point the emulator to the target rom file:
```sh
bin/uxnemu bin/piano.rom
```
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).
### Assembler
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:
```sh
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](https://git.sr.ht/~rabbits/shim).
```sh
uxnemu orca.rom | shim
```
## Emulator Options
- `-s 1`, `-s 2` or `-s 3` set zoom (default 1)
## Emulator Controls
- `F1` toggle zoom
- `F2` toggle debug
- `F3` capture screen
## Need a hand?
Find us in `#uxn`, on irc.esper.net