mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2024-11-22 10:39:20 +01:00
62 lines
1.8 KiB
Markdown
62 lines
1.8 KiB
Markdown
# N64FlashcartMenu
|
|
**This repo and its documentation is currently experimental and subject to change without notice.**
|
|
|
|
## Aims
|
|
* Support as many flashcarts as possible
|
|
* Be open source using preferably MIT licensed third party licenced libraries where possible.
|
|
* Be testable, where possible using CTest, but if not, in an emulated environment.
|
|
* Encourage active development from community members and flashcart owners.
|
|
|
|
## Basic usage
|
|
|
|
### SC64
|
|
Download the `sc64menu.n64` ROM from the latest action run assets.
|
|
Add it to the root folder on your SD card.
|
|
|
|
Create a file called `config.sc64.toml.txt`
|
|
Add the following content, replacing the comments.
|
|
```
|
|
[last_rom]
|
|
rom_path = "<!-- path to your ROM from the root of your SD card, note the quotes -->"
|
|
save_path = "<!-- path to a save file from the root of your SD card, note the quotes -->"
|
|
save_type = <!-- a number representing the save type (see save types) -->
|
|
auto_load = <!-- a boolean value of `true` or `false` -->
|
|
save_writeback = false
|
|
|
|
[last_state]
|
|
auto_load_last_rom = false
|
|
current_directory = "sd://"
|
|
|
|
[boot_params]
|
|
device_type = 0;
|
|
reset_type = 1;
|
|
detect_tv_type = true;
|
|
detect_cic_seed = true;
|
|
```
|
|
Save it to the root folder on your SD card.
|
|
|
|
#### Save types
|
|
`0` = NONE
|
|
`1` = EEPROM_4K
|
|
`2` = EEPROM_16K
|
|
`3` = SRAM
|
|
`4` = SRAM_BANKED
|
|
`5` = SRAM_128K
|
|
`6` = FLASHRAM
|
|
|
|
|
|
### ED64
|
|
Not Currently not suppported, but there is an aim to do so.
|
|
This will likely replace AltraOSv1
|
|
|
|
|
|
# Developer documentation
|
|
**Work in progress!**
|
|
|
|
You can use a dev container in VSCode.
|
|
|
|
`ms-vscode.makefile-tools` will help (installed automatically in dev container).
|
|
TODO: it does not yet work with `F5`: see https://devblogs.microsoft.com/cppblog/now-announcing-makefile-support-in-visual-studio-code/
|
|
WORKAROUND: in the terminal, use make directly `make all`
|
|
|