Skip to content

Commit aec59eb

Browse files
networkfusionnetworkfusion
committed
Better docs
1 parent 74c1de2 commit aec59eb

File tree

4 files changed

+181
-185
lines changed

4 files changed

+181
-185
lines changed

‎docfx.json‎

Lines changed: 10 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,33 @@
11
{
2-
"metadata": [
3-
{
4-
"src": [
5-
{
6-
"files": [
7-
"output/**.n64",
8-
"output/**.bin",
9-
"output/**.v64",
10-
"build/**.elf",
11-
"build/**.map"
12-
],
13-
"exclude": [
14-
"**/obj/**",
15-
"_site/**",
16-
"**/Tests/**",
17-
"**/Test/**",
18-
"Test**/**",
19-
"**/**.Test*",
20-
"**/*.Test*",
21-
"**/**.Test",
22-
"**/*.Test",
23-
"**/**.Test.*",
24-
"**/*.Test.*",
25-
"**/*Test/**"
26-
]
27-
}
28-
],
29-
"dest": "api",
30-
"disableGitFeatures": true
31-
}
32-
],
2+
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
333
"build": {
344
"content": [
355
{
366
"files": [
37-
"api/**.yml",
38-
"api/index.md",
39-
"devices/**.yml",
40-
"devices/index.md",
41-
"devicesdetails/**.md",
42-
"devicesdetails/**/**.md",
43-
"devicesdetails/**.yml",
44-
"samplesdetails/**.yml",
45-
"samplesdetails/index.md",
46-
"samplesdetails/**.md",
47-
"devices/**/**.md",
48-
"devices/**.yml",
49-
"x-cross/**.yml"
50-
]
51-
},
52-
{
53-
"files": [
54-
"content/**.md",
55-
"content/**/toc.yml",
56-
"toc.yml",
57-
"*.md"
58-
],
59-
"exclude": [
60-
"obj/**",
61-
"_site/**",
62-
"README.md",
63-
"LICENSE",
64-
"LICENSE-CODE"
65-
]
66-
}
67-
],
68-
"resource": [
69-
{
70-
"files": [
71-
"images/**",
72-
"favicons/**",
73-
"devicesimages/**",
74-
"samplesimages/**"
7+
"**/*.{md,yml}"
758
],
769
"exclude": [
77-
"obj/**",
7810
"_site/**"
7911
]
8012
}
8113
],
82-
"overwrite": [
14+
"resource": [
8315
{
8416
"files": [
85-
"apidoc/**.md"
86-
],
87-
"exclude": [
88-
"obj/**",
89-
"_site/**"
17+
"images/**"
9018
]
9119
}
9220
],
93-
"dest": "_site",
94-
"markdownEngineName": "markdig",
95-
"globalMetadataFiles": [],
96-
"fileMetadataFiles": [],
21+
"output": "_site",
9722
"template": [
9823
"default",
99-
"templates/nano",
100-
"modern",
101-
"templates/material"
24+
"modern"
10225
],
103-
"postProcessors": [ "ExtractSearchIndex" ],
104-
"xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ],
105-
"noLangKeyword": false,
106-
"keepFileLink": false,
107-
"cleanupCacheHistory": false,
108-
"disableGitFeatures": false,
10926
"globalMetadata": {
110-
"_appTitle": "N64 Flashcart Menu Documentation",
27+
"_appName": "N64 Flashcart Menu",
28+
"_appTitle": "N64 Flashcart Menu",
11129
"_enableSearch": true,
112-
"_gitContribute": {
113-
"branch": "pages-source"
114-
},
115-
"_lang": "en"
30+
"pdf": false
11631
}
11732
}
118-
}
33+
}

‎docs/toc.yml‎

