Add initial Aroma guide (#159)
* Initial aroma changes * Disable responsive tables * Adjust SD prep messagepull/162/head
GaryOderNichts
1 year ago
committed by
GitHub
parent
8953ec6805
commit
ed58dbe15f
@ -0,0 +1,46 @@
|
||||
# Aroma {docsify-ignore-all}
|
||||
|
||||
## Finalizing Setup
|
||||
|
||||
Now that Aroma is on your SD Card, we need to set up some final things.
|
||||
|
||||
### Booting into Aroma
|
||||
|
||||
1. Take the SD Card out of your computer and plug it into your Wii U console.
|
||||
1. Start the EnvironmentLoader.
|
||||
- If you're autobooting into Tiramisu, this can be done by powering on your console and holding `X`.
|
||||
1. Highlight the entry called `aroma` using the D-Pad.
|
||||
- To make the console autoboot Aroma press `Y`.
|
||||
1. Launch Aroma by pressing `A`.
|
||||
- If you get a red warning screen telling you that updates aren't blocked properly, you might want to block updates by following [this guide](../block-updates).
|
||||
1. On the Boot Selector, the `Wii U Menu` should already be selected, press Y to set this to your default autobooting option, then press A to launch into the Wii U Menu.
|
||||
- To open the Boot Selector in the future, you have hold START (+) while launching Aroma.
|
||||
|
||||
You are now running Aroma. Any apps you have on your SD Card will show up on the Wii U menu.
|
||||
|
||||
?> **Aroma does not support the Homebrew Launcher**
|
||||
Launch apps from the Wii U menu using the `homebrew_on_menu` plugin.
|
||||
|
||||
You can now open the Plugin Configuration Menu using `L + Down + SELECT (-)` on the GamePad or Pro Controller (or `B + Down + Minus (-)` for WiiMotes).
|
||||
|
||||
### Installing apps, modules, and plugins
|
||||
|
||||
Base-Aroma already comes with several useful plugins and modules.
|
||||
You can also install additional Aroma compatible apps, modules and plugins. Below is a list with various recommendations.
|
||||
|
||||
| Name | Description | Installation Instructions |
|
||||
| ---- | ----------- | ------------ |
|
||||
| [FTPiiU Plugin](https://github.com/wiiu-env/ftpiiu_plugin/) ([Download](https://github.com/wiiu-env/ftpiiu_plugin/releases)) | Runs a FTP server in the background. | 1. Extract the downloaded `ftpiiu_vX_X.zip` file. <br> 2. Copy the `ftpiiu.wps` to the `wiiu/environments/aroma/plugins` folder on the root of your SD Card. |
|
||||
| [SDCafiine](https://github.com/wiiu-env/sdcafiine_plugin/) ([Download](https://github.com/wiiu-env/sdcafiine_plugin/releases)) | Allows you to mod games by redirecting files to the SD card. | 1. Extract the downloaded `sdcafiine_vX_X_X.zip` file. <br> 2. Copy the `sdcafiine.wps` to the `wiiu/environments/aroma/plugins` folder on the root of your SD Card. |
|
||||
| [Bloopair](https://github.com/GaryOderNichts/Bloopair/) ([Download](https://github.com/GaryOderNichts/Bloopair/releases)) | Allows wirelessly connecting most popular Bluetooth capable controllers. | 1. Extract the contents of the newly downloaded `Bloopair_vX.X.X.zip` file. <br> 2. Copy the `30_bloopair.rpx` to the `wiiu/environments/aroma/modules/setup/` folder on the root of your SD Card. <br> 3. Copy the `wiiu` folder to the root of your SD Card. |
|
||||
|
||||
### Booting into Tiramisu
|
||||
|
||||
If you find the need to boot into Tiramisu, for example, due to a homebrew app not supported by Aroma, simply do the following:
|
||||
|
||||
1. Take the SD Card out of your computer and plug it into your Wii U console.
|
||||
1. Start the EnvironmentLoader.
|
||||
- If you're autobooting into it, this can be done by powering on your console and holding `X`.
|
||||
1. Highlight the entry called `tiramisu` using the D-Pad.
|
||||
- To make the console autoboot Tiramisu press `Y`.
|
||||
1. Launch Tiramisu by pressing `A`.
|
||||
@ -0,0 +1,50 @@
|
||||
# Aroma {docsify-ignore-all}
|
||||
|
||||
Aroma is a work-in-progress environment and a possible successor for Tiramisu.
|
||||
|
||||
!> **Aroma is currently in beta and still experimental!**
|
||||
Expect potential issues and make sure to report them, if you encounter any.
|
||||
If you still want to proceed, make sure to fully read this page.
|
||||
|
||||
?> This guide will not remove Tiramisu. After following this guide you can still choose to boot into Tiramisu.
|
||||
|
||||
### What is Aroma?
|
||||
|
||||
Aroma is an environment like Tiramisu, which can be booted through the Environment Loader.
|
||||
Aroma, just like Tiramisu, uses the same Mocha version, support for setup modules, and comes with the Autoboot Module, which includes the boot selector and Quick Start support.
|
||||
Aroma comes with several additional features, including a plugin system and a new way of launching homebrews.
|
||||
|
||||
### What can I do with Aroma?
|
||||
|
||||
For a detailed overview check out [this blogpost](https://maschell.github.io/homebrew/2022/09/05/aroma.html). A quick summary is given below.
|
||||
|
||||
#### Modules
|
||||
|
||||
Aroma supports modules, which unlike setup modules, always run in the background.
|
||||
This allows further extending the functionality of the console.
|
||||
|
||||
#### Plugins
|
||||
|
||||
Plugins, similarly to modules, are also running in the background.
|
||||
They can enhance the experience of the console by changing and providing additional features.
|
||||
Plugins can be configured using a configuration menu, which can be opened using a button combination.
|
||||
|
||||
#### Wii U Homebrew Bundles
|
||||
|
||||
Wii U Homebrew Bundles (WUHB) are a new way of launching homebrew.
|
||||
These `.wuhb` files contain the main executable and can directly include icon and banner images and additional content.
|
||||
With the `homebrew_on_menu` plugin, WUHB files can be directly launched from the Wii U menu, just like official channels.
|
||||
|
||||
### What are the limitations?
|
||||
|
||||
Due to technical limitations, a lot of old homebrew applications will no longer work with Aroma.
|
||||
This includes all `.elf` homebrews, but also some `.rpx` homebrews, which don't implement necessary functionality properly.
|
||||
These homebrews need to be updated with support for Aroma. To run old homebrews you need to boot the Tiramisu environment.
|
||||
Launching homebrews through the now outdated Homebrew Launcher is no longer possible with Aroma.
|
||||
|
||||
Besides the limitations mentioned above, note that Aroma is still a beta release. Not everything has been tested yet, and additional issues might be discovered.
|
||||
|
||||
### Getting started
|
||||
|
||||
Before continuing to the next page, make sure to install the PayloadLoader.
|
||||
This can be done by following the [Tiramisu guide](../tiramisu/sd-preparation).
|
||||
@ -0,0 +1,24 @@
|
||||
# Aroma {docsify-ignore-all}
|
||||
|
||||
## SD Preparation
|
||||
|
||||
We will now place the required Aroma files on the SD Card.
|
||||
|
||||
?> **Notice**
|
||||
Your SD Card will need to be formatted as FAT32. If your SD Card is not formatted to FAT32, use [GUIFormat](http://ridgecrop.co.uk/index.htm?guiformat.htm) with 32k (32768) allocation unit size to format it.
|
||||
**Do not** label the SD Card as `wiiu` or it will cause issues with homebrew.
|
||||
|
||||
### What You Need
|
||||
|
||||
- The latest files from the [Aroma download page](https://aroma.foryour.cafe).
|
||||
1. Scroll down to the **Download** section.
|
||||
1. Read through the steps and click on the checkboxes.
|
||||
1. Click on `Download Payloads` and `Download Base Aroma`.
|
||||
|
||||
### Instructions
|
||||
|
||||
1. Insert your Wii U's SD Card into your PC.
|
||||
1. **Extract** and copy the `wiiu` folder of the two newly downloaded *`.zip`* files to the root of your SD Card.
|
||||
- The two `wiiu` folders should be merged if not done automatically.
|
||||
|
||||
?> If your computer asks you to overwrite existing files on your SD Card, you will need to click yes.
|
||||
@ -0,0 +1,11 @@
|
||||
- **Aroma**
|
||||
- [Home Page](../introduction)
|
||||
- [Getting Started with Aroma](getting-started)
|
||||
- [SD Preparation](sd-preparation)
|
||||
- [Finalizing Setup](finalizing-setup)
|
||||
- **Links**
|
||||
- [GitHub](https://github.com/hacks-guide/Guide-WiiU)
|
||||
- [Discord](https://discord.gg/C29hYvh)
|
||||
- [Translate](https://hacks-guide.crowdin.com/u/projects/10)
|
||||
- [Donate](../donations)
|
||||
- [About](../about)
|
||||
Loading…
Reference in New Issue