Skip to content

Make Markdown styling consistent across entire guide, establish specific Markdown styling rules #183

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.

Sign up for GitHub

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

Draft
grunt22fox wants to merge 12 commits into
base: master
Choose a base branch
from
Draft

Make Markdown styling consistent across entire guide, establish specific Markdown styling rules #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6fb883b
Major overhaul to vWii guide
grunt22fox Feb 1, 2026
0b7b532
Change spacers to <hr> tags
grunt22fox Feb 1, 2026
87e2490
Remove loose quote in table
grunt22fox Feb 1, 2026
040f7fe
Miscellaneous heavy guide changes
grunt22fox Feb 2, 2026
9d74dbd
Various grammatical corrections
grunt22fox Feb 2, 2026
01329c0
Initial markdown review, add markdownlint.json
grunt22fox Feb 2, 2026
86aea66
Fix unintentional change to .gitignore
grunt22fox Feb 2, 2026
34339c2
Update cios table
grunt22fox Feb 2, 2026
703c6ed
Update README to include styling guidelines
grunt22fox Feb 2, 2026
3fba9fe
Update README.md with shields, add flags to langs
grunt22fox Feb 3, 2026
d0497d6
Merge remote-tracking branch 'upstream/master' into markdown-style-fixes
grunt22fox Feb 3, 2026
bf3f9da
Fix regressions from latest commits
grunt22fox Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .markdownlint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"MD003": { "style": "atx" },
"MD004": { "style": "asterisk"},
"MD007": { "indent": 4 },
"MD013": false,
"MD024": { "siblings_only": true },
"MD029": { "style": "one" },
"MD033": { "allowed_elements": ["br"], "table_allowed_elements": ["hr", "br", "ul", "li"]},
"MD035": { "style": "---" },
"MD040": false,
"MD045": false,
"MD046": { "style": "fenced" },
"MD048": { "style": "backtick" },
"MD049": { "style": "asterisk" },
"MD050": { "style": "asterisk" },
"MD055": { "style": "leading_and_trailing" },
"MD060": { "style": "aligned" }
}
56 changes: 53 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@

The complete guide to modding your Wii, vWii, and Wii mini.