Lines changed: 53 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,54 @@
1-
- name: Introduction
2-
href: 00_index.md
3-
1+
- name: Index
2+
href: 00_index.md
43
- name: Getting Started
5-
items:
6-
- name: SD card setup
7-
href: 10_getting_started_sd.md
8-
- name: Updating the menu
9-
href: 80_update_the_menu.md
10-
- name: FAQ
11-
href: 81_faq.md
12-
13-
- name: Basic Menu Usage
14-
items:
15-
- name: Menu controls
16-
href: 11_menu_controls.md
17-
- name: File browser
18-
href: 31_file_browser.md
19-
- name: Menu settings
20-
href: 32_menu_settings.md
21-
- name: RTC settings
22-
href: 33_rtc_settings.md
23-
- name: Menu information
24-
href: 35_menu_information.md
25-
26-
- name: ROMs, Patches & Metadata
27-
items:
28-
- name: ROM configuration
29-
href: 12_rom_configuration.md
30-
- name: ROM patches
31-
href: 14_rom_patches.md
32-
- name: Datel cheats
33-
href: 13_datel_cheats.md
34-
- name: Autoload ROMs
35-
href: 22_autoload_roms.md
36-
- name: Gamepak box art
37-
href: 19_gamepak_boxart.md
38-
39-
- name: Playback & Media
40-
items:
41-
- name: Sound
42-
href: 40_sound.md
43-
- name: MP3 player
44-
href: 41_mp3_player.md
45-
- name: Background images
46-
href: 16_background_images.md
47-
48-
- name: Hardware & Flashcarts
49-
items:
50-
- name: Flashcart information
51-
href: 36_flashcart_information.md
52-
- name: Flashcart Work In Progress
53-
href: 98_flashcart_wip.md
54-
- name: Hardware modifications
55-
href: 62_hardware_mods.md
56-
- name: Controller Paks
57-
href: 15_controller_paks.md
58-
59-
- name: Platform-specific Features
60-
items:
61-
- name: 64DD
62-
href: 17_64dd.md
63-
- name: Emulators
64-
href: 18_emulators.md
65-
66-
- name: Advanced & Experimental
67-
items:
68-
- name: Advanced customization
69-
href: 61_advanced_customization.md
70-
- name: Experimental features
71-
href: 65_experimental.md
72-
73-
- name: Developer
74-
items:
75-
- name: Developer guide
76-
href: 99_developer_guide.md
77-
4+
href: 10_getting_started_sd.md
5+
- name: Basic Controls
6+
href: 11_menu_controls.md
7+
- name: ROM Configuration
8+
href: 12_rom_configuration.md
9+
- name: Datel Cheats (Gameshark, Action Replay, etc.)
10+
href: 13_datel_cheats.md
11+
- name: ROM Patches (Hacks, Fan Translations, etc.)
12+
href: 14_rom_patches.md
13+
- name: Controller PAKs
14+
href: 15_controller_paks.md
15+
- name: Background Images
16+
href: 16_background_images.md
17+
- name: 64DD
18+
href: 17_64dd.md
19+
- name: Emulators
20+
href: 18_emulators.md
21+
- name: Game Art Images
22+
href: 19_gamepak_boxart.md
23+
- name: Autoloading N64 ROMs
24+
href: 22_autoload_roms.md
25+
- name: Sounds
26+
href: 40_sound.md
27+
- name: File Browser
28+
href: 31_file_browser.md
29+
- name: Menu Settings
30+
href: 32_menu_settings.md
31+
- name: Date-Time (RTC) Settings
32+
href: 33_rtc_settings.md)
33+
- name: Menu Information
34+
href: 35_menu_information.md
35+
- name: Flashcart Information
36+
href: 36_flashcart_information.md
37+
- name: N64 Information
38+
href: 37_n64_information.md
39+
- name: MP3 Player
40+
href: 41_mp3_player.md
41+
- name: Advanced Customization
42+
href: 61_advanced_customization.md
43+
- name: N64 Hardware Modifications Compatibility
44+
href: 62_hardware_mods.md
45+
- name: Update the menu
46+
href: 80_update_the_menu.md
47+
- name: FAQ
48+
href: 81_faq.md
49+
- name: Experimental Features
50+
href: 65_experimental.md
51+
- name: Developer Guide
52+
href: 99_developer_guide.md
53+
- name: Contributing
54+
href: https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/main/CONTRIBUTING.md

