Skip to content

Commit

Permalink
Rework main page and starting guide path (#127)
Browse files Browse the repository at this point in the history
Check PR for additional information

* Trim the entire "sections" portion, since it varies based on pathing

* Remove "guide has just been published" notice and make the read notice more concise

* Add homebrew free warning to the top of main page

* Revise and significantly trim the index page, add a "Key Information" page as preliminary to actual guide

* Minor index edits

* Create the Key Information page and add a Network FAQ

* Add disclaimer about Wii U internet settings

* minor edit

* Drop the scam disclaimer on the main page

* Modify sidebar and navbar according to new edits

Navbar no longer has "Get Started", now has "Site Navigation" and "Extras" dropdown

* Rename wiimmfi page to nintendowfc and update hyperlinks in-case of new service addition

* Miscellaneous updates

Add additional note to wii mini
Link to SD card format instructions on Key Information
Note that 2TB cards do exist on faq

* Mass changes to vitepress files to change "wiimmfi" to "nintendowfc"

* Correct dead link preventing build in nintendowfc.md

* add additional wording in FAQ to make it more clear that access points are APs

* no NFTS for USB devices

* Merge lines to remove reference to HackMii installer and instead emphasize homebrew channel

* Miscellaneous additional changes to key-information

* Set FAQ to have parity with Key Information for Network

* further minor changes

* Additional clarifications and additions to storage/power guidelines

* Bump copyright date to 2025
  • Loading branch information
grunt22fox authored Jan 12, 2025
1 parent f0c3d23 commit f4851d5
Show file tree
Hide file tree
Showing 9 changed files with 224 additions and 82 deletions.
111 changes: 86 additions & 25 deletions docs/.vitepress/i18n/en_US.js

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/.vitepress/i18n/strings/en_US.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"returnToTopLabel": "Return to top",

"guide": "Guide",
"extras": "Extras",
"other": "Other",
"pages": {
"bootmii": "BootMii Backup",
Expand All @@ -31,6 +32,7 @@
"hbc": "Homebrew Channel and BootMii Installation",
"hbc-mini": "Homebrew Channel - for Wii mini only",
"homebrew-dolphin": "Homebrew Channel - Dolphin Emulator",
"key-information": "Key Information",
"legacy-exploits": "Legacy Exploits",
"letterbomb": "LetterBomb",
"modmii": "ModMii",
Expand All @@ -51,7 +53,7 @@
"vwii-homebrew-channel-no-wiiu-mods": "Installing the Homebrew Channel",
"wiiconnect24": "WiiConnect24",
"wiigsc": "Creating Wii Game Shortcuts",
"wiimmfi": "Wiimmfi",
"nintendowfc": "Nintendo Wi-Fi Connection",
"wii-backups": "Managing Wii Backups",
"wii-loaders": "Wii Backup Loaders",
"wii-factory-reset": "Restoring the Wii NAND to Stock",
Expand Down
2 changes: 1 addition & 1 deletion docs/bricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Preventing a brick involves many rules that range between common sense and fail-
+ **Do NOT restore NAND backups from other consoles!**
+ **Do NOT install any IOS that isn't meant for your system** (example: Wii IOS on Wii mini)
+ **Do NOT attempt region changing methods meant for Wii on the vWii or Wii mini**
+ **Do NOT use a Nintendo Wi-Fi Connection service unless it is known to be RCE patched (such as [Wiimmfi](wiimmfi)). Doing otherwise could allow a malicious actor to BRICK your Console!**
+ **Do NOT use a Nintendo Wi-Fi Connection service unless it is known to be RCE patched (such as [Wiimmfi](nintendowfc)). Doing otherwise could allow a malicious actor to BRICK your Console!**
+ **Only install updates for your own region!**.
+ Installing updates from another region could have no effect at best, but result in a [Korean Kii/Error 003](bricks#koreankii-error-003-brick) brick at worst. To prevent this from happening if you bought a pre-owned Wii, run [SysCheck](syscheck) to verify the original region of your console. If it is Korean, be EXTREMELY careful with applying system updates to your console, and consider seeking support for further assistance.
+ **Do NOT delete or modify system files, install old versions of your Wii Menu or IOS, and do NOT install any system file mods unless you know what you are doing!**
Expand Down
29 changes: 27 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ When considering buying or using an SD card or USB device, it is worth consideri

::: danger

SD cards 2TB or larger currently do not exist, anyone attempting to sell you one is trying to rip you off.
SD cards larger than 2TB currently do not exist, anyone attempting to sell you one is trying to rip you off.

:::

Expand All @@ -108,7 +108,11 @@ Recommended brands:

When buying USB hard drives, there are only three existing present-day HDD manufacturers: Western Digital, Seagate, and Toshiba. Any and all other hard drive companies are defunct and have either went bankrupt, or were absorbed by the three aformentioned companies. With that said, if you have an extra hard drive lying around made by another company, it should still work! Hard drive technology has remained largely the same within the past 10 or so years. Just make sure to check the S.M.A.R.T data to ensure that the drive isn't failing before you throw all of your data on there.

For hard drive sizing, 2.5 inch should work fine running off of USB power alone on a Wii; 3.5 inch consumes much more power and will almost always need an external power adapter. Make sure to plan for this when determining what you want to do with an external drive.
For hard drive sizing, 2.5 inch drives should work fine in most cases running off of USB power alone on a Wii, but 3.5 inch consumes more power and will always need an external power adapter. Make sure to plan for this when determining what you want to do with an external drive.

For Wii U users, it is highly recommended to have a hard drive that takes external power, or to use a powered USB hub and/or Y cable for 2.5 inch drives.

For Wii mini users, it is recommended to have an externally powered USB hub in order to have external storage, internet adapters, and other peripherals connected simultaneously. You may also want to use a Y cable for drive power.

As for your choices in shopping, this largely comes down to three different scenarios:

Expand All @@ -123,3 +127,24 @@ As for your choices in shopping, this largely comes down to three different scen
For the purpose of using a drive with a Wii, external SSDs are often more expensive than conventional hard drives for no visible gain in speed on a Wii (the console only supports up to USB 2.0 data speeds). If you would like to buy one or already have one lying around, it's an option, but generally it's recommended to just go for a hard drive if you don't already have one.

:::

## Networking FAQ

The Wii's wireless networking hardware supports the maximum standard of 802.11g on the 2.4 GHz band (retroactively named WiFi 3), with a maximum security level of WPA2-PSK (AES). Therefore, the Wii will NOT be able to connect to the following access points (APs):

+ APs enforcing WPA enterprise encryption, or WPA3 only
+ APs not backwards compatible with WiFi 3, or broadcasting only on the 5 GHz band

ISPs known to provide routers incompatible with these settings:

+ Xfinity
+ Spectrum
+ Cox

If your ISP will not let you change these settings, or your current networking hardware is not supported, you have a few options:

+ You can try to use a cellular hotspot. This is not recommended as it usually results in an unstable connection.
+ You can use a LAN adapter. It must have the `ASIX AX88772` chipset or say “compatible with Wii”. Here is a [recommended LAN adapter by uGreen](https://a.co/d/3OcSJDS).
+ Alternatively, you can buy a secondary router and continue to use the network you already have, like a mesh. Any cheap router meeting the above standards (such as the Linksys WRT54G) will work.

For the Wii U, vWii uses the internet settings set in the Wii U's main settings, but can be optionally separated with the `Wii VC Launch` Aroma plugin.
67 changes: 17 additions & 50 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,69 +10,36 @@ hero:

::: info

Since this guide has just been published, translations are a work-in-progress. Thank you for your patience!

:::

::: warning

To get the most out of this guide, you should read this page before proceeding.
Please thoroughly read the introductory pages before proceeding.

:::

## What is homebrew?

**Homebrew** refers to software that was not authorized by the original creator of a piece of hardware - in this case, Nintendo. In order to gain the ability to run homebrew on the Wii, the console must first be modified to run unsigned code.

Here are some common examples of what homebrew can do for your Wii:

+ [Backup](bootmii) and [restore](bootmiirecover) your Wii's NAND (system memory)
+ Enhance the [brick protection](priiloader) of your Wii
+ Download new homebrew apps with the [Open Shop Channel](osc)
+ [Patch game disc contents](https://wiki.hacks.guide/wiki/Wii:Riivolution) to load game modifications
+ Install [themes](themes) on the Wii Menu and in commonly used homebrew apps
+ Back up your [discs](dump-games) and [other installed titles](dump-wads)
+ Watch [DVDs](recommended-homebrew#entertainment) and play external media files on your Wii
+ Install a [USB loader](wii-loaders) to launch Wii (and other console) backups from an external storage device
+ Restore online functionality to both [WiiConnect24](wiiconnect24) and [Nintendo Wi-Fi Connection](wiimmfi)

## What does the guide install?

This guide aims to do the following, including optional sections:
**Homebrew** refers to software that was not authorized to run on a video game console by its manufacturer. To gain the ability to run homebrew on the Wii, the console must first be modified to run unsigned code.

+ Modify your Wii using one of many exploits, with the end goal of reaching the HackMii installer
+ Install BootMii and the Homebrew Channel
+ Make a backup of critical system files
+ Install Priiloader
+ Install the Open Shop Channel
+ Recommended homebrew to use on your Wii
+ Restore functionality to WiiConnect24 and Nintendo Wi-Fi Connection
Common examples of homebrew usage on the Wii include:

## What should I know before starting?
+ [Backing up](bootmii) and [restoring](bootmiirecover) your Wii's NAND (system memory)
+ [Patching game discs](https://wiki.hacks.guide/wiki/Wii:Riivolution) to load game modifications
+ Installing [themes](themes) on the Wii Menu and in commonly used homebrew apps
+ Backing up your [discs](dump-games) and [other installed titles](dump-wads)
+ Installing a [USB loader](wii-loaders) to launch Wii (and other console) backups from an external storage device
+ Restoring online functionality to both [WiiConnect24](wiiconnect24) and [Nintendo Wi-Fi Connection](nintendowfc)
+ and more!

+ Homebrew is 100% free, and the process of modifying your Wii is also free. Anyone trying to convince you otherwise is likely attempting to [scam you](https://hbc.hackmii.com/scam).
+ This guide works on all system menu versions depending on the exploit, but **it is recommended that you update to 4.3 (the latest firmware)** if possible.
+ **This guide applies to retail/consumer Wiis ONLY!** This means that development units are not covered.
+ Depending on what you intend to do with your modded Wii, you may have to make some modifications to the system memory that have a risk of bricking (rendering the console inoperable). As long as you follow this guide exactly, you should be fine, but for general brick prevention tips see [this](bricks#brick-prevention) page.
+ The differences between the Wii and Wii mini are quite significant. This means that in some cases, something that is normally harmless to the Wii could cause a [severe brick](bricks#wi-fi-brick) to the Wii mini. Tread carefully if you are planning to mod one!
+ Be extremely careful when modifying a [Korean Wii](bricks#koreankii-error-003-brick).
## What does this guide do?

## Ready?
With certain variations depending on the path you take, this guide has the end goal of:

The guide has nine sections in total. These are listed below:
+ Exploiting your Wii and Installing the Homebrew Channel
+ Putting safeguards in place to help prevent bricks
+ Installing other homebrew that can enhance your experience, should you choose

1. Choosing and using an exploit (REQUIRED)
1. Installing the Homebrew Channel and BootMii (REQUIRED)
1. Making a NAND backup with BootMii (REQUIRED)
1. Installing Priiloader (REQUIRED)
1. Installing the Open Shop Channel (RECOMMENDED)
1. Installing cIOS (RECOMMENDED)
1. Discovering Recommended Homebrew (RECOMMENDED)
1. Regaining WiiConnect24 Functionality (OPTIONAL)
1. Regaining Nintendo Wi-Fi Connection Functionality (OPTIONAL)
## Ready to start?

::: tip

Continue to [Get Started](get-started)
Continue to [Key Information](key-information)

:::
87 changes: 87 additions & 0 deletions docs/key-information.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Key Information

This page includes important disclaimers and information regarding the modding process that you should know before starting.

## Bricks and Common Risks

When following the guide or using specific kinds of homebrew, there is a risk that you may brick your console - or put it into a state where it is partially or fully unusable. To prevent this, please follow the guide **exactly as written** and follow precautions when stated. Common risks for bricking are slated as below:

+ Following old modding tutorials or video guides unless explicitly recommended due to outdated or incorrect information
+ Restoring NAND backups from other consoles
+ Installing cIOS packs like DARKCORP
+ Installing updates intended for another region, or region changing your console
+ Modifying system files

Please consult the [bricks guide](bricks) for more information.

## Console Compatibility

This guide works with all off-the-shelf retail Wiis, including the Wii U vWii and Wii mini.
It does **NOT** work with development Wiis, including models:

+ RVT-001 (NDEV)
+ RVT-002 (green frontplate)
+ RVT-005 (red frontplate)

Important notes relating to specific Wiis are below.

:::: details What if I own a Korean Wii?

A Korean Wii is fully supported, and can also be region changed.
Exercise caution when modifying region data and follow guides carefully to avoid a brick.

::::

:::: details What if I own a Wii U (vWii)?

Wii mode on Wii U (called vWii in the homebrew community) is fully supported but it is recommended to setup an Aroma environment.
Missing Wii features can be restored. Almost all existing homebrew is currently supported (except for GameCube homebrew). A USB hub is recommended.
If there are multiple versions of homebrew, make sure you are using the version designed for vWii.
Be especially cautious with IOS to avoid bricking, since they are specifically designed for vWii.

::::

:::: details What if I own a Wii mini?

Wii Mini is supported and has compatibility with the most existing homebrew.
Missing Wii features can be restored. A LAN adapter and USB hub are recommended.
If there are multiple versions of homebrew, make sure you are using the one designed for Wii mini.
Be especially cautious with IOS to avoid bricking, since they are specifically designed for Wii mini.

::::

## Storage Compatibility

For SD cards, you will want a minimum of 128MB to run an exploit. On average, however, you will want a card that is sized 2GB or more. Format instructions are listed [here](https://wiki.hacks.guide/wiki/Formatting_an_SD_card).

For USB devices, you will want to use a USB hard drive or solid state drive formatted as FAT32. We do not recommend using flash drives as they are prone to failure or not working as intended with a Wii.

2.5 inch drives should work fine in most cases running off of USB power alone on a Wii, but 3.5 inch consumes more power and will always need an external power adapter. For Wii U and Wii mini users, you will probably want to use an externally powered USB hub or a Y cable for drives that operate off of USB power alone, due to power draw.

Please consult [the storage FAQ](faq#storage-device-faq) for more information.

## Network Compatibility

The Wii is an aging console, and as such, may have difficulties connecting to modern wireless networks.

Its network hardware is based on 802.11g (retroactively named WiFi 3), which operates on the 2.4 GHz band. It also supports a maximum of WPA2-PSK (AES) personal network encryption. You must make sure your network supports these standards if you would like to use WiFi with your Wii.

For the Wii U, vWii uses the internet settings set in the Wii U's main settings, but can be optionally separated with the `Wii VC Launch` Aroma plugin.

Please consult [the network FAQ](faq#networking-faq) for more information.

## Getting Help

Ran into an issue while following the guide, already have an issue on your modded Wii, or just plain need answers?

+ If your question isn't already answered on this page, it may be answered in the [FAQs](faq) section of the guide.
+ If your question still isn't answered and you need support, join the [Nintendo Homebrew Discord](https://discord.gg/C29hYvh) and go to the `#wii-vwii-assistance` channel.

::: tip

Continue to [Get Started](get-started)

:::



2 changes: 1 addition & 1 deletion docs/wiimmfi.md → docs/nintendowfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ If you run into UPnP-related issues (such as the patcher getting stuch at "Init

:::

A method for Wiimmfi patching which runs on retail game discs, but must be manually launched via the Internet Channel (derives from [Flashhax](flashhax)). Due to the nature of this process, it can be ran on Wiis without homebrew. [This](wiimmfi#manual-disc-patching-via-eula-user-agreement) method is generally more reliable, and is recommended instead.
A method for Wiimmfi patching which runs on retail game discs, but must be manually launched via the Internet Channel (derives from [Flashhax](flashhax)). Due to the nature of this process, it can be ran on Wiis without homebrew. [This](nintendowfc#manual-disc-patching-via-eula-user-agreement) method is generally more reliable, and is recommended instead.

### Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/site-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
::: info

**Wii Online Services**
+ [Nintendo Wi-Fi Connection](wiimmfi)
+ [Nintendo Wi-Fi Connection](nintendowfc)
+ [Setting RTC Time](wiiconnect24#updating-rtc-clock)
+ [WiiConnect24](wiiconnect24)

Expand Down
2 changes: 1 addition & 1 deletion docs/wiiconnect24.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Some Priiloader hacks need to be enabled on the vWii and the Wii mini so the Wii

::: tip

[Proceed to Nintendo Wi-Fi Connection](wiimmfi)
[Proceed to Nintendo Wi-Fi Connection](nintendowfc)

This guide takes the process of regaining online functionality to your Wii a step further - by allowing the Nintendo Wi-Fi Connection services to function yet again on certain games like Mario Kart Wii. While there are different private servers and services that allow this, the one covered here will be Wiimmfi.

Expand Down

0 comments on commit f4851d5

Please sign in to comment.