Guide-WiiU/docs/aroma/getting-started.md
lifehackerhansol c018ceefa8
VitePress migration (#237)
* Remove docsify.js files

* treewide: Remove obsolete pages and files

- These are no longer used, no longer recommended, and no longer have a
  reason to stay in the guide.
- Of note are the vWii contents, which now live in wii.hacks.guide.

* translations: drop all languages

The migration will break all of them, so it's best to let it get
regenerated by Crowdin.

This also deletes leftover files that don't exist in the main guide.

* Initialize VitePress

- Add theme submodule
- Add initial configuration files
- Override theme-default VPFooter with custom theme version

* docs: port to VitePress

* config: add sidebar/navbar and initial translation support

* config: add footer

* workflow: add VitePress build steps

* crowdin: move to VitePress

* config: add favicon

* config: add GitHub link to navbar

* config: add Discord invite to navbar

* LICENSE: update for VitePress

While the docs are licensed under ISC, the theme is licensed under
MIT. Explicitly specify this.

* Add dependabot configs for npm

* config: add support for `default` keyword in tabs

Specifying `tab default` will allow defaulting to this tab on page
load.

* docs: conditionally enable the prev/next buttons

These only make sense in the Aroma pages; the rest aren't chronological
paths.

* homepage: add custom homepage hero implementation

This retires the old logo, and brings in Plailect's old Wii U guide
image.
2024-09-27 17:13:25 -05:00

2.3 KiB

next
true

Aroma

Aroma is a work-in-progress environment and the successor to 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, a new way of launching homebrews, and many built-in modules and plugins (i.e. Region Free patches).

What can I do with Aroma?

For a detailed overview check out this blogpost. A quick summary is given below.

Modules

Aroma supports modules which, unlike setup modules, always run in the background.
This allows for 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(i.e. RetroArch), 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. This doesn't necessarily mean Aroma is unstable, but there is a chance that you may experience something not working properly.