hundredrabbits/awesome-uxn

Awesome things from the community

Awesome Uxn

Curated list of awesome Uxn projects from the community.

The Uxn ecosystem is a personal computing playground, created to host small tools and games, programmable in its own unique assembly language.

• Awesome Uxn
  • Documentation
  • Tutorials
  • Emulators
    • Desktop
    • Other Systems
    • Misc
    • Simulator
  • Applications
    • Creative
    • Utilities
    • Games
    • Networking
    • Operating Systems / REPLs
    • Demos
    • Libraries
    • Terminal / Command-Line
  • Development Tools
    • IDEs
    • Assemblers, Compilers & Disassemblers
    • Uxntal Language Support
  • Metadevelopment Tools
    • Testing
    • Benchmarking
  • Community

Documentation

• Varvara - Technical documentation of the Varvara computer and a list of all its devices.
• Uxntal - Uxntal language reference manual.
• Uxntal opcode manual - List of Uxntal opcodes and their effects.
• Sprite format - .chr file format description.
• Font format - .ufx file format description.
• Uxntal Cheatsheet - Opcode Cheatsheet.

Tutorials

• Uxn Tutorial by Compudanzas - Beginner-friendly tutorial guide which covers the basics of Uxn programming.
• Uxn Tutorial by Compudanzas(video) - Beginner-friendly video workshop which covers the basics of Uxn programming.
• Learn Uxntal in Y minutes - Quick Uxntal guide.
• Uxn implementation guide - Notes on how to implement the Uxn/Varvara virtual machine specification.
• macOS installation
• Windows installation
• Android installation - Guide for running Uxn on the Android operating system through Termux.
• HaikuOS - Forum thread for the Haiku operating system.

Emulators

Desktop

• Uxn - Cross-platform emulator and assembler, written in C(SDL2).
• Uxn32 - Windows emulator, written in C.
• Uxn11 - Linux emulator, written in C.
• Raven - Cross-platform emulator, written in Rust.
• UxnFb - Linux framebuffer emulator, written in C.
• UxnRPI - RaspberryPi framebuffer emulator, written in C. (no input support)
• UxnAmiga - AmigaOS emulator, written in C. (no keyboard or joystick input, no audio support)
• UxnEssence - Essence emulator, written in C.
• UxnJulia - Cross-platform emulator and assembler, written in Julia.
• UxnLua - Cross-platform emulator, written in Lua(Love2d).
• Uxn38 - Emulator written in C with SDL1.
• Nux - Emulator written in Go.
• uxn-rs - Emulator written in Rust.
• ruxn - A Uxn library written in Rust, intended to make defining new Uxn-based systems easy.
• zuxn - A Uxn library, emulator and assembler written in Zig.

Other systems

• FPGA - Nearly Complete.
• RPi - Nearly Complete.
• Game Boy Advance - Complete.
• Nintendo 64 - Complete.
• Nintendo DS - Complete.
• Playdate - Complete.
• Nook eReader - Complete.
• Nokia N900 - Partial.
• Game Boy - Experimental.
• DOS - Implemented: Core, Screen, Mouse, Controller.
• Teletype - Incomplete.
• ESP32 - Incomplete.
• iOS - Nearly Complete (missing midi and controller).
• iOS - Incomplete.
• STM32 - Incomplete.
• STM32duino - Incomplete.
• IBM PC - Incomplete.
• PlayStation Vita - Incomplete.
• PlayStation Portable - Nearly Complete (missing keyboard).
• Atari ST - Incomplete.

Misc

• Libretro port - Libretro emulation layer.
• LearnUxn - Web assembler and emulator.
• Grid - Incomplete.
• Rockbox - Implemented: Core, Screen.
• Logisim - Incomplete.
• Adafruit PyBadge - Implemented: Core, Console, Screen, Controller.
• Webuxn - Lightweight port of the Uxn virtual machine to the web via WebAssembly.
• auxn - uxn running inside of an audio plugin (standalone mode included)
• UxnWasm - WebAssembly implementation of the Uxn core.

Simulators

• uxn.py - Python implementation of the VM.
• uxn.js - Javascript implementation of the VM.

Applications

Creative

