diff options
| author | Miquel Sabaté Solà <mssola@mssola.com> | 2026-08-24 16:18:27 +0200 |
|---|---|---|
| committer | Miquel Sabaté Solà <mssola@mssola.com> | 2026-08-24 16:18:27 +0200 |
| commit | e6c41303c2da5afd230570cb5610905ade71fecf (patch) | |
| tree | 70a1bc3fa3b14e3b2ea042148a55c461fafc25df /crates/runrom/README.md | |
| parent | 86006af348be75412fdc3dfb5a037b89a01122e8 (diff) | |
| download | tools.nes-e6c41303c2da5afd230570cb5610905ade71fecf.tar.gz tools.nes-e6c41303c2da5afd230570cb5610905ade71fecf.zip | |
runrom: add the --until-address option
This allows the user to run execution until a given address is
reached. This can, like with the --start option, be coupled with the
--nasm option in order to be able to provide an identifier instead of a
regular hexadecimal value.
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
Diffstat (limited to 'crates/runrom/README.md')
| -rw-r--r-- | crates/runrom/README.md | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/crates/runrom/README.md b/crates/runrom/README.md index 9bd5070..86ac11f 100644 --- a/crates/runrom/README.md +++ b/crates/runrom/README.md @@ -36,7 +36,9 @@ You can run a ROM file by simply: $ runrom <your-game-path>/game.nes ``` -This will display all of the instructions being run. +This will display all of the instructions being run. Moreover, you can also pass +the `-d/--dump-memory` option, which will display a summary of memory addresses +which have been updated along execution, and some statistics about them. ### From where should the VM start? @@ -49,7 +51,7 @@ more details on [nasm's README file](../nasm/README.md)), which is then used to translate the given identifier with the actual address. So: ``` -$ runrom --start my-function --nasm <path-to-nasm-directory> game.nes +$ runrom --start my-function --nasm <path to .nasm/> game.nes ``` ### When should the VM end? @@ -59,8 +61,12 @@ the `-f/--function` option, which tells `runrom` that the address is just a function and, whenever a top-level `rts`/`rti` instruction is found, then execution should be halted. -### Other features +Otherwise, you can also pass the `--until-address` option. This option follows +the same format as `-s/--start` and it accepts an address (again, either in +hexadecimal form or with an identifier). With this, `runrom` will run until the +given address is met. This way, you can expect something like this to work just +fine: -Moreover, you may also find interesting the `-d/--dump-memory` option, which -will display a summary of memory addresses which have been updated along -execution, and some statistics about them. +``` +$ runrom --start init-loop --until-address end-loop --nasm <path to .nasm/> game.nes +``` |
