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