aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBad Diode <bd@badd10de.dev>2021-05-20 17:02:47 +0200
committerBad Diode <bd@badd10de.dev>2021-05-20 17:02:47 +0200
commit707b6dac805bcc4f2b5e297ff3ce4b82538bcff0 (patch)
tree23799c789848b6dd75ba7fb124bc903d9328776b /README.md
parentbe6617308ea796d2a41007a7bee1472884e189f7 (diff)
downloaduxngba-707b6dac805bcc4f2b5e297ff3ce4b82538bcff0.tar.gz
uxngba-707b6dac805bcc4f2b5e297ff3ce4b82538bcff0.zip
Add README and some example roms
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..975201c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
1# UXNGBA
2
3This is a port of the [UXN virtual machine][uxn] for the GBA. It is currently at
4an early stage, but is capable of running simple demos that make use of the
5screen or console devices, including the beautiful DVD bouncing.
6
7[uxn]: https://wiki.xxiivv.com/site/uxn.html
8
9## Building from source
10
11To build this software you need the [devkitPro][devkitpro] SDK. Once installed,
12You may need to modify the Makefile to set up the path:
13
14```
15DEVKITPRO := /opt/devkitpro
16DEVKITARM := /opt/devkitpro/devkitARM
17PATH := $(DEVKITARM)/bin:$(PATH)
18LIBGBA_DIR := $(DEVKITPRO)/libgba
19LIBGBA_SRC := /opt/devkitpro/libgba/include/
20LIBGBA := $(LIBGBA_DIR)/lib/libgba.a
21LIBGBA += $(LIBGBA_DIR)/lib/libfat.a
22LIBGBA += $(LIBGBA_DIR)/lib/libmm.a
23```
24
25An intermediate build step will create a `src/uxn/roms/boot.c` file, for which
26you need the `bin2carr` utility that can be found [here][bin2carr].
27
28If everything is properly installed, you should be able to run `make` to compile
29the program into a `uxngba.gba` rom. If you have `mgba-qt` installed, you can
30test it with: `make run`.
31
32To use a specific UXN compiled rom, you can pass it as the `ROM_SRC` make
33parameter:
34
35```
36make run ROM_SRC=src/uxn/roms/piano.rom
37```
38
39[devkitpro]: https://devkitpro.org/
40[bin2carr]: https://git.badd10de.dev/gba-dev-tools/