Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DenSinH authored Jul 12, 2020
1 parent 4d08257 commit a6d0f0c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 10,14 @@ Running `main.py` will prompt you with a question for how many tests you want, y

After this, the script will finish running and make a `main.gba` file in the same folder, or overwrite the file with that name if it exists.

### Requirements:
### ROM generation requirements:
The only libraries I used are `random`, `numpy` and `subprocess`. I think these are all builtin in Python (though I'm not sure about `numpy`).

### ROM running requirements:
If you are building an emulator, I wrote this so that it can be ran from the very early stages of emulation. It uses rendering mode 4 to diplay the results, so you will need that. Other than that, I do _not_ use any SWIs/DMAs/Timers/IRQs/Weird IO registers (Only `DISPCNT`) and `KEYINPUT`. You should be fine having most the basic instructions implemented, I use conditional operations, branches, arithmetic operations, and PSR transfers, but that should be about it.

I think these ROMs should be very useful for debugging purposes, as they do not have any timing requirements, as mentioned above. If the ROM doesn't run _at all_ on your emulator, you should be able to copmare logs with established emulators like mGBA or Nanoboy Advance (though mGBA does not always pass apparently, VBA doesn't either).

### Output:
If you pass all tests, the ROM will display "End of testing" right away.
If you fail any test, the ROM will hang on that test, and display the following things:
Expand Down

0 comments on commit a6d0f0c

Please sign in to comment.