tools.nes/README.md, branch main

Add the runrom crate and the vnf library

2026-08-17T21:06:23Z

The vnf library supports the runrom crate and they both combined enable users to "run" a ROM file. This is basically an emulator, but with two key differences: 1. It is to be run programatically. That is, you are not expected to play games with this, but to run code by steps, start at a given address, run a function, etc. 2. It is headless: there are no graphics displayed on screen, nor sound being delivered. Thus, the target for both these things are developers, not players. This way developers can validate code paths without needing a full blown emulator. You can write tests with this and be able to run some checks as part of your testing infrastructure. Signed-off-by: Miquel Sabaté Solà

readrom: implement the -d/--disassemble option

2026-07-15T20:11:50Z

This option can also be coupled with -n/--nasm-directory, and you can then get a human-readable disassembling of any proc or label you might be thinking on. Signed-off-by: Miquel Sabaté Solà

Move and expand the README on nasm

2025-09-04T05:56:44Z

Signed-off-by: Miquel Sabaté Solà

Add a configuration for MMC1

2025-01-23T15:16:11Z

Signed-off-by: Miquel Sabaté Solà

Introduce xa65

2025-01-10T15:35:12Z

This is a bridge between 'nasm' and 'cl65'. That is, it runs the same command on both 'nasm' and 'cl65', compares the resulting binaries, and gives back the binary from 'cl65'. Signed-off-by: Miquel Sabaté Solà

Rename to tools.nes

2024-12-25T21:13:13Z

Let's continue with the good ol' tradition of being terrible at naming things. I have also renamed another project which was referenced here, so update all references as well. Signed-off-by: Miquel Sabaté Solà

nasm: Allow file paths for the configuration

2024-12-22T22:33:33Z

This opens up the door for developers to pass their own configuration files. Signed-off-by: Miquel Sabaté Solà

Dual license the source code under this repository

2024-12-20T15:09:05Z

This means that the source code under `crates/` is under the GNU GPLv3 (or any later version), and that source code under `lib/` is under the GNU LGPLv3 (or any later version). In practice this relaxes a bit the previous licensing because before it was all GNU GPLv3 (or any later version). For people compiling a binary with these libraries then this would've been spilling over the GPLv3 on their binaries as well, which might not be desired. Instead, for the libraries abide by the LGPLv3 (or any later version), which has the same guarantees when it comes to free/lliure software for this specific case, but at least we don't force the GPLv3 (or any later version) onto users. That being said, users of these libraries still need to provide object files so third parties could theoretically recompile those binaries under a modified library. Signed-off-by: Miquel Sabaté Solà

Improve documentation on nasm

2024-12-18T08:38:04Z

Signed-off-by: Miquel Sabaté Solà

Add the readrom binary

2024-12-18T06:46:26Z

The readrom binary is similar to `readelf` from Linux and it will allow to display information from an NES/Famicom ROM file. For now the information being shown is just the header, but in the future we might also include disassembling parts of the code, or retrieving the "CHARS" section for a given ROM file, and similar. In order to implement the header parsing part a new library has been introduced, simply named "header" which abstracts everything away so you just need to call `Header::try_from("my bytes")` to fetch the actual information. Signed-off-by: Miquel Sabaté Solà