From 7a02b549a38dadb48c43143ff94c9094abf25555 Mon Sep 17 00:00:00 2001 From: Bad Diode Date: Wed, 30 Aug 2023 20:37:17 +0200 Subject: Update README --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'README.md') 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 the program into a `uxngba.gba` rom. If you have `mgba-qt` installed, you can test it with: `make run`. -To use a specific UXN compiled rom, you can pass it as the `ROM_SRC` make +To use a specific UXN compiled rom, you can pass it as the `UXN_ROM` make parameter: ``` -make run ROM_SRC=roms/noodle.rom +make run UXN_ROM=roms/noodle.rom ``` 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. ### Input method order Uxngba currently supports three different control schemes that can be cycled by -pressing the SELECT button: `CONTROL_CONTROLLER`, `CONTROL_MOUSE` and +pressing the L or R buttons: `CONTROL_CONTROLLER`, `CONTROL_MOUSE` and `CONTROL_KEYBOARD`. To select the order and available methods set the `CONTROL_METHODS` macro on compile time. For example, [noodle][noodle] doesn't make much use of the controller scheme, and we may want to use the mouse as the default input method. This can be achieved with the following command: ``` -make run ROM_SRC=roms/noodle.rom CONFIG="-DCONTROL_METHODS=CONTROL_MOUSE,CONTROL_KEYBOARD" +make run UXN_ROM=roms/noodle.rom CONFIG="-DCONTROL_METHODS=CONTROL_MOUSE,CONTROL_KEYBOARD" ``` ### Audio quality @@ -72,11 +72,11 @@ a good quality-performance compromise. A high quality and low-fi audio modes can be selected by setting the `AUDIO_HIFI` or `AUDIO_LOFI` macros: ``` -make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_HIFI" +make run UXN_ROM=roms/audio.rom CONFIG="-DAUDIO_HIFI" or -make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_LOFI" +make run UXN_ROM=roms/audio.rom CONFIG="-DAUDIO_LOFI" ``` ### Text layer @@ -84,10 +84,12 @@ make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_LOFI" When writing text to the screen (for example using the console device) the text will be drawn by default on the foreground layer. This can be controlled by setting the `TEXT_MODE` option to 0 for foreground mode or 1 for background -mode. +mode. The text layer can be omitted if using the TEXT_DISABLE macro. ``` make run CONFIG="-DTEXT_MODE=1" + +make run CONFIG="-DTEXT_DISABLE=1" ``` ### Performance metrics -- cgit v1.2.1