https://wii.hacks.guide/
[![Website Badge](https://img.shields.io/badge/website-wii.hacks.guide-21ABDE?logo=vitepress&logoColor=FFFFFF)](https://wii.hacks.guide/)
[![Translation Badge](https://img.shields.io/badge/translation-contribute-263238?logo=crowdin&logoColor=FFFFFF)](https://hacks-guide.crowdin.com/u/projects/12)
[![Discord Server](https://img.shields.io/badge/chat-nintendo%20homebrew-7289DA?logo=discord&logoColor=FFFFFF)](https://discord.gg/C29hYvh)
[![Last Commit Badge](https://img.shields.io/github/last-commit/hacks-guide/Guide_Wii)](https://github.com/hacks-guide/Guide_Wii/commits/master/)
![Language Count](https://img.shields.io/badge/languages-3-brightgreen)
[![MIT License](https://img.shields.io/badge/license-MIT-A31F34)](https://github.com/hacks-guide/Guide_Wii/blob/master/LICENSE.txt)

## Running the site locally

This requires the following installed on your system:
- node.js

* node.js

To test the website locally, clone the source code:

Expand All @@ -23,4 +29,48 @@ npm ci
npm run docs:dev
```

The website should now be running on http://127.0.0.1:5173/ (or a port shown on the terminal).
The website should now be running on <http://127.0.0.1:5173/> (or a port shown on the terminal).

If you choose to run multiple web servers at once, they will begin running at the next highest usable port (e.g. :5174, :5175, and so on).

## Markdown Styling

When making contributions to the guide, it is optimal to be aware of the project's preferred Markdown formatting, so that documentation formatting can be consistent.

### Headings

* ATX style `#` headings should be used.
* The same heading name can only be repeatedly used on headings with different parents.

### Unordered Lists

* Unordered lists should be created with the asterisk symbol `*` for consistency.
* Unordered lists should be indented with four spaces, or a single press of `TAB` in an accordingly configured code editor.

### Ordered Lists

* Ordered lists should be created using the number one `1.` for consistency.

### HTML Elements

* The HTML elements `<hr>`, `<br>`, `<ul>`, and `<li>`, can only be used in GitHub style tables.
* The HTML element `<br>` can only be used outside of GitHub style tables as a workaround for line breaks after headings.

### Horizontal Rules

* Horizontal rules should only be created using triple hyphens `---`.

### Code Blocks

* Code blocks should only be created in a fenced style.
* Code blocks should be created with the backtick symbol ` ``` `.

### Text Formatting

* Emphasis should be specified with the asterisk symbol `*`.
* Boldness, or strong, should be specified with the asterisk symbol `**`.

### Tables

* Tables should be created with leading and trailing pipes.
* Tables should be constructed in an aligned style whenever possible.
45 changes: 44 additions & 1 deletion docs/.vitepress/i18n/en_US.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,49 @@ const themeConfig = {
},
sidebar_common
],
[`/hackmii`]: [
{
text: localeData.guide,
items: [
{ text: localeData.pages["key-information"], link:`/key-information` },
{ text: localeData.pages["get-started"], link: `/get-started` },
{ text: localeData.pages["hackmii"], link: `/hackmii` },
{ text: localeData.pages["hbc"], link: `/hbc` },
{ text: localeData.pages["bootmii"], link: `/bootmii` },
{ text: localeData.pages["priiloader"], link: `/priiloader` },
{ text: localeData.pages["cios"], link: `/cios` },
{ text: localeData.pages["osc"], link: `/osc` },
{ text: localeData.pages["recommended-homebrew"], link: `/recommended-homebrew` },
{ text: localeData.pages["wiiconnect24"], link: `/wiiconnect24` },
{ text: localeData.pages["nintendowfc"], link: `/nintendowfc` }
]
},
sidebar_common
],
[`/hbc`]: [
{
text: localeData.guide,
items: [
{ text: localeData.pages["key-information"], link:`/key-information` },
{ text: localeData.pages["get-started"], link: `/get-started` },
{ text: localeData.pages["multiple-options"] },
{ text: localeData.pages["hbc"], link: `/hbc` },
{ text: localeData.pages["multiple-options"] },
]
},
sidebar_common
],
[`/homebrew-dolphin`]: [
{
text: localeData.guide,
items: [
{ text: localeData.pages["key-information"], link:`/key-information` },
{ text: localeData.pages["get-started"], link: `/get-started` },
{ text: localeData.pages["homebrew-dolphin"], link: `/homebrew-dolphin` },
]
},
sidebar_common
],
[`/key-information`]: [
{
text: localeData.guide,
Expand Down Expand Up @@ -616,7 +659,7 @@ const themeConfig = {

export default {
lang: "en",
label: "English",
label: "🇺🇸 English",
title: localeData.title,
description: localeData.description,
themeConfig: themeConfig
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/i18n/hu_HU.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ const themeConfig = {

export default {
lang: "hu",
label: "Magyar",
label: "🇭🇺 Magyar",
title: localeData.title,
description: localeData.description,
themeConfig: themeConfig
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/i18n/ko_KR.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ const themeConfig = {

export default {
lang: "ko",
label: "한국어",
label: "🇰🇷 한국어",
title: localeData.title,
description: localeData.description,
themeConfig: themeConfig
Expand Down
21 changes: 10 additions & 11 deletions docs/backups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ If you already have games on your drive and TinyWiiBackupManager prompts you to
![](/images/desktop-apps/TWBM/twbm-win-empty.png)

1. Click the :heavy_plus_sign: button on the top right of the app to add one or more games.
+ Click the :file_folder: button to add games from a specific directory.
+ You may also drag and drop games from your file manager to add them.
+ If a transfer is already in progress when adding new games, they will be added to a queue.
* Click the :file_folder: button to add games from a specific directory.
* You may also drag and drop games from your file manager to add them.
* If a transfer is already in progress when adding new games, they will be added to a queue.

![](/images/desktop-apps/TWBM/twbm-win-games.png)

Expand Down Expand Up @@ -163,9 +163,9 @@ If you already have games on your drive and TinyWiiBackupManager prompts you to
![](/images/desktop-apps/TWBM/twbm-mac-empty.png)

1. Click the :heavy_plus_sign: button on the top right of the app to add one or more games.
+ Click the :file_folder: button to add games from a specific directory.
+ You may also drag and drop games from your file manager to add them.
+ If a transfer is already in progress when adding new games, they will be added to a queue.
* Click the :file_folder: button to add games from a specific directory.
* You may also drag and drop games from your file manager to add them.
* If a transfer is already in progress when adding new games, they will be added to a queue.

![](/images/desktop-apps/TWBM/twbm-mac-games.png)

Expand All @@ -182,7 +182,7 @@ If you already have games on your drive and TinyWiiBackupManager prompts you to
* A PC running Linux which supports AppImage or Flatpak
* A USB drive or SD card
* A dumped Wii/GameCube game disc (any format)
* [TinyWiiBackupManager](https://github.com/mq1/TinyWiiBackupManager/releases/latest)
* [TinyWiiBackupManager](https://github.com/mq1/TinyWiiBackupManager/releases/latest)

#### Instructions

Expand Down Expand Up @@ -211,7 +211,6 @@ TinyWiiBackupManager can be installed from the Flathub repository as a Flatpak,

1. Launch TinyWiiBackupManager.


##### Section II - Copying Games

::: tip
Expand All @@ -226,9 +225,9 @@ If you already have games on your drive and TinyWiiBackupManager prompts you to
![](/images/desktop-apps/TWBM/twbm-linux-empty.png)

1. Click the :heavy_plus_sign: button on the top right of the app to add one or more games.
+ Click the :file_folder: button to add games from a specific directory.
+ You may also drag and drop games from your file manager to add them. Please note that this feature is not currently available on Wayland.
+ If a transfer is already in progress when adding new games, they will be added to a queue.
* Click the :file_folder: button to add games from a specific directory.
* You may also drag and drop games from your file manager to add them. Please note that this feature is not currently available on Wayland.
* If a transfer is already in progress when adding new games, they will be added to a queue.

![](/images/desktop-apps/TWBM/twbm-linux-games.png)

Expand Down
47 changes: 25 additions & 22 deletions docs/bluebomb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,14 @@ Make sure that the console is close to the computer running the exploit, ideally
* A Virtual Machine may work, but it is not recommended due to its complexity in getting Bluetooth passthrough working. If possible, please use a LiveUSB as described below.
* If you have a Raspberry Pi, you can use that instead as it most likely has Linux installed already.
* ARM64 Raspberry Pi's need multiarch enabled with the armhf (32bit) architecture added. The following should work on any debian based OS:

```bash
sudo sudo dpkg --add-architecture armhf
sudo apt update && sudo apt install -y screen:armhf
file /usr/bin/screen # should say ELF 32-bit
screen
```

* Windows Subsystem for Linux or a Chromebook running Linux mode will *not work* as they don't have direct access to the Bluetooth adapter or USB ports.
* If you do not have Linux, [Ubuntu](https://ubuntu.com/download/desktop) is the most user-friendly option and can be ran on computers running Windows or intel based Macs.
* Apple Silicon Macs will not work due to them missing the ARM32 instructions in the hardware.
Expand All @@ -64,24 +66,24 @@ Make sure that the console is close to the computer running the exploit, ideally
* An internal Bluetooth adapter will work.
* If you do not have one, make sure to get one compatible with Linux.
* A USB flash drive [formatted to FAT32/MS-DOS](https://wiki.hacks.guide/wiki/Formatting_an_SD_card)
* This cannot be the same flash drive used for your Linux Machine.
* This cannot be the same flash drive used for your Linux Machine.
* [HackMii Installer v1.2](https://bootmii.org/download/)

### Instructions

1. Copy `boot.elf` from the hackmii_installer_v1.2 `.zip` to the root of your flash drive.
+ (If attempting to fix a brick, you should also copy the homebrew app you wish to use to /apps/)
+ (Even for a Wii mini, bootmini.elf will **not** work, its purpose is entirely different and unrelated. Use boot.elf in all cases).
1. Copy `boot.elf` from the hackmii_installer_v1.2 `.zip` to the root of your flash drive.
* (If attempting to fix a brick, you should also copy the homebrew app you wish to use to /apps/)
* (Even for a Wii mini, bootmini.elf will **not** work, its purpose is entirely different and unrelated. Use boot.elf in all cases).

![](/images/exploits/bluebomb/usb-exploit.png)

1. Reinsert your flash drive into your console.
+ For a Wii mini, the USB port is on the back.
+ For a normal Wii, use the bottom port (or the right port if it's upright).
* For a Wii mini, the USB port is on the back.
* For a normal Wii, use the bottom port (or the right port if it's upright).
1. Power on your console.
1. Go to `Wii Settings`.
1. Take note in the top right corner of the letter next to the system version.
+ This letter corresponds to your system menu region, which you will need to know for the corresponding steps.
* This letter corresponds to your system menu region, which you will need to know for the corresponding steps.

![](/images/wii/SystemMenuVersion.png)

Expand All @@ -101,24 +103,24 @@ Make sure that the console is close to the computer running the exploit, ideally

![](/images/exploits/bluebomb/console-type.png)

+ If you have selected a Wii mini you will be asked to provide your region. This can be determined by the last letter of the Wii Menu version (`U` for **USA** and `E` for **PAL** models).
* If you have selected a Wii mini you will be asked to provide your region. This can be determined by the last letter of the Wii Menu version (`U` for **USA** and `E` for **PAL** models).

![](/images/exploits/bluebomb/wii-mini-options.png)

+ If you have selected a Wii you will be asked to provide your Wii Menu version (what you determined in step 4).
* If you have selected a Wii you will be asked to provide your Wii Menu version (what you determined in step 4).

![](/images/exploits/bluebomb/wii-options.png)

1. Power on your console.
+ **Do not** connect any Wii Remotes.
* **Do not** connect any Wii Remotes.
1. Type `yes` in the script to proceed if you have not already done so, and make sure that `Waiting to accept` is displaying.
1. Press the Sync button repeatedly until the terminal shows `got connection handle`.
+ This could take numerous attempts.
* This could take numerous attempts.

![](/images/exploits/bluebomb/got-connection-handle.png)

1. If the exploit was successful, you should see a similar screen to the below, after which the HackMii installer should load.
+ If you are not planning to use it later, you can now shut down your Linux distro.
* If you are not planning to use it later, you can now shut down your Linux distro.

![](/images/exploits/bluebomb/thanks-fullmetal5.png)

Expand Down Expand Up @@ -166,6 +168,7 @@ Make sure that the microcontroller is close to the computer running the exploit,
:::

### Requirements

* A Raspberry Pi Pico W 1/2 or an ESP32 with BR/EDR (Classic) support.
* A USB flash drive [formatted to FAT32/MS-DOS](https://wiki.hacks.guide/wiki/Formatting_an_SD_card)
* [The HackMii Installer](https://bootmii.org/download/)
Expand All @@ -178,19 +181,19 @@ A normal Raspberry Pi Pico will not work. It MUST be the wireless model. Additio

### Instructions

1. Copy `boot.elf` from the hackmii_installer_v1.2 `.zip` to the root of your flash drive.
+ (If attempting to fix a brick, you should also copy the homebrew app you wish to use to /apps/)
+ (Even for a Wii mini, bootmini.elf will **not** work, its purpose is entirely different and unrelated. Use boot.elf in all cases).
1. Copy `boot.elf` from the hackmii_installer_v1.2 `.zip` to the root of your flash drive.
* (If attempting to fix a brick, you should also copy the homebrew app you wish to use to /apps/)
* (Even for a Wii mini, bootmini.elf will **not** work, its purpose is entirely different and unrelated. Use boot.elf in all cases).

![](/images/exploits/bluebomb/usb-exploit.png)

1. Reinsert your flash drive into your console.
+ For a Wii mini, the USB port is on the back.
+ For a normal Wii, use the bottom port (or the right port if it's upright).
* For a Wii mini, the USB port is on the back.
* For a normal Wii, use the bottom port (or the right port if it's upright).
1. Power on your console.
1. Go to `Wii Settings`.
1. Take note in the top right corner of the letter next to the system version.
+ This letter corresponds to your system menu region, which you will need to know for the corresponding steps.
* This letter corresponds to your system menu region, which you will need to know for the corresponding steps.

![](/images/wii/SystemMenuVersion.png)

Expand All @@ -199,7 +202,7 @@ A normal Raspberry Pi Pico will not work. It MUST be the wireless model. Additio
#### Raspberry Pi Pico W

1. Download the latest [Pre-Compiled Binaries](https://github.com/GaryOderNichts/bluebomb_micro/releases) from the releases page, and extract it to your PC.
+ Select the appropriate binaries for your device. `bluebomb_micro_pico2_w_version` is for the Pico 2 W, while `bluebomb_micro_pico_w_version` is for the Pico 1 W.
* Select the appropriate binaries for your device. `bluebomb_micro_pico2_w_version` is for the Pico 2 W, while `bluebomb_micro_pico_w_version` is for the Pico 1 W.

![](/images/exploits/bluebomb/pico-download.png)

Expand All @@ -209,7 +212,7 @@ A normal Raspberry Pi Pico will not work. It MUST be the wireless model. Additio
![](/images/exploits/bluebomb/pico-drive.png)

1. Unzip the downloaded archive and copy the file which matches your Wii or Wii mini to the drive.
+ If you have a European Wii running version 4.3, you would copy bluebomb_WII_SM4_3E.uf2, or if you have a European Wii Mini, you would copy bluebomb_MINI_SM_PAL.uf2, etc...
* If you have a European Wii running version 4.3, you would copy bluebomb_WII_SM4_3E.uf2, or if you have a European Wii Mini, you would copy bluebomb_MINI_SM_PAL.uf2, etc...

![](/images/exploits/bluebomb/pico-files.png)

Expand All @@ -228,9 +231,9 @@ A normal Raspberry Pi Pico will not work. It MUST be the wireless model. Additio

1. Plug your flashed device back into your PC.
1. Power on your console.
+ **Do not** connect any Wii Remotes.
* **Do not** connect any Wii Remotes.
1. Press the Sync button repeatedly until the Pico W LED begins to rapidly flash, at which point it will start uploading the exploit.
+ This could take numerous attempts.
* This could take numerous attempts.
1. If the exploit was successful, you should see a similar screen to the below, after which the HackMii installer should load.

![](/images/exploits/bluebomb/thanks-fullmetal5.png)
Expand Down
6 changes: 3 additions & 3 deletions docs/bootmii.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you have BootMii installed as boot2, you will need to launch BootMii by resta

::: warning

If the `Launch BootMii` button does not appear in the Homebrew Channel, [re-launch the HackMii Installer](hackmii) and install BootMii.
If the `Launch BootMii` button does not appear in the Homebrew Channel, [re-launch the HackMii Installer](hackmii) and install BootMii.

:::

Expand Down Expand Up @@ -60,12 +60,12 @@ If you have BootMii installed as boot2, you will need to launch BootMii by resta
![](/images/bootmii/BootMii_Backup.png)

1. A NAND backup will start. You can watch the progress on the screen.
+ "Bad Blocks" are normal, and mostly originate from the factory due to NAND binning. Don't worry when you see some on a NAND backup.
* "Bad Blocks" are normal, and mostly originate from the factory due to NAND binning. Don't worry when you see some on a NAND backup.

![](/images/bootmii/BootMii_NAND_Backup.png)

1. After the previous step completes, BootMii will verify the backup. Ideally, all the blocks should be green after the verification process.
+ If you have factory bad blocks with uncorrectable pages, these blocks may fail to verify. As long as all non-bad blocks are successfully verified, this should be fine.
* If you have factory bad blocks with uncorrectable pages, these blocks may fail to verify. As long as all non-bad blocks are successfully verified, this should be fine.

![](/images/bootmii/BootMii_NAND_Backup_Verify.png)

Expand Down
Loading