Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SC64] SD Card layout clarification #127

Closed
Tom-Neverwinter opened this issue Jul 25, 2024 · 4 comments
Closed

[SC64] SD Card layout clarification #127

Tom-Neverwinter opened this issue Jul 25, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@Tom-Neverwinter
Copy link

Tom-Neverwinter commented Jul 25, 2024

Description

slight changes to documentation for clarification as per our discussion on discord and based on this code:

https://discord.com/channels/205520502922543113/1262536014623146125/1266132477274095676

Yes, well, if they conform to the load routine: https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/1e70188edede66824d9973a381b03cc6414082bc/src/menu/cart_load.c#L155C1-L183C6
│
├── sc64menu.n64
│
│
├── menu\
│   ├── config.ini
│   │
│   ├── boxart\
│   │   ├── GE.png
│   │   ├── NGE.png
│   │   └── (other box art images)
│   │
│   ├── 64ddipl\
│   │    ├── NDDE0.n64
│   │    ├── NDDJ2.n64
│   │    └── NDXJ0.n64
│   │    
│   └── emulators
│        ├── neon64bu.rom
│        ├── sodium64.z64
│        ├── gb.v64
│        └── gbc.v64
│
├── (a rom).z64
├── (a rom).n64
└── saves\
├── roms\
        ├── (Some N64 ROM files)\
        └── saves\
    ├── (Some N64 ROM files)\
        └── saves\
    └── (64DD disk images)
Emulator Support

The menu supports several legacy emulators developed in the early days of N64 homebrew. While these emulators may have some limitations, they generally work to a reasonable extent.

Supported emulators are stored in the /emulators folder:
- NES: neon64bu.rom
- SNES: sodium64.z64
- Game Boy: gb.v64
- Game Boy Color: gbc.v64

To use these emulators, simply place the corresponding ROM file in the /emulators folder. The menu will automatically detect and load the appropriate emulator when you select a compatible ROM.

Note: These emulators are provided for compatibility with older homebrew projects and may not offer the same level of accuracy or feature set as more modern emulators.```

please make changes if you dont like my suggestion :)  
![image1](https://github.com/user-attachments/assets/ef47e24f-948e-4b36-a2a8-cff27c7f9847)
![image](https://github.com/user-attachments/assets/c437ffd8-f978-4674-9795-58f99d35979f)


### How to solve the problem

_No response_

### Describe alternatives you've considered

add directory of file locations. emulators make certain file locations important

### Additional context

_No response_

edit: formatting is hard
@networkfusion
Copy link
Collaborator

│   ├── neon64bu.rom
│   ├── sodium64.z64
│   ├── gb.v64
│   └── gbc.v64

These should be in the menu dir.

Any saves are local to the directory used to load the ROM (with default settings).
e.g.

├── roms\
    ├── (N64 ROM files)\
        ├── saves\
    ├── (64DD disk images)

(64DD should not have saves as the images are saveable)

@networkfusion
Copy link
Collaborator

└── (64DD IPL files, if not in root 64ddipl folder)
should be:
└── (64DD IPL files)

@networkfusion
Copy link
Collaborator

├── cache\ should not be there, as created automatically.

│   ├── sodium64.z64
│   ├── gb.v64
│   └── gbc.v64

should be in the menu\emulators dir.

@networkfusion networkfusion added the documentation Improvements or additions to documentation label Jul 25, 2024
@networkfusion networkfusion changed the title [feature request] slight documentation clarification [SC64] SD Card layout clarification Jul 25, 2024
@networkfusion networkfusion mentioned this issue Aug 1, 2024
10 tasks
networkfusion added a commit that referenced this issue Aug 4, 2024
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
Split documentation into chunks that users can understand.
Improve them to be more idiot proof!

## Motivation and Context
<!--- What does this sample do? What problem does it solve? -->
<!--- If it fixes/closes/resolves an open issue, please link to the
issue here -->
Allows an easier way to point people towards specific documentation.
#127 
#76 

## How Has This Been Tested?
<!-- (if applicable) -->
<!--- Please describe in detail how you tested your sample/changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots
<!-- (if appropriate): -->

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Improvement (non-breaking change that adds a new feature)
- [ ] Bug fix (fixes an issue)
- [ ] Breaking change (breaking change)
- [x] Documentation Improvement
- [ ] Config and build (change in the configuration and build system,
has no impact on code or features)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

<!--- It would be nice if you could sign off your contribution by
replacing the name with your GitHub user name and GitHub email contact.
-->
Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL>
@networkfusion
Copy link
Collaborator

Closing as added to docs with #128

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants