forked from Polprzewodnikowy/N64FlashcartMenu
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into add-rom-patcher
- Loading branch information
Showing
50 changed files
with
1,158 additions
and
706 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,9 @@ on: | |
| jobs: | ||
| build-menu: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| packages: write | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
@@ -68,21 +71,31 @@ jobs: | |
| name: SC64 | ||
| path: ./output/sc64menu.n64 | ||
|
|
||
| # - name: Delete rolling-release tag and release | ||
| # uses: dev-drprasad/[email protected] | ||
| # if: github.ref == 'refs/heads/main' | ||
| # with: | ||
| # github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| # tag_name: rolling-release | ||
| # continue-on-error: true | ||
|
|
||
| - name: Upload rolling release | ||
| uses: softprops/action-gh-release@v2 | ||
| if: github.ref == 'refs/heads/main' | ||
| with: | ||
| name: Rolling release | ||
| body: Rolling release built from latest commit on `main` branch. | ||
| tag_name: rolling-release | ||
| tag_name: 'rolling_release' | ||
| make_latest: true | ||
| files: | | ||
| ./output/N64FlashcartMenu.n64 | ||
| ./output/menu.bin | ||
| # ./output/OS64.v64 | ||
| # ./output/OS64P.v64 | ||
| ./output/sc64menu.n64 | ||
| continue-on-error: true | ||
|
|
||
| - name: Upload dev rolling release | ||
| uses: softprops/action-gh-release@v2 | ||
| if: github.ref == 'refs/heads/develop' | ||
| with: | ||
| name: 'Rolling pre-release' | ||
| body: Experimental pre-release built from latest commit on `develop` branch. | ||
| target_commitish: develop | ||
| tag_name: 'rolling_pre-release' | ||
| prerelease: true | ||
| files: | | ||
| ./output/N64FlashcartMenu.n64 | ||
| ./output/menu.bin | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| ## First time setup of SD card | ||
|
|
||
| Using your PC, insert the SD card and ensure it is formatted for compatibility with your flashcart (*FAT32 and EXFAT are fully supported on the SC64*). | ||
|
|
||
| - Download the latest `sc64menu.n64` (assuming you are using an *sc64*) file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card. | ||
| - Create a folder in the root of your SD card called `menu`. | ||
| - Place your ROMs on the SD Card, in any folder (**except for `menu`**). | ||
|
|
||
|
|
||
| ### Emulator support | ||
| Emulators should be added to the `/menu/emulators` directory on the SD card. | ||
|
|
||
| Menu currently supports the following emulators and associated ROM file names: | ||
| - **NES**: [neon64v2](https://github.com/hcs64/neon64v2/releases) by *hcs64* - `neon64bu.rom` | ||
| - **SNES**: [sodium64](https://github.com/Hydr8gon/sodium64/releases) by *Hydr8gon* - `sodium64.z64` | ||
| - **Game Boy** / **GB Color**: [gb64](https://lambertjamesd.github.io/gb64/romwrapper/romwrapper.html) by *lambertjamesd* - `gb.v64` / `gbc.v64` ("Download Emulator" button) | ||
|
|
||
|
|
||
| ### 64DD disk support | ||
| For the ability to load and run 64DD disk images, you need to place the required 64DD IPL dumps in the `/menu/64ddipl` folder on the SD card. | ||
| For more details, follow [this guide on the 64dd.org website](https://64dd.org/tutorial_sc64.html). | ||
|
|
||
|
|
||
| #### So what would the layout of the SD Card look like? | ||
| ```plaintext | ||
| SD:\ | ||
| │ | ||
| ├── sc64menu.n64 | ||
| │ | ||
| │ | ||
| ├── menu\ | ||
| │ │ | ||
| │ │ | ||
| │ ├── 64ddipl\ | ||
| │ │ ├── NDDE0.n64 | ||
| │ │ ├── NDDJ2.n64 | ||
| │ │ └── NDXJ0.n64 | ||
| │ │ | ||
| │ └── emulators | ||
| │ ├── neon64bu.rom | ||
| │ ├── sodium64.z64 | ||
| │ ├── gb.v64 | ||
| │ └── gbc.v64 | ||
| │ | ||
| ├── (a rom).z64 | ||
| ├── (a rom).n64 | ||
| ├── (some folder with roms)\ | ||
| │ └── (some folder with roms)\ | ||
| | └── (Some supported ROM files) | ||
| │ | ||
| ├── (Some supported ROM files) | ||
| | | ||
| └── (Some folder with 64DD disk images)\ | ||
| └── (Some 64DD disk images) | ||
| ``` | ||
|
|
||
|
|
||
| ## Save Files | ||
| All save files (whether `FlashRam`, `SRAM` or `EEPROM`) use the `.sav` extension and match the filename of a ROM. | ||
|
|
||
| Each save file can be found in the `/saves` folder located in the **same directory** as the ROM and shares the same file name, apart from the extension. | ||
| These files are created and modified when a "game" saves. | ||
|
|
||
| ```plaintext | ||
| ├── (some folder with roms)\ | ||
| ├── a_rom.z64 | ||
| ├── b_rom.n64 | ||
| └── saves\ | ||
| ├── a_rom.sav | ||
| └── b_rom.sav | ||
| ``` | ||
|
|
||
| ### Transfering saves from an ED64 | ||
| If transferring a file from a different flashcart, such as the ED64, it will be necessary to change the extension of the file to `sav`. | ||
|
|
||
| i.e. for `Glover (USA).eep` you would need to change the extension to `Glover (USA).sav` | ||
|
|
||
| You may also need to pad/trim the files to their original size: | ||
| - For EEPROM 4Kbit games, remove the padding. | ||
| - For others, use a tool such as Ninjiteu's N64 Save converter. | ||
|
|
||
| **NOTE:** certain emulator saves or saves created for a different ROM version or region may be incompatible. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## Menu Controls | ||
|
|
||
| ### Fast scroll | ||
| Use the C-Up and C-Down buttons | ||
|
|
||
|
|
||
| ### DD ROMs | ||
|
|
||
| #### Expansion Disks | ||
| To load an expansion disk (e.g. F-Zero X) browse to the N64 ROM and load it (but not start it) and then browse to the DD expansion file and press the `R` button. | ||
|
|
||
| #### Disk swapping | ||
| This feature is not currently available in the menu. | ||
|
|
Oops, something went wrong.