Skip to content

Commit f1d3f71

Browse files
committed
Improve docs for compatibility between release and pre-release.
1 parent e435b2d commit f1d3f71

File tree

5 files changed

+18
-13
lines changed

5 files changed

+18
-13
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
[![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/main/CONTRIBUTING.md)
66

77
# N64 Flashcart Menu
8-
An open source menu for N64 flashcarts that aims to support as many as possible. This menu is not affiliated with any particular flashcart and does not necessarily expose all possible firmware features.
8+
An open source menu for N64 flashcarts that aims to support as many as possible.
9+
This menu is not affiliated with any particular flashcart and does not necessarily expose all possible firmware features.
910

1011
> [!TIP]
1112
> New users are invited to read the latest [Documentation / User Guide](./docs/00_index.md).
@@ -14,7 +15,8 @@ An open source menu for N64 flashcarts that aims to support as many as possible.
1415
> **This project considers flashcart sellers that ship this menu together with copyrighted ROMs as part of their product offering to be licence offenders which may result in future action.**
1516
1617
## Flashcart Support
17-
This menu aims to support as many N64 flashcarts as possible. The current state of support is:
18+
This menu aims to support as many N64 flashcarts as possible.
19+
The current state of support is:
1820

1921
### Supported
2022
* SummerCart64
@@ -91,12 +93,14 @@ The aim is to reach feature parity with [Altra64](https://github.com/networkfusi
9193

9294
* Download the `OS64P.v64` ROM from the latest [PR action run - assets] and place it in the `/ED64P` folder.
9395

96+
# Contributors
97+
This menu is only made possible by the [contributors)](https://github.com/Polprzewodnikowy/N64FlashcartMenu/graphs/contributors)
9498

9599
# License
96100
This project is released under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE.md) as compatible with all other dependent project licenses.
97101
Other license options may be available upon request with permissions of the original `N64FlashcartMenu` project authors / maintainers.
98-
* Mateusz Faderewski / Polprzewodnikowy
99-
* Robin Jones / NetworkFusion
102+
* [Mateusz Faderewski / Polprzewodnikowy](https://github.com/Polprzewodnikowy)
103+
* [Robin Jones / NetworkFusion](https://github.com/networkfusion)
100104

101105
# Open source software and licenses used
102106
## Libraries

docs/13_datel_cheats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Cheats (Gameshark, etc.)
33

44
> [!WARNING]
5-
> **THIS FEATURE IS EXPERIMENTAL**
5+
> **THIS FEATURE IS EXPERIMENTAL (PRE-RELEASE ONLY)**
66
77
The N64FlashcartMenu has underlying support for the cheat code types made popular by the peripherals:
88
- GameShark

docs/15_controller_paks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
## Controller Paks
33

44
> [!WARNING]
5-
> **THIS FEATURE IS EXPERIMENTAL**
5+
> **THIS FEATURE IS EXPERIMENTAL (PRE-RELEASE ONLY)**
66
77
The N64FlashcartMenu has a Controller Pak Manager.
88

9-
> [!WARNING]
9+
> [!CAUTION]
1010
> Mileage may vary when hot swapping paks without exiting and re-entering the screen (and may contain incorrect content), and/or re-powering the console.
1111
1212
Features:

docs/19_gamepak_boxart.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
To use N64 game boxart images, place your PNG files within the `sd:/menu/metadata/` folder.
44

55
> [!WARNING]
6-
> Game Boxart is now stored in `sd:/menu/metadata/`, rather than the previous `sd:/menu/boxart/` folder, please update your folder name and structure/content to ensure compatibility.
6+
> ** PRE-RELEASE ONLY**
7+
Game Boxart is now stored in `sd:/menu/metadata/`, rather than the previous `sd:/menu/boxart/` folder, please update your folder name and structure/content to ensure compatibility.
78

89
#### Supported images
910
Files must be in `PNG` format and use the following dimensions:
@@ -12,11 +13,11 @@ Files must be in `PNG` format and use the following dimensions:
1213
* 64DD boxart sprites: 129x112
1314

1415
Images will be loaded by directories using each character (case-sensitive) of the full 4-character Game Code (as identified in the menu ROM information):
15-
i.e. for GoldenEye NTSC USA (NGEE), this would be `sd:/menu/metadata/N/G/E/E/boxart_front.png`.
16-
i.e. for GoldenEye PAL (NGEP), this would be `sd:/menu/metadata/N/G/E/P/boxart_front.png`.
16+
i.e. for GoldenEye NTSC USA (NGEE), this would be `sd:/menu/boxart/N/G/E/E/boxart_front.png`.
17+
i.e. for GoldenEye PAL (NGEP), this would be `sd:/menu/boxart/N/G/E/P/boxart_front.png`.
1718

1819
To improve compatibility between regions (as a fallback), you may exclude the region ID (last matched directory) for GamePaks to match with 3-character IDs instead:
19-
i.e. for GoldenEye, this would be `sd:/menu/metadata/N/G/E/boxart_front.png`.
20+
i.e. for GoldenEye, this would be `sd:/menu/boxart/N/G/E/boxart_front.png`.
2021

2122
ROMs that use the ["Advanced Homebrew ROM Header"](https://n64brew.dev/wiki/ROM_Header) Game ID (`xEDx`) are matched using the "Game Title" (not the Game Code):
2223
e.g. `sd:/menu/metadata/homebrew/{game title}/boxart_front.png`

docs/31_file_browser.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The File Browser allows you to navigate and manage files on your N64 flashcart.
99
- **File information**: View detailed information about each file, including size and date modified.
1010
- **Load files**: Load files from the file system.
1111
- **Extract files (Pre-release only)**: Extract files from ZIP archives.
12-
- **Switching tabs (Pre-release only)**: Switch between the file browser, favorites and history tabs.
12+
- **Switching tabs**: Switch between the file browser, favorites and history tabs.
1313

1414
### Usage Instructions
1515
<!-- Maybe all the Control pages could be merged into this section? -->
@@ -25,7 +25,7 @@ The File Browser allows you to navigate and manage files on your N64 flashcart.
2525
3. **Viewing Settings menu**:
2626
- Press the `Z` Button to display the menu.
2727

28-
4. **Switching tabs (Pre-release only)**:
28+
4. **Switching tabs**:
2929
- Press the `C-Right` and `C-Left` Buttons to switch between the file browser, favorites and history tabs.
3030

3131
5. **Extract files (Pre-release only)**:

0 commit comments

Comments
 (0)