Skip to content

Commit e71cbee

Browse files
Gatto-yshGatto-ysh
committed
add faq
minor adjustments to themiify.md used consistent admonitions for troubleshooting add specific troubleshooting steps directly to the pages that use them
1 parent ce64405 commit e71cbee

8 files changed

Lines changed: 242 additions & 120 deletions

File tree

‎docs/credits/index.md‎

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
--------------
44

5-
**Theme Café Docs Maintainers**
5+
**Theme Café Docs**
66

77
<div class="grid cards" markdown>
88

@@ -18,7 +18,7 @@ dewgong64
1818

1919
</div>
2020

21-
**Wii U App Developers**
21+
**Wii U Homebrew Devs**
2222

2323
<div class="grid cards" markdown>
2424

@@ -32,26 +32,14 @@ Nathaniel
3232
Alpha Craft
3333
///
3434

35-
</div>
36-
37-
**Plugin Developers**
38-
39-
<div class="grid cards" markdown>
40-
4135
![Image title](Daniel.webp){ width="200" }
4236
/// caption
4337
DanielKO
44-
/// caption
45-
System Font Replacer
46-
///
4738
///
4839

4940
![Image title](juanen.webp){ width="200" }
5041
/// caption
5142
Juanen
52-
/// caption
53-
StyleMiiU Plugin
54-
///
5543
///
5644

5745
</div>
@@ -68,15 +56,12 @@ Migush
6856
![Image title](perro.webp){ width="200" }
6957
/// caption
7058
Perrohuevo
71-
/// caption
72-
Theme Café Owner
73-
///
7459
///
7560

