aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBad Diode <bd@badd10de.dev>2023-08-30 20:37:17 +0200
committerBad Diode <bd@badd10de.dev>2023-08-30 20:37:17 +0200
commit7a02b549a38dadb48c43143ff94c9094abf25555 (patch)
tree2e7c983449488a2b537cd2b66817bf8f940674c7
parent874ae39b6074da2778b72bcbaf6c7c7ef19aa233 (diff)
downloaduxngba-7a02b549a38dadb48c43143ff94c9094abf25555.tar.gz
uxngba-7a02b549a38dadb48c43143ff94c9094abf25555.zip
Update README
-rw-r--r--README.md16
-rw-r--r--src/main.c4
2 files changed, 11 insertions, 9 deletions
diff --git a/README.md b/README.md
index dca6ba3..9e87080 100644
--- a/README.md
+++ b/README.md
@@ -30,11 +30,11 @@ If everything is properly installed, you should be able to run `make` to compile
30the program into a `uxngba.gba` rom. If you have `mgba-qt` installed, you can 30the program into a `uxngba.gba` rom. If you have `mgba-qt` installed, you can
31test it with: `make run`. 31test it with: `make run`.
32 32
33To use a specific UXN compiled rom, you can pass it as the `ROM_SRC` make 33To use a specific UXN compiled rom, you can pass it as the `UXN_ROM` make
34parameter: 34parameter:
35 35
36``` 36```
37make run ROM_SRC=roms/noodle.rom 37make run UXN_ROM=roms/noodle.rom
38``` 38```
39 39
40If you have compiled a rom already and want to change it, you probably want to 40If you have compiled a rom already and want to change it, you probably want to
@@ -52,14 +52,14 @@ macros on compile time as described below.
52### Input method order 52### Input method order
53 53
54Uxngba currently supports three different control schemes that can be cycled by 54Uxngba currently supports three different control schemes that can be cycled by
55pressing the SELECT button: `CONTROL_CONTROLLER`, `CONTROL_MOUSE` and 55pressing the L or R buttons: `CONTROL_CONTROLLER`, `CONTROL_MOUSE` and
56`CONTROL_KEYBOARD`. To select the order and available methods set the 56`CONTROL_KEYBOARD`. To select the order and available methods set the
57`CONTROL_METHODS` macro on compile time. For example, [noodle][noodle] doesn't 57`CONTROL_METHODS` macro on compile time. For example, [noodle][noodle] doesn't
58make much use of the controller scheme, and we may want to use the mouse as the 58make much use of the controller scheme, and we may want to use the mouse as the
59default input method. This can be achieved with the following command: 59default input method. This can be achieved with the following command:
60 60
61``` 61```
62make run ROM_SRC=roms/noodle.rom CONFIG="-DCONTROL_METHODS=CONTROL_MOUSE,CONTROL_KEYBOARD" 62make run UXN_ROM=roms/noodle.rom CONFIG="-DCONTROL_METHODS=CONTROL_MOUSE,CONTROL_KEYBOARD"
63``` 63```
64 64
65### Audio quality 65### Audio quality
@@ -72,11 +72,11 @@ a good quality-performance compromise. A high quality and low-fi audio modes can
72be selected by setting the `AUDIO_HIFI` or `AUDIO_LOFI` macros: 72be selected by setting the `AUDIO_HIFI` or `AUDIO_LOFI` macros:
73 73
74``` 74```
75make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_HIFI" 75make run UXN_ROM=roms/audio.rom CONFIG="-DAUDIO_HIFI"
76 76
77 or 77 or
78 78
79make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_LOFI" 79make run UXN_ROM=roms/audio.rom CONFIG="-DAUDIO_LOFI"
80``` 80```
81 81
82### Text layer 82### Text layer
@@ -84,10 +84,12 @@ make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_LOFI"
84When writing text to the screen (for example using the console device) the text 84When writing text to the screen (for example using the console device) the text
85will be drawn by default on the foreground layer. This can be controlled by 85will be drawn by default on the foreground layer. This can be controlled by
86setting the `TEXT_MODE` option to 0 for foreground mode or 1 for background 86setting the `TEXT_MODE` option to 0 for foreground mode or 1 for background
87mode. 87mode. The text layer can be omitted if using the TEXT_DISABLE macro.
88 88
89``` 89```
90make run CONFIG="-DTEXT_MODE=1" 90make run CONFIG="-DTEXT_MODE=1"
91
92make run CONFIG="-DTEXT_DISABLE=1"
91``` 93```
92 94
93### Performance metrics 95### Performance metrics
diff --git a/src/main.c b/src/main.c
index 32400f9..13a32c7 100644
--- a/src/main.c
+++ b/src/main.c
@@ -86,10 +86,10 @@ main(void) {
86 video_init(); 86 video_init();
87 87
88 // Initialize text engine. 88 // Initialize text engine.
89// #ifdef TEXT_ENABLE 89#ifndef TEXT_DISABLE
90 txt_init(1, TEXT_LAYER); 90 txt_init(1, TEXT_LAYER);
91 txt_position(0,0); 91 txt_position(0,0);
92// #endif 92#endif
93 93
94 // Initialize UXN. 94 // Initialize UXN.
95 init_uxn(); 95 init_uxn();