‎index.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
_layout: landing
3+
---
4+
5+
![Build](https://github.com/polprzewodnikowy/N64FlashcartMenu/actions/workflows/build.yml/badge.svg)
6+
![GitHub Org's stars](https://img.shields.io/github/stars/Polprzewodnikowy/N64FlashcartMenu)
7+
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/Polprzewodnikowy/N64FlashcartMenu.svg)](http://isitmaintained.com/project/Polprzewodnikowy/N64FlashcartMenu "Average time to resolve an issue")
8+
[![Percentage of issues still open](http://isitmaintained.com/badge/open/Polprzewodnikowy/N64FlashcartMenu.svg)](http://isitmaintained.com/project/Polprzewodnikowy/N64FlashcartMenu "Percentage of issues still open")
9+
[![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/main/CONTRIBUTING.md)
10+
11+
# N64 Flashcart Menu
12+
An open source menu for N64 flashcarts that aims to support as many as possible.
13+
This menu is not affiliated with any particular flashcart and does not necessarily expose all possible firmware features.
14+
15+
> [!TIP]
16+
> Help sponsor development [NetworkFusion on Ko-Fi](https://ko-fi.com/networkfusion). Or submit your Pull Request.
17+
18+
> [!TIP]
19+
> New users are invited to read the latest [Documentation / User Guide](./docs/00_index.md).
20+
21+
## Flashcart Support
22+
This menu aims to support as many N64 flashcarts as possible.
23+
The current state of support is:
24+
25+
### Supported
26+
* SummerCart64
27+
* 64Drive
28+
29+
### Work in Progress
30+
* EverDrive-64 (X and V series)
31+
* ED64P (clones)
32+
33+
### Not yet planned
34+
* Doctor V64
35+
* PicoCart
36+
* DaisyDrive
37+
38+
39+
## Current (notable) menu features
40+
* Fully Open Source.
41+
* Loads all known N64 games, even if they are byteswapped.
42+
* Fully emulates the 64DD and loads 64DD disks (SummerCart64 only).
43+
* Emulator support (NES, SNES, GB, GBC, SMS, GG, CHF) ROMs.
44+
* N64 ROM box art image support.
45+
* Background image (PNG) support.
46+
* Comprehensive ROM save database (including homebrew headers).
47+
* Comprehensive ROM information display.
48+
* Real Time Clock support.
49+
* Music playback (MP3).
50+
* Menu sound effects.
51+
* N64 ROM fast reboot option (on reset).
52+
* ROM history and favorites.
53+
54+
Experimental (beta):
55+
* ROM Datel code editor.
56+
* Zip archive browsing and file extraction.
57+
* Controller Pak backup and restore (including individual notes).
58+
* Game art image switching.
59+
60+
61+
## Aims
62+
* Support as many N64 Flashcarts as possible.
63+
* Be open source, using permissively licensed third-party libraries.
64+
* Be testable in an emulated environment (Ares).
65+
* Encourage active development from community members and N64 FlashCart owners.
66+
* Support as many common mods and features as possible (flashcart dependent).
67+
68+
69+
## Flashcart specific information
70+
71+
### SummerCart64
72+
Download the latest `sc64menu.n64` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
73+
74+
> [!TIP]
75+
> A quick video tutorial can be found here:
76+
>
77+
> [![Video tutorial](https://img.youtube.com/vi/IGX0XXf0wgo/default.jpg)](https://www.youtube.com/shorts/IGX0XXf0wgo)
78+
79+
80+
### 64drive
81+
* Ensure the cart has the latest [firmware](https://64drive.retroactive.be/support.php) installed.
82+
* Download the latest `menu.bin` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
83+
84+
85+
# Contributors
86+
The features in this project were made possible by the [contributors](https://github.com/Polprzewodnikowy/N64FlashcartMenu/graphs/contributors).
87+
88+
# License
89+
This project is released under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE.md) as compatible with all other dependent project licenses.
90+
Other license options may be available upon request with permissions of the original `N64FlashcartMenu` project authors / maintainers.
91+
* [Mateusz Faderewski / Polprzewodnikowy](https://github.com/Polprzewodnikowy)
92+
* [Robin Jones / NetworkFusion](https://github.com/networkfusion)
93+
94+
# Open source software and licenses used
95+
## Libraries
96+
* [libdragon](https://github.com/DragonMinded/libdragon/tree/preview) - [UNLICENSE License](https://github.com/DragonMinded/libdragon/blob/preview/LICENSE.md)
97+
* [libspng](https://github.com/randy408/libspng) - [BSD 2-Clause License](https://github.com/randy408/libspng/blob/master/LICENSE)
98+
* [mini.c](https://github.com/univrsal/mini.c) - [BSD 2-Clause License](https://github.com/univrsal/mini.c?tab=BSD-2-Clause-1-ov-file#readme)
99+
* [minimp3](https://github.com/lieff/minimp3) - [CC0 1.0 Universal](https://github.com/lieff/minimp3/blob/master/LICENSE)
100+
* [miniz](https://github.com/richgel999/miniz) - [MIT License](https://github.com/richgel999/miniz/blob/master/LICENSE)
101+
102+
## Sounds
103+
See [License](https://pixabay.com/en/service/license-summary/) for the following sounds:
104+
* [Cursor sound](https://pixabay.com/en/sound-effects/click-buttons-ui-menu-sounds-effects-button-7-203601/) by Skyscraper_seven (Free to use)
105+
* [Actions (Enter, Back) sound](https://pixabay.com/en/sound-effects/menu-button-user-interface-pack-190041/) by Liecio (Free to use)
106+
* [Error sound](https://pixabay.com/en/sound-effects/error-call-to-attention-129258/) by Universfield (Free to use)
107+
108+
## Emulators
109+
* [neon64v2](https://github.com/hcs64/neon64v2) by *hcs64* - [ISC License](https://github.com/hcs64/neon64v2/blob/master/LICENSE.txt)
110+
* [sodium64](https://github.com/Hydr8gon/sodium64) by *Hydr8gon* - [GPL-3.0 License](https://github.com/Hydr8gon/sodium64/blob/master/LICENSE)
111+
* [gb64](https://github.com/lambertjamesd/gb64) by *lambertjamesd* - [MIT License](https://github.com/lambertjamesd/gb64/blob/master/LICENSE)
112+
* [smsPlus64](https://github.com/fhoedemakers/smsplus64) by *fhoedmakers* - [GPL-3.0 License](https://github.com/fhoedemakers/smsplus64/blob/main/LICENSE)
113+
* [Press-F-Ultra](https://github.com/celerizer/Press-F-Ultra) by *celerizer* - [MIT License](https://github.com/celerizer/Press-F-Ultra/blob/master/LICENSE)
114+
115+
## Fonts
116+
* [Firple](https://github.com/negset/Firple) by *negset* - (SIL Open Font License 1.1)

‎toc.yml‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,2 @@
1-
# - name: Documentation
2-
# href: docs/00_index.md
3-
# - name: Preview Documentation
4-
# href: preview-docs/index.md
5-
# topicHref: preview-docs/index.md
6-
# - name: SRC Reference
7-
# href: ./src/
8-
# topicHref: src/index.md
9-
- name: Contributing
10-
href: ./CONTRIBUTING.md
11-
- name: GitHub
12-
href: https://www.github.com/Polprzewodnikowy/N64FlashcartMenu
13-
# - name: Discord
14-
# href:
1+
- name: Docs
2+
href: docs/

0 commit comments

Comments
 (0)