76-
- [wiki.hacks.guide](https://wiki.hacks.guide/wiki/Wii_U:Custom_themes) for some of the information in this page
61+
- [wiki.hacks.guide](https://wiki.hacks.guide/wiki/Wii_U:Custom_themes) for some of the information in this page.
7762

78-
- [Marcrobledo](https://www.marcrobledo.com/) for [RomPatcher.js](https://www.marcrobledo.com/RomPatcher.js/)
63+
- [Marcrobledo](https://www.marcrobledo.com/) for [RomPatcher.js](https://www.marcrobledo.com/RomPatcher.js/).
7964

80-
- [Themezer](https://themezer.net/) for hosting Wii U Themes
65+
- [Themezer](https://themezer.net/).
8166

8267
Theme Café Docs was built with [Zensical](https://zensical.org/)

‎docs/faq.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
search:
3+
exclude: true
4+
---
5+
6+
# FAQ
7+
8+
## Getting Started
9+
10+
### What do I need to start?
11+
12+
- A modded Wii U with the Aroma Environment.
13+
- If you have not modded your Wii U follow the [Wii U Homebrew Guide](https://wiiu.hacks.guide/).
14+
- [StyleMiiU-Plugin](https://github.com/Themiify-hb/StyleMiiU-Plugin) to load your custom themes.
15+
- Copy `stylemiiu.wps` to `SD:/wiiu/environments/aroma/plugins`.
16+
- The latest release of [Themiify](https://github.com/Themiify-hb/Themiify/releases).
17+
- Copy the `Themiify.wuhb` to `SD:/wiiu/apps`.
18+
19+
Start Themiify, download any theme you like and enjoy!
20+
21+
--------------
22+
23+
### Does Themiify modify my Wii U System Files?
24+
25+
No! Themiify works by loading themes from `SD:/wiiu/themes` with [StyleMiiU-Plugin](https://github.com/Themiify-hb/StyleMiiU-Plugin).
26+
27+
--------------
28+
29+
### My Wii U is EUR, can I use themes normally?
30+
31+
Yes! Keep in mind that european consoles have more language packs built onto the menu meaning the file size on themes needs to be smaller to work properly. This is more likely but not guaranteed to happen with unoptimized or themes with texture pattern animations.
32+
33+
Almost every theme found in [Themezer](https://themezer.net/wiiu/themes) should be optimized to work with European consoles, if you find one that is not, please let us know in our [Discord Server](https://discord.com/invite/2DNvH9db2A)!
34+
35+
--------------
36+
37+
### Will my themes show up if I use Tiramisu?
38+
39+
No. Custom themes will not appear because Themiify relies on [StyleMiiU-Plugin](https://github.com/Themiify-hb/StyleMiiU-Plugin) to load them, which is only available while using Aroma.
40+
41+
--------------
42+
43+
## Troubleshooting
44+
45+
### I have previously installed a theme to my NAND and Themiify won't work
46+
47+
For Themiify to work properly, you will need the original Wii U Menu files.
48+
49+
1. Use [JNUSTool](install/files.md#jnustool) to get the original files.
50+
2. Copy `Men.pack`, `Men2.pack` to `SD:/themiify/cache/Common/Package/`.
51+
3. Copy `cafe_barista_men.bfsar` to `SD:/themiify/cache/Common/Sound/Men/`.
52+
53+
After that, you should be able to use Themiify normally.
54+
55+
### My Wii U crashes when loading the Wii U Menu
56+
57+
You can remove any previously installed theme.
58+
59+
1. Insert the SD Card into your computer.
60+
2. Open `SD:/wiiu/themes/`.
61+
3. Delete the folder with your recently installed theme.
62+
63+
After this, the Wii U will boot using the original theme.
64+
65+
--------------
66+
67+
For further support, visit our [Discord Server](https://discord.com/invite/2DNvH9db2A).

‎docs/install/fonts.md‎

Lines changed: 51 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@ icon: fontawesome/solid/font
66

77
You can use custom fonts on your Wii U using [System Font Replacer](#system-font-replacer)
88

9-
!!! abstract "Credits to [Daniel K.O](https://github.com/dkosmari/) for the information in this page & for creating the System Font Replacer plugin"
10-
119
--------------
1210

13-
## ***System Font Replacer***
11+
## System Font Replacer
1412

1513
This is an Aroma plugin to safely temporarily replace the Wii U's system font.
1614

@@ -31,12 +29,11 @@ anything in your NAND.
3129
2. Download the `system-font-replacer-helper.wuhb` file and copy it to `SD:/wiiu/apps`.
3230

3331
- Create a `fonts` folder inside your `wiiu` folder.
34-
- Place your fonts inside the `fonts` folder
32+
- Place your `.ttf` fonts inside the `fonts` folder
3533

3634
### Usage
3735

38-
The plugin can load TrueType fonts from anywhere in the SD card, but it's a good idea to have
39-
them in `SD:/wiiu/fonts/`; that's the default location the plugin looks for fonts.
36+
The plugin will load TrueType (`.ttf`) fonts from `SD:/wiiu/fonts/`
4037

4138
1. Open up the WUPS menu (**L + ↓ + SELECT**) and enter the **System Font
4239
Replacer** menu.
@@ -45,17 +42,11 @@ them in `SD:/wiiu/fonts/`; that's the default location the plugin looks for font
4542

4643
3. Select the "Std Font" option, and press **A** to start editing it:
4744

48-
- Press **→** to enter a folder;
49-
- Press **←** to leave a folder;
50-
- Press **↑** or **↓** to change the file;
51-
- Press **X** to reset back to the default value (`SD:/wiiu/fonts/`);
45+
- Press ← or → to cycle through the fonts in `SD:/wiiu/fonts/`.
46+
- Press **X** to reset back to the default value (empty, no font)
5247
- Press **A** to confirm, or **B** to cancel the change.
5348

54-
Use it to navigate to the desired `.ttf` font you want to use, then press **A** to
55-
confirm it.
56-
57-
Note that, if you select a directory (like the default, `SD:/wiiu/fonts`) the font will
58-
not be replaced, and the original system font is used instead.
49+
> Std font is used for Western and Japanese text. Use the Cn, Kr or Tw options if you want to replace the Simplified Chinese, Korean, or Traditional Chinese fonts. Most official games and apps do not use these fonts, so there almost no reason to replace them.
5950
6051
4. Exit the plugin menu.
6152

@@ -67,22 +58,12 @@ them in `SD:/wiiu/fonts/`; that's the default location the plugin looks for font
6758

6859
!!! success
6960

70-
You should now see your custom font
61+
You should now see your custom font.
7162

7263
!!! warning
7364

7465
If you have any issues getting your fonts to work check [Issues](#issues)
7566

76-
--------------
77-
78-
### Helper App
79-
80-
If you get a custom font in the form of a `.bps` patch, to be applied to one of the system
81-
fonts, you can use the [System Font Replacer Helper](#system-font-replacer-helper) to easily convert them.
82-
83-
Simply put your `.bps` patches in `SD:/wiiu/fonts/`, and run the Helper app. It will then
84-
automatically convert all `.bps` patches in that folder into `.ttf` fonts.
85-
8667
### "Use custom fonts only for Wii U Menu"
8768

8869
If you disable this option, the font will show up in any other software that requests the
@@ -93,20 +74,59 @@ Settings, the Friends List, etc, you can disable this option ("*no*").
9374

9475
--------------
9576

96-
### Issues
77+
## System Font Replacer Helper
78+
79+
This is a companion app for the System Font Replacer plugin.
80+
81+
With it you can:
82+
83+
- Process `.bps` font patches in `SD:/wiiu/fonts/` to create `.ttf` fonts;
84+
- Export the system fonts to `SD:/wiiu/fonts/`.
85+
86+
!!! info
87+
88+
**No system file is modified by this application. All changes are done to the SD card only.**
89+
90+
### Creating `.ttf` fonts from `.bps` patches
91+
92+
1. Copy the font `.bps` patches to `SD:/wiiu/fonts/`.
93+
94+
2. Run the app by tapping on the **System Font Replacer Helper** icon.
95+
96+
3. When prompted, press **A** to process all the `.bps` patches.
97+
98+
4. At the end, press the **HOME** button and close the app.
99+
100+
You will now find the corresponding `.ttf` fonts in `SD:/wiiu/fonts/`, ready to be used in
101+
the plugin configuration.
102+
103+
### Exporting the system fonts
104+
105+
1. Run the app, by tapping on the **System Font Replacer Helper** icon.
106+
107+
2. When prompted, press **+** to export the system fonts.
108+
109+
3. At the end, press the **HOME** button and close the app.
110+
111+
You will now find copies of the system fonts (`CafeCn.ttf`, `CafeKr.ttf`, `CafeStd.ttf`,
112+
`CafeTw.ttf`) in `SD:/wiiu/fonts/`.
113+
114+
--------------
115+
116+
## Issues
97117

98-
#### Freezes/Crashes and text glitches
118+
### Freezes/Crashes and text glitches
99119

100120
Not every game/app has good a font rendering implementation. Some cannot handle more
101121
"advanced" TTF fonts, and will either render it incorrectly, or outright crash.
102122

103-
#### Large font files
123+
### Large font files
104124

105125
Aroma plugins have very limited amount of memory to use. If the font file is too large, it
106126
might use too much memory, and other plugins might stop working. Fonts up to 12.5 MiB in
107127
size seem to work fine; larger fonts have not been tested.
108128

109-
#### Missing symbols
129+
### Missing symbols
110130

111131
Some Wii U software make use of the system font's Private Use Area (PUA) block (from
112132
`U+E000` to `U+E099`), to show symbols for gamepad buttons, sticks, etc. If the
@@ -152,39 +172,4 @@ font.
152172

153173
--------------
154174

155-
## System Font Replacer Helper
156-
157-
This is a companion app for the System Font Replacer plugin.
158-
159-
With it you can:
160-
161-
- process `.bps` font patches in `SD:/wiiu/fonts/` to create `.ttf` fonts;
162-
- export the system fonts to `SD:/wiiu/fonts/`.
163-
164-
!!! info
165-
166-
**No system file is modified by this application. All changes are done to the SD card only.**
167-
168-
### Creating `.ttf` fonts from `.bps` patches
169-
170-
1. Copy the font `.bps` patches to `SD:/wiiu/fonts/`.
171-
172-
2. Run the app by tapping on the **System Font Replacer Helper** icon.
173-
174-
3. When prompted, press **A** to process all the `.bps` patches.
175-
176-
4. At the end, press the **HOME** button and close the app.
177-
178-
You will now find the corresponding `.ttf` fonts in `SD:/wiiu/fonts/`, ready to be used in
179-
the plugin configuration.
180-
181-
### Exporting the system fonts
182-
183-
1. Run the app, by tapping on the **System Font Replacer Helper** icon.
184-
185-
2. When prompted, press **+** to export the system fonts.
186-
187-
3. At the end, press the **HOME** button and close the app.
188-
189-
You will now find copies of the system fonts (`CafeCn.ttf`, `CafeKr.ttf`, `CafeStd.ttf`,
190-
`CafeTw.ttf`) in `SD:/wiiu/fonts/`.
175+
!!! abstract "Credits to [Daniel K.O](https://github.com/dkosmari/) for the information in this page & for creating the System Font Replacer plugin"

‎docs/install/loading.md‎

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,22 +101,55 @@ There's two ways to load themes using aroma
101101

102102
You have successfully installed a Custom Theme on your Wii U.
103103

104-
??? info "Fonts"
104+
!!! tip "If you want to use custom fonts, follow [Fonts](fonts.md)."
105105

106-
If you want to use custom fonts follow
106+
!!! tip "If you want to use a Splash Screen follow [Splash Screen](splash.md)"
107107

108-
[Use Custom Fonts](fonts.md){ .md-button .md-button--primary }
108+
??? failure "Troubleshooting: Stuck on black screen/splash or bootlooping"
109109

110-
??? info "Splash Screen"
110+
Something is wrong with the theme you applied (`Men.pack`, `Men2.pack`).
111111

112-
If you want to use a Splash Screen follow
112+
- Check if the file was patched correctly.
113+
- If your console is EUR, check if the theme is compatible.
113114

114-
[Splash Screen](splash.md){ .md-button .md-button--primary }
115+
??? question "European Consoles"
115116

116-
??? warning "Troubleshooting"
117+
European consoles have more language packs built onto the menu meaning the file size on themes needs to be smaller to work properly. This is more likely but not guaranteed to happen with unoptimized or themes with texture pattern animations.
117118

118-
- If you're stuck on a black screen or Bootloop: [Black Screen / Bootloop](../troubleshooting.md#black-screen-wii-u-menu-bootloop)
119+
Otherwise, you can:
119120

120-
- If your console freezes on the Wii U Menu loading screen: [Freezing](../troubleshooting.md#freezing)
121+
??? note "For SDCaffiine"
121122

122-
- If your theme didn't load and it's showing the default one: [Theme not loading](../troubleshooting.md#theme-not-loading)
123+
- On the SDCafiine screen, press B to launch without a modpack.
124+
- Delete your theme from `sd:/wiiu/sdcafiine/[TITLEID]/[ThemeName]`.
125+
- Delete the plugin `SD:/wiiu/environments/aroma/plugins/sdcafiine.wps`.
126+
127+
??? note "For StyleMiiU"
128+
129+
- Delete your theme: `sd:/wiiu/themes/[ThemeName]`.
130+
- Delete the plugin config file: `SD:/wiiu/environments/aroma/plugins/config/style-mii-u.json`.
131+
- Delete the plugin: `SD:/wiiu/environments/aroma/plugins/stylemiiu.wps`.
132+
133+
??? failure "Troubleshooting: Theme not loading"
134+
135+
The files were not loaded correctly or no modifications were made to the Menu.
136+
137+
??? info "Check that you have installed the plugin"
138+
- SDCafiine: `SD:/wiiu/environments/aroma/plugins/sdcafiine.wps`.
139+
- StyleMiiU: `SD:/wiiu/environments/aroma/plugins/stylemiiu.wps`.
140+
141+
??? info "Check that you patched the file correctly"
142+
- The theme folder must contain the patched `.pack` files.
143+
144+
??? info "Check that you are using the correct path"
145+
- SDCafiine: `sd:/wiiu/sdcafiine/[TITLEID]/[ThemeName]/content/Common/Package/Men.pack, Men2.pack`.
146+
- StyleMiiU: `sd:/wiiu/themes/[ThemeName]/Men.pack, Men2.pack`.
147+
148+
??? info "Check that your theme is selected"
149+
- SDCafiine: Select the Modpack with your theme
150+
151+
- StyleMiiU:
152+
- Open the WUPS menu (**L + ↓ + SELECT**) and enter the **StyleMiiU** menu. (Make sure StyleMiiU is enabled)
153+
- Enter the **Available Themes** option, you should see the folders that are in `SD:/wiiu/themes/`.
154+
- Set whatever theme you want to Current Theme.
155+
- Exit the WUPS menu.

0 commit comments

Comments
 (0)