diff options
author | Bad Diode <bd@badd10de.dev> | 2023-08-30 20:37:17 +0200 |
---|---|---|
committer | Bad Diode <bd@badd10de.dev> | 2023-08-30 20:37:17 +0200 |
commit | 7a02b549a38dadb48c43143ff94c9094abf25555 (patch) | |
tree | 2e7c983449488a2b537cd2b66817bf8f940674c7 /README.md | |
parent | 874ae39b6074da2778b72bcbaf6c7c7ef19aa233 (diff) | |
download | uxngba-7a02b549a38dadb48c43143ff94c9094abf25555.tar.gz uxngba-7a02b549a38dadb48c43143ff94c9094abf25555.zip |
Update README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 16 |
1 files changed, 9 insertions, 7 deletions
@@ -30,11 +30,11 @@ If everything is properly installed, you should be able to run `make` to compile | |||
30 | the program into a `uxngba.gba` rom. If you have `mgba-qt` installed, you can | 30 | the program into a `uxngba.gba` rom. If you have `mgba-qt` installed, you can |
31 | test it with: `make run`. | 31 | test it with: `make run`. |
32 | 32 | ||
33 | To use a specific UXN compiled rom, you can pass it as the `ROM_SRC` make | 33 | To use a specific UXN compiled rom, you can pass it as the `UXN_ROM` make |
34 | parameter: | 34 | parameter: |
35 | 35 | ||
36 | ``` | 36 | ``` |
37 | make run ROM_SRC=roms/noodle.rom | 37 | make run UXN_ROM=roms/noodle.rom |
38 | ``` | 38 | ``` |
39 | 39 | ||
40 | If you have compiled a rom already and want to change it, you probably want to | 40 | If 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 | ||
54 | Uxngba currently supports three different control schemes that can be cycled by | 54 | Uxngba currently supports three different control schemes that can be cycled by |
55 | pressing the SELECT button: `CONTROL_CONTROLLER`, `CONTROL_MOUSE` and | 55 | pressing 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 |
58 | make much use of the controller scheme, and we may want to use the mouse as the | 58 | make much use of the controller scheme, and we may want to use the mouse as the |
59 | default input method. This can be achieved with the following command: | 59 | default input method. This can be achieved with the following command: |
60 | 60 | ||
61 | ``` | 61 | ``` |
62 | make run ROM_SRC=roms/noodle.rom CONFIG="-DCONTROL_METHODS=CONTROL_MOUSE,CONTROL_KEYBOARD" | 62 | make 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 | |||
72 | be selected by setting the `AUDIO_HIFI` or `AUDIO_LOFI` macros: | 72 | be selected by setting the `AUDIO_HIFI` or `AUDIO_LOFI` macros: |
73 | 73 | ||
74 | ``` | 74 | ``` |
75 | make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_HIFI" | 75 | make run UXN_ROM=roms/audio.rom CONFIG="-DAUDIO_HIFI" |
76 | 76 | ||
77 | or | 77 | or |
78 | 78 | ||
79 | make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_LOFI" | 79 | make 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" | |||
84 | When writing text to the screen (for example using the console device) the text | 84 | When writing text to the screen (for example using the console device) the text |
85 | will be drawn by default on the foreground layer. This can be controlled by | 85 | will be drawn by default on the foreground layer. This can be controlled by |
86 | setting the `TEXT_MODE` option to 0 for foreground mode or 1 for background | 86 | setting the `TEXT_MODE` option to 0 for foreground mode or 1 for background |
87 | mode. | 87 | mode. The text layer can be omitted if using the TEXT_DISABLE macro. |
88 | 88 | ||
89 | ``` | 89 | ``` |
90 | make run CONFIG="-DTEXT_MODE=1" | 90 | make run CONFIG="-DTEXT_MODE=1" |
91 | |||
92 | make run CONFIG="-DTEXT_DISABLE=1" | ||
91 | ``` | 93 | ``` |
92 | 94 | ||
93 | ### Performance metrics | 95 | ### Performance metrics |