• Left - Graphical plain-text editor with proportional fonts and Uxntal syntax highlight.
• Nasu - Spritesheet editor.
• Noodle - Drawing tool.
• Turye - Font editor.
• Orca - Livecoding IDE.
• uxn-harp - Chordal musical toy.

Utilities

• Dexe - Graphical hex editor.
• Calc - Graphical hexadecimal calculator.
• Clock - Graphical clock.
• Starling - Spreadsheet application.
• Beetbug - Step debugger.

Games

• Niju - Hiragana and katakana learning game.
• Donsol - Card game about exploring a dungeon made of a standard 54 poker card set.
• Flappy - Implementation of a Flappy Bird-like game.
• Pong - Recreation of the classic Pong game.
• Snake - Classic Snake game implementation.
• Cat Cubes - Puzzle game about matching and clearing tiles from a board.
• Minesweeper - Minesweeper port for Varvara.
• XO - TicTacToe for Varvara.
• Fourtette - Tetris for Varvara.
• Shanghai - Mahjong Solitaire for Varvara.
• Pinkie Run - Pony-themed Endless Runner for Varvara.
• oneko-uxn - A version of “Neko”, the classic desktop pet cat, with several characters.
• Lights Out - Puzzle game for Varvara.
• Worm - Dune themed snake game for Varvara.

Networking

• Xrxs - Experimental game server using the Plan 9 protocol 9p.

Operating systems/REPLs

• UF - A traditional Forth system for Varvara.
• CollapseOS - Forth-based operating system for Varvara.
• Uxnfth - Uxn-native forth.
• PotatoOS - A little desktop environment.
• Varaboy - Gameboy Emulator.

Demos

• Bad-apple-uxn - Bad Apple!! video on a single Uxn ROM.
• tiles - A scrolling tile-map renderer.
• svitlyna - A "full-color" image viewer.

Libraries

• math32 - Unsigned 32-bit integers
• regex - Regex parsing and matching (repl)
• fix16 - Signed 16-bit fixed point numbers (8.8)
• alloc - Arena-based memory allocator
• arg - Command-line argument parsing (demo)

Terminal / Command-line

• femto - nano-like text editor (about / launcher / rom)
• grep - minimal grep-like tool (uses regex.tal)

Development tools

IDEs

• Learn-uxn - A web-based development environment with a text editor and up-to-date versions of Uxnasm and Uxnemu.

Assemblers, compilers & disassemblers

• Uxnasm - The original implementation of the Uxntal assembler in about 400 lines of ANSI C.
• Asma - Uxntal assembler, written in Uxntal.
• Drifblim - Uxntal Assembler, written in Uxntal.
• Uxncle - Compiler for a small subset of C to Uxn bytecode.
• Pyuxncle - Python implementation of Uxncle.
• Conch - Compiler for a C-like language with Lisp-like syntax to Uxn bytecode.
• Uxnbruteforce - Tool for optimizing little pieces of Uxntal code.
• Uxnlin - Linter for Uxntal.
• Uxnbot - IRC bot for assembling and running small Uxntal snippets.
• Pyuxntaldisasm - Very basic disassembler for Uxn ROMs.
• Uxnasm-js - Uxntal assembler written in JavaScript.
• Uxn-disassembler - A rom disassembler writen in Uxntal
• Dotal - A small language designed to compile to the Uxn virtual machine.
• lunas - An Uxntal assembler written in Lua.
• chibicc-uxn - A C compiler for Uxn, written in C.
• nito - A compiler from Uxntal to C, written in Raku. See also the blog post.
• funktal - A small, statically typed, functional programming language that compiles to Uxntal. The compiler is written in Fortran. See also the blog post.

Uxntal language support

• Atom language package
• Emacs mode (alt 1 alt 2)
• Kakoune plugin
• Lite XL plugin
• Micro syntax
• Nano syntax
• Nano syntax(alt)
• Sublime syntax
• Vim plugin
• Visual Studio Code extension

Metadevelopment tools

Testing

• Reference test suite included in the uxn-utils repository: opctest.
• Others
  • Uxn-instruction-tests - Test suite for the Uxn CPU instruction set.

Benchmarking

• Bunnymark - Render performance benchmark.

Community

• Lines
• #uxn on irc.libera.net
• #uxn on Merveilles