Configurable USB Loader's options explained
This page provides a list of all Configurable USB Loader's options with notes about how to use them. Each entry will be given with the definition from README-CFG.txt which can be found in every .zip version of the loader. This page starts by describing the file types used, then describes the options and finally shows the options used in the sample GAF config. You will also find the Configurable USB Loader Configurator which is a Windows application which helps you set all these values in a GUI and creates the config.txt and theme.txt files needed to configure the loader.
This page was most recently updated with the release of version 57 of Configurable USB Loader.
Description of Files
Global Options (config.txt)
Config.txt is a file which lets you configure many aspects of the Loader. It is generally located in sd:/usb-loader/ and/or sd:/apps/USBLoader/. Wherever it is first found is the base directory used for all other paths. Both config.txt files will be read if you have one in each of the mentioned folders. The rest of this page assumes you have both and thus will use sd:/usb-loader as the base directory.
Theme Options (theme.txt)
Configurable USB Loader allows you to provide separate themes which you can switch between while running the Loader. This is performed via the Global Options Menu. A theme.txt file for each theme is stored in sd:/usb-loader/themes/theme-name/ containing options that describe the given theme. The startup theme is chosen in config.txt with the theme option.
Theme overrides (config.txt)
While all options can appear in config.txt, including theme options, some of them behave differently. If the same option appears in both theme.txt and config.txt, then the file with priority depends on the option. The following options use the value in config.txt as their value:
- hide_header
- hide_hddinfo
- hide_footer
- simple
- cover_style
- cover_size
- wcover_size
- cursor
- menu_plus
- gui_text_color
- gui_text_outline
- gui_text_shadow
- gui_text2_color
- gui_text2_outline
- gui_text2_shadow
- gui_title_top
- buttons
- home
- button_B
- button_1
- button_2
- button_H
- button_-
- button_+
- button_X
- button_Y
- button_Z
- button_C
- button_L
- button_R
- button_cancel
- button_other
- button_exit
- button_save
The other theme options will use the value in theme.txt.
Game Settings (settings.cfg)
Settings.cfg is where all the options saved within the loader itself are stored. This is predominantly the favorites and hidden games, along with all the per-game settings. In addition, several options may be saved here when you perform the action to save all settings at the Global Options screen (by pushing 2). If these options are located in settings.cfg, they override the same settings in config.txt. The options that may appear in settings.cfg are:
- theme - Theme to load at startup
- profile - Default profile to load at startup
- device - Default device where games are stored (SD/USB)
- partition - Default partition where games are stored
- gui_style - Initial GUI style at startup
- gui_rows - Inital number of rows for gridflow GUI styles
Meta Arguments (meta.xml)
The meta.xml file included in the sd:/app/usbloader/ directory can be used to house any of the above global options and global theme override options. In addition, there are a few special options (not yet listed on this page) that work differently or which can only appear within meta.xml. The most important of these is the ios option. For instructions to edit meta.xml, see the USB Loader page, which provides some examples for setting the ios option, but other options can be specified the same way if desired.
Background Images
There are four default background images: background.png, background_wide.png, bg_gui.png and bg_gui_wide.png. The loader will first look in the chosen theme directory and then the base directory for these files. The names of these images can be changed using the background_base and background_gui options. Note that if the wide versions are not present, the values of the 4:3 options will be checked as well.
Overlay Images
There are four default background images: bg_overlay.png, bg_overlay_w.png, bg_gui_over.png and bg_gui_over_w.png. The loader will only look in the chosen theme directory (or the base directory when no theme is chosen) for these files. Overlay files are an image that is placed over the background image, typically with transparency. This can be used to add the same set of buttons to every background image used, or to automatically add console fading when a transparent console is desired.
Other Images
The GUI has several other images that can be changed by adding files to either the theme or base directories. See the full zip of Configurable USB Loader for examples. The following files are allowed:
Filename |
Description |
favorite.png |
icon that appears on favourites |
pointer.png |
mouse pointer, the point should be at the centre |
hourglass.png |
picture displayed while covers load |
font.png |
allow changes of characters within the font for GUI text |
font_uni.png |
adds latin Unicode characters to the font set for GUI text |
font_clock.png |
allow changes of characters within the font for clock text |
Language Files (*.lang)
Translation capabilities were added in v52 of Cfg. The translation files made by other users are available in this thread and are also packed into the releases of Cfg. Translation files are of the form LANGUAGE.lang where LANGUAGE is typically a two-character code for the language, but may be any string. Language files should be placed in the languages subdirectory of the base directory (e.g., sd:/usb-loader/languages/IT.lang).
Configurator
The Configurable USB Loader Configurator allows you to set all options and write theme.txt and config.txt out to files. Use the information below to work out which values you want and simply set them in the Configurator. Here's a look at the main interface and console wizard for theme generation from v50:
Installation
The Configurator is a Windows Application and the latest version, v64, compatible with Cfg v64a and later can be downloaded here. Check the updates file for older releases.
Just unzip the zip and run CfgLoaderConfigurator.exe to use the app.
Sample button images can be found here.
Configurator is now mostly convertible into other languages. You can change the tooltips for all controls and text for buttons and so on. This simply needs the inclusion of five files in the same directory as the executable. Sample versions of those files, including instructions within the files themselves, can be found here.
A Spanish translation has been created by PabloACZ of GBAtemp and Emudesc, the latest version of which can be found here.
If you are using a Mac or Linux, you should be able to run the same application using Mono (v2.4.2 or later). Please use the discuss link at the bottom of this page if you have problems
Options
Options will be described by particular statements upon what you would like to do. The options handled by each section are listed in parentheses for ease of searching. Expand statements that you want to find out more about. For a list of all available options, see the README-CFG.txt file from the latest version of Configurable USB Loader. Options are separated between theme and global options to let you know where you can use them. Each option appears in a box and is shown as the name of the option, followed by an equals sign, followed by a comma separated list of values the option can take. The default value shown in bold is the value that will be used if the option does not appear in the config.txt/theme.txt files. If you don't want to edit the files yourself, we have created a tool for you (see the Configurator section above).
Theme Options (theme.txt and/or config.txt)
Tweaking the look of the menu mode
background = background.png
wbackground = background_wide.png
background_base = background.png
wbackground_base = background_wide.png
Change these to the appropriate filename. A path can also be used. If no path is given, the theme directory will be searched, followed by the base directory. The [w]background_base options have been available since v41 and allow further customisability of the background. They support image sizes wider than 640*480 (height must still be 480). These larger images are cropped to the correct size in 4:3 mode or stretched to fill the screen in 16:9 mode. In addition, the overlay files mentioned earlier will be placed over these background images.
Use the non-base options for backwards compatibility with v40 of Configurable USB Loader and below. You should put the base options after the non-base version to ensure correct operation.
layout = original, original2, small, medium, large, large2, large3, ultimate1, ultimate2, ultimate3, kosaic
Choose a default pre-defined layouts for console and covers. Changing this option affects almost all other theme options.
covers = 1, 0
cover_style = standard, 3d, disc
Turn covers display off with covers=0. Set the type of cover to display, either flat cover, 3d cover or disc art. This option also affects covers_size.
covers_coords = x,y
wcovers_coords = x,y
covers_size = width, height
wcovers_size = width, height
X and y are the coordinates of the top-left corner of the covers. Width and height are the size in pixels.
console_coords = x,y,width,height
wconsole_coords = x,y,width,height
Provide coordinates of the top left corner (x, y) and size (width, height) for the console (text box).
preview_coords = x,y,width,height
wpreview_coords = x,y,width,height
Provide coordinates of the top left corner (x, y) and size (width, height) for the theme preview images. The default position is the same place as the covers. To achieve default, set x and y to -1 and width and height to 0.
colors = dark, bright, mono
Sets default values for dark, bright or monochromatic (black and white) color sets .
console_color = foreground,background
Choose colors for the foreground game list text and background of the console. Valid values are 0-15 matching the colors shown here.
color_header = 0-15
color_selected_fg = 0-15
color_selected_bg = 0-15
color_inactive = 0-15
color_footer = 0-15
color_help = 0-15
These options set specific header, footer, the 'selected game bar' and help text to different EGA colors
console_transparent = 0, 1
Set the console transparent to 1 to not draw the background for the console box. If the color_selected_bg is the same as the background color set in console_color, then it is also not shown.
hide_header = 0,1
hide_hddinfo = 0,1
hide_footer = 0,1
simple = 0,1
Set the hide_* options to 1 to turn off the header text, hard disk drive info and footer text respectively. Setting simple to 1 will turn off hide_footer. Note that simple is also a global option, so it has different operation if it appears in config.txt.
cursor = "»", " ", "->", …
menu_plus = "[+] ", …
Change the display of the cursor or [+] symbols. Both options require quotes surrounding the necessary string. The cursor must be two characters (including spaces) and menu_plus can be between 1-4 characters.
Tweaking the look of the GUI mode
background_gui = bg_gui.png
wbackground_gui = bg_gui_wide.png
Change these to the appropriate filename. A path can also be used. If no path is given, the theme directory will be searched, followed by the base directory. These options support image sizes of 640*480 or wider (height must still be 480). Larger images are cropped to the correct size in 4:3 mode or stretched to fill the screen in 16:9 mode. In addition, the overlay files mentioned earlier will be placed over these background images.
gui_text_color = black, white, RRGGBBAA
gui_text_outline = 00, black, white, RRGGBBAA, AA
gui_text_shadow = 00, black, white, RRGGBBAA, AA
gui_text2_color = black, white, RRGGBBAA
gui_text2_outline = FF, black, white, RRGGBBAA, AA
gui_text2_shadow = 00, black, white, RRGGBBAA, AA
The gui_text_* options affect gridflow GUI modes (grid, flow, flow-z). The gui_text2_* options affect the coverflow modes (coverflow3d, coverflow2d, frontrow, vertical, carousel).
Set the gui_text_color to black, white, or an 8 character hexadecimal representation of the colour where RR = red, GG = green, BB = blue and AA = alpha (transparency). The outline and shadow of the text can be set to be a fully selectable hex colour, like the main one. If only a 2 character code is given (AA) then the colour of the shadow and outline will be white if the main colour is dark and black if the main colour is bright.
gui_title_top = 0,1
0 is below the covers, 1 is above.
Control
I want to change the actions that each button performs. (button_B, button_1, button_2, button_H, button_-, button_+, button_X, button_Y, button_Z, button_C, button_L, button_R, button_cancel, button_other, button_exit, button_save, buttons, home)
button_B = gui, <other actions>, <magic word>, <channel>
button_- = main_menu, <other actions>, <magic word>, <channel>
button_+ = install, <other actions>, <magic word>, <channel>
button_H = reboot, <other actions>, <magic word>, <channel>
button_1 = options, <other actions>, <magic word>, <channel>
button_2 = favorites, <other actions>, <magic word>, <channel>
button_X = A, B, 1, 2, H, -, +, <action>, <magic word>, <channel>
button_Y = A, B, 1, 2, H, -, +, <action>, <magic word>, <channel>
button_Z = A, B, 1, 2, H, -, +, <action>, <magic word>, <channel>
button_C = A, B, 1, 2, H, -, +, <action>, <magic word>, <channel>
button_L = A, B, 1, 2, H, -, +, <action>, <magic word>, <channel>
button_R = A, B, 1, 2, H, -, +, <action>, <magic word>, <channel>
These values control the actions that each button on the Wiimote or peripheral controllers (Nunchuck, Classic Controller, GameCube Controller, Guitar Hero 3 Guitar) will perform when pushed in the GUI mode or game list mode. The following actions can be chosen:
Action Name |
Description |
nothing |
does nothing |
options |
access game options |
gui |
switch to/from GUI |
reboot |
reboot to system menu |
exit |
exit to launching app |
hbc |
exit to HBC |
screenshot |
take a screenshot |
install |
install a game |
remove |
remove a game |
main_menu |
access main menu |
global_ops |
access global options menu |
favorites |
toggle favorites view |
boot_game |
boot a game from the drive |
boot_disc |
boot a game from disc |
theme |
switch to next theme |
profile |
switch to next profile |
unlock |
enter the unlock password |
sort |
switch to the next sort type |
filter |
access the filter menu |
priiloader |
access Priiloader via magic word Daco |
wii_menu |
get Priiloader to launch Wii Menu via magic word Pune |
random |
select a game at random |
A magic word is a four character special word that interacts with the Priiloader homebrew application. It allows you to reboot the Wii but tell Priiloader to perform a different action to usual. The current magic words are limited to Daco and Pune (also mapped to the actions priiloader and wii_menu), but these or any new words can be specified by just writing the word. E.g., "button_B = Pune".
A channel ID can be specified by listing the upper case four character ID of the channel or an eight character hex ID. For example, button_1 = HATP will make button 1 launch the PAL Nintendo channel and button_1 = AF1BF516 will launch the HBC (v1.07).
In addition, X, Y, Z, C, L & R can map to any of the buttons on the Wiimote. This remapping will work everywhere within the loader for any of the needed features.
button_cancel = B
button_other = 1
button_exit = Home
button_save = 2
These options affect button actions in the console menus. Each option can take a comma separated list of values that represent all the buttons that should map to the chosen action (e.g., button_cancel = B, L, R). The cancel action answers no to questions and goes back from most menus. The other action is used to access the other value of some tasks, such as switching between the game options and global options or choosing to download an update without meta.xml. The exit option will perform whatever the current action set by the home option is (see below). The save action is used to save settings and options in certain menus.
buttons= options_1, options_B, original
This option change the actions of the B and 1 buttons, thus overriding button_B and button_1. options_1 set 1 to options and B to gui, options_B is vice versa. original sets 1 to options and B to no function.
home = reboot, exit, screenshot, hbc, <channel>
This option sets the action of the Home button and overrides button_H. The home button also determines what action will be taken when any of the button_exit buttons are pushed in the console menus (see next section).
home = reboot, exit, screenshot, hbc
Choose whether the console is rebooted, the loader exits to the calling application (typically the Homebrew Channel) or whether it launches the Homebrew Channel directly when any of the buttons assigned to button_exit are pushed in the console menus. To control how the loader exits in the gui or game list, set a button action instead (see the previous section).
See the next section for the screenshot option.
home = reboot, exit, screenshot
Set home=screenshot and the first time you push any of the buttons assigned to button_exit, a screenshot will be saved in sd:/usb_loader/ as screenshot1.png or the next available number up to 99 if the file already exists. If you push the exit button after a screenshot has been taken in the game list mode, then the next attempt at taking a screenshot will exit the application.
See the previous sections for the other values of this option.
Global Options (config.txt only)
General look and feel
select = previous, start, middle, end, most, least, random
This option chooses which game is selected when you start the loader. Previous will select the previous game you played. Start, middle and end refer to the start middle and end of the game list. Most and least will select the most or least played game respectively. Random will choose a different game each time.
theme= Theme_Name
Theme_Name should be the name of a subdirectory in the themes folder, e.g., GAF. The corresponding theme.txt will be utilised when starting. If no theme is given, the theme options in config.txt are used.
Note: The theme option can also appear in settings.cfg, which has the highest priority. Look there first if the setting in config.txt isn't working for you.
profile_names = default, name1, name2, …
List your profile names with this option. The order of the list is the order of the profiles in the profile selection menu. Profile names can be separated by either commas or spaces.
profile = profile_name
Set this option to one of the names in the profile_names option to choose the default profile to load at startup. If not set, or set to an invalid value, the first profile in the profile_names list will be loaded.
Note: The profile option can also appear in settings.cfg, which has the highest priority. Look there first if the setting in config.txt isn't working for you.
music = sd:/usb-loader, 1, 0, filename, path
You can turn off music with 0. Using 1 will play music.mp3. You can specify your own filename for music (in .mp3 or .mod format), with or without a path. If you specify a path without a filename, then the loader will randomly select any of the .mp3 or .mod files (note that the default value is a path).
widescreen = auto, 0, 1
Auto will use the Wii's setting to determine which mode to use, although you can force one or the other (1=widescreen, 0=4:3).
start_favorites = 0, 1
Games marked as favorites will be the only ones to show at startup if set to 1. You can still switch to seeing all games.
theme_previews = 0, 1
By setting the option to 0 you can stop the theme preview images from being downloaded and displayed.
adult_themes = 0, 1
Set this option to 1 to display themes marked as adult only in the theme download option.
Tweaking the menu mode
console_mark_page = 0, 1
console_mark_favorite = 0, 1
console_mark_saved = 0, 1
Page adds a plus mark to the bottom of games lists that continue. Favorite prefixes games marked as favourites with a star. Saved marks games that have saved options with a hash. All options will display their marks if set to 1 or hide them if set to 0.
Note: If what you want to do is remove the favorite star image from the box art, look at the Other Images section above. Replace favorite.png with a fully transparent image, one of which is conveniently provided in <Cfg Base>/resources/favorite0.png
cursor_jump = 0,1,2,3…
If set to 0, the Left/Right burrons on the D-pad will go to the next page of games. Setting a different number provides a fixed jump amount of that number (e.g., 10 to move 10 games at a time). D-pad Up/Down will always move one at a time.
Tweaking the GUI mode
gui = 1, 0, start
Setting gui to start will make the Loader launch the GUI immediately while setting it to 0 will stop it from coming up at all.
gui_transition = scroll, fade
This one's pretty self explanatory.
gui_style = grid, flow, flow-z, coverflow3d, coverflow2d, frontrow, vertical, carousel
gui_rows = 1, 2, 3, 4
Grid, flow and flow-z have multiple lines, settable by gui_rows, and use cover_style type covers. The others are all coverflow modes with a single row and use full covers.
These options only affect the GUI mode, they do not make the loader start in GUI mode. To control whether the loader starts in GUI mode, use the gui option instead.
Note: Both the gui_style and gui_rows options can also appear in settings.cfg, which has the highest priority. Look there first if the settings in config.txt aren't working for you.
gui_lock = 0,1
Setting this option to 1 disables the actions of the up/down D-pad buttons to change GUI mode.
gui_antialias = 0, 1, 2, 3, 4
The higher the number, the more antialiasing will be performed. Antialiasing will reduce jagged edges by a large degree at a small cost of processing time.
clock_style = 24, 12, 12am, 0
Choose 24 hour time, 12 hour time, 12 hour time with am/pm indicator or turn the clock off respectively.
Covers
cover_url = URL
cover_url =+ Additional_URL/s
cover_url_3d = URL
cover_url_3d =+ Additional_URL/s
cover_url_disc = URL
cover_url_disc =+ Additional_URL/s
cover_url_full = URL
cover_url_full =+ Additional_URL/s
download_cc_pal = AUTO, EN, FR, DE, ES, IT, NL, PO, AU, …
The URLs for each cover_style will be searched in order. If the cover is not found at the first link, the next will be tried and so on. There are some tags that can be used within URLs to expand to various game specific values:
TAG |
Expansion |
{REGION} |
Expands to pal, ntsc or ntscj based on the 4th character of the game ID |
{WIDTH} |
Expands to the current cover width value |
{HEIGHT} |
Expands to the current cover height value |
{ID3}, {ID4}, {ID6} |
Expands to the 3, 4 or 6 digit ID of the game |
{ID} |
Tries {ID6}, {ID4}, and {ID3} in sequence |
{PUB} |
Expands to the 2 character publisher code from the ID (the last two characters) |
{CC} |
Expands to EN, US or JA based on the 4th character of the game ID. PAL games will also try the value of download_cc_pal first. |
Thus, if you prefer your PAL covers to be shown in French, use "download_cc_pal = FR". Or if you prefer Australian covers, use "download_cc_pal = AU". In the case that the cover site does not have covers from your chosen country, the EN cover will be tried automatically. If you leave this option at the default (AUTO), your console's region will be checked to attempt to determine your location. These options will not affect US, Japanese or Korean games, which maintain their own region.
If you want to download covers from another region if they don't exist in the region of the game, then replace {CC} with the appropriate value and {ID6} with {ID3}E{PUB} where E is the region code of the wanted game. For example, to automatically download NTSC 2D covers from WiiTDB when the local region covers do not exist, you could have the following two links in order:
cover_url = http://wiitdb.com/wiitdb/artwork/cover/{CC}/{ID6}.png
cover_url = http://wiitdb.com/wiitdb/artwork/cover/US/{ID3}E{PUB}.png
The default URL options are as follows:
cover_url = http://wiitdb.com/wiitdb/artwork/cover/{CC}/{ID6}.png
cover_url =+ http://boxart.rowdyruff.net/flat/{ID6}.png
cover_url =+ http://www.muntrue.nl/covers/ALL/160/225/boxart/{ID6}.png
cover_url_3d = http://wiitdb.com/wiitdb/artwork/cover3D/{CC}/{ID6}.png
cover_url_3d =+ http://boxart.rowdyruff.net/3d/{ID6}.png
cover_url_3d =+ http://www.muntrue.nl/covers/ALL/160/225/3D/{ID6}.png
cover_url_disc = http://wiitdb.com/wiitdb/artwork/disc/{CC}/{ID6}.png
cover_url_disc =+ http://boxart.rowdyruff.net/fulldisc/{ID6}.png
cover_url_disc =+ http://www.muntrue.nl/covers/ALL/160/160/disc/{ID6}.png
cover_url_full = http://wiitdb.com/wiitdb/artwork/coverfull/{CC}/{ID6}.png
cover_url_full =+ http://www.muntrue.nl/covers/ALL/512/340/fullcover/{ID6}.png
download_all_styles = 1, 0
By default, all cover styles (flat, 3d, disc art and full) will be downloaded for each game. Change this setting to 0 to only download the cover that is currently set by cover_style.
covers_path = sd:/usb-loader/covers
covers_path_2d = covers_path
covers_path_3d = covers_path/3d
covers_path_disc = covers_path/disc
covers_path_full = covers_path/full
Covers_path changes all paths (as shown), or you can set each separately.
download_id_len = 4, 6
The Loader will detect either type of file, regardless of this setting, but newly downloaded images will be saved in the selected format. Prior to v45b, the default value of this option was 4.
Child/idiot proofing
confirm_start = 1, 0
Set this to 0 to avoid being asked to confirm starting the game. Options can still be changed using the 1 button from the game list/GUI if disable_options=0. Note that banner sounds play on the confirmation page, so if you want to hear them, then set this option to 1 and ensure it appears after the simple option if present.
simple = 0, 1
confirm_start = 1, 0
disable_remove = 0,1
disable_install = 0,1
disable_options = 0,1
disable_format = 0,1
Setting simple=1 will change all disable_* options and hide_hddinfo and hide_footer to 1 and confirm_start to 0.
The disable options disable various features of the loader and are self-explanatory. See the previous section for a description of confirm_start. Note that banner sounds play on the confirmation page, so if you want to use simple and still hear them, then set confirm_start to 1 after setting simple=1.
Also see the next statement about hiding games from the kids to find out how to turn these options back on again via password.
admin_unlock = 0, 1
unlock_password = BUDAH12
When this setting is enabled (1), it will allow all screens normally locked by the simple or disable_* settings to be unlocked via a "secret" wiimote button combination. This also gives access to the Hide Game option on the option menu, which allows you to select games that will be hidden when admin mode is switched off. To access the unlock screen, hold the 1 button down for 5-10 seconds and an "Enter Code:" prompt will appear. Press the wiimote buttons in the order specified by the unlock_password to unlock. To set the lock back on with the original settings intact, hold the 1 button for 5-10 seconds again.
Note that if you set admin_unlock to 0, the loader will always operate in locked mode. There will not be a way to unlock it.
The unlock password can be up to 10 characters long and is mapped to Wiimote buttons as follows:
D-Pad Up: U
D-Pad Down: D
D-Pad Right: R
D-Pad Left: L
B button: B
A Button: A
Minus button: M
Plus button: P
Home button: H
1 button: 1
2 button: 2
hide_game = 0, GAMEID1, GAMEID2, …
Listing games here is equivalent to locking them in the loader, except that you cannot change the value of the hide_game option within the loader. GAMEIDs should be in the 4 character form.
pref_game = 0, GAMEID1, GAMEID2, …
List the games to be listed before the others. GAMEIDs should be in the 4 character form.
Game loading
ios = 249, 222-mload, 223-mload, 224-mload, 222-yal, 223-yal, 250
Mload options are for Hermes' IOS222/223, Yal options are for kwiirk's cIOSes, but these have not been maintained in years. If you want to change this option, it is much better to have it set within meta.xml rather than config.txt as otherwise, a different IOS will be used at launch followed by the one you choose. For instructions to change the ios option in meta.xml, see the meta.xml steps of the Configurable USB Loader installation.
video = game, system, patch, pal50, pal60, ntsc
video_patch = 0, 1, all, sneek, sneek+all
Set screen video format to force. Very important for import games. Try 'system' if 'game' doesn't work.
video_patch=all is primarily useful for games that should display in 480p but don't (e.g., Metroid Prime Trilogy). sneek is a new patch type created for SNEEK. sneek+all performs both the sneek patch and the all patch simultaneously. You would be best off setting this value only on those games that need it within the loader rather than setting it here, though. 1 and 0 are for on and off respectively.
language = console, japanese, english, german, french, spanish, italian, dutch, s.chinese, t.chinese, korean
Force the language the games try to use.
vidtv = 0, 1
Required by some games, especially Japanese games to get fonts working. 1 and 0 are for on and off respectively.
country_patch = 0, 1
Country Patch for better compatibility with some games, especially PAL games on NTSC consoles. 1 and 0 are for on and off respectively.
fix_002 = 0, 1
Anti 002 Fix for use with IOS249 revisions 9, 10, 12 and 13b. 1 and 0 are for on and off respectively. d2x does not require this.
block_ios_reload = 0, 1
Required by some games, but only works with ios: 222-mload, 223-mload. 1 and 0 are for on and off respectively.
alt_dol = 0, 1
You almost certainly don't want to use this option. The per-game option is much easier. 1 and 0 are for on and off respectively.
ocarina = 0, 1
Are you really sure you want to do this? 1 and 0 are for on and off respectively.
hooktype = nohooks, vbi, wiipad, gcpad, gxdraw, gxflush, ossleep, axframe
Choose which hook type is used to load the Ocarina cheats or start Wiird. Note that "nohooks" is not equivalent to turning Ocarina/Wiird off.
write_playlog = 0,1, 2, 3
Turning this option on will start logging the correct names and times for all your games (you can also select which games do and don't change the play log in the options menu of Cfg). You cannot bypass the Wii Menu when loading the loader when using this option. This means that BootMii and Priiloader autoboots to Cfg or the HBC cannot be used. 0 is off. 1 is on with language for the title chosen by the language option. 2 is on with the Japanese title. 3 is on with the English title.
clear_patches = 0,1, all
Setting this value to 1 disables the dvd patch and return to channel. The all value will stop all patches except the NSMB and PoP patches. This option should really be set on a per-game basis rather than globally. It should be set for Prince of Persia: The Forgotten Sands if you are using IOS222.
disable_nsmb_patch = 0, 1
disable_pop_patch = 0, 1
disable_dvd_patch = 0, 1
Disables these patches if you want to test patching in another way, such as WIP or BCA. NSMB is for New Super Mario Bros. PoP is for Prince of Persia: The Forgotten Sands. The DVD patch is used to stop games asking for a disc in the drive, but is only needed for IOS222. 1 will disable, 0 leaves enabled.
Storage
partition = WBFS1, …, WBFS4, FAT1, …, FAT9, NTFS1, …, NTFS9, ask
This chooses which WBFS, FAT or NTFS partition is chosen at startup. If you choose ask, the loader will ask you which to use.
Note: The partition option can also appear in settings.cfg, which has the highest priority. Look there first if the setting in config.txt isn't working for you.
fat_split_size = 4, 2
The files ripped by the loader will be split at a size of XGB-32kB where X is the value of the option.
fat_install_dir = 0, 1, 2, 3
fs_install_layout = 0, 1, 2, 3
These options are aliases for each other and can be treated as being exactly the same.
When 0, files install directly into the wbfs directory without a title (fat:/wbfs/GAMEID.wbfs). When 1, each game has it's own directory starting with the ID (fat:/wbfs/GAMEID_Title/GAMEID.wbfs). When 2, the directory names start with the title instead (fat:/wbfs/Title [GAMEID]/GAMEID.wbfs). When 3, the files install directly into the wbfs directory, but with a title (fat:/wbfs/Title [GAMEID].wbfs).
device = ask, usb, sdhc
You can force the loader to use a USB drive or SD cards when searching for games, or let it ask you.
Note: The device option can also appear in settings.cfg, which has the highest priority. Look there first if the setting in config.txt isn't working for you.
install_partitions = all, only_game, 1:1
The all value installs the update partitions with the game. No game currently require these other partitions to be present, but this may change. 1:1 will not remove any data and will install a full copy of the disc, taking much more space than usual.
Titles and database info
sort = title, players, online_players, publisher, developer, release, play_count, play_date, install, title-asc, title-desc, etc.
sort_ignore = A,An,The
The startup sort method can be any of the listed types in either ascending (-asc suffix) or descending (-desc suffix) mode. If a suffix is not provided, ascending sort is assumed.
sort_ignore provides a comma separated list of terms that should be ignored at the start of game names in title sorts. E.g., with the default option, "The Legend of Zelda: Twilight Princess" will be sorted as if it were "Legend of Zelda: Twilight Princess". Set to blank or "0" to do a purely alphabetical sort.
db_language = AUTO, EN, English, FR, French, ES, Spanish, …
Choose your language via two character code or full language name. AUTO will use the country setting on the Wii to automatically detet your language.
db_ignore_titles = 0, 1
If turned on, the loader will ignore titles within wiitdb.zip when trying to name a game. 1 will ignore titles, 0 will use them.
db_show_info = 0, 1
Turn database info in the console menu on or off. This uses two lines of space in the console. 1 and 0 are for show and hide respectively.
write_playstats = 0, 1
When on, playstats are written to playstats.txt in the base directory. 1 and 0 are for on and off respectively.
Others
return_to_channel = ##0##, JODI, FDCL, AF1BF516, …
This option controls what happens when you push the Wii Menu button after pushing the Home button on the Wiimote. 0 will not change anything and the console will go to the Wii Menu as usual. Alternatively, you can set a channel ID to launch, such as the HBC or a forwarder channel ID. The channel ID can be either a four character ASCII value of the ID or an eight character hex value of the ID.
translation = AUTO, EN, custom, etc
When set to any value but AUTO, the loader will attempt to load the language file called <value>.lang from the languages directory. When the value is AUTO, the language chosen will be automatically picked according to your Wii's language setting.
load_unifont = 0, 1
If you want characters outside of the typical Latin character set (e.g., Asian characters), you will need to load the unifont.dat file. 1 and 0 are for on and off respectively.
confirm_ocarina = 0, 1
Self-explanatory, but 1 and 0 are for on and off respectively.
debug = 0, 1, 8
Debug information includes paths where files are being searched for and other data. 1 provides default debug data. 8 will benchmark a game's read speed instead of actually playing the game.
wiird = 0, 1, 2
0 is off. 1 turns on debugging. 2 turns on debugging and pauses at the start. Change the hooktype from the per-game options to determine the type of hook.
GAF's config.txt and theme .txt
The config.txt provided in the sample GAF config is listed below:
theme = GAF
device = usb
gui = start
gui_style = coverflow3d
This simply sets the device to default to the USB drive and starts in GUI mode with the GAF theme selected using the coverflow3d layout as default.
The theme.txt provided in the sample GAF config is listed below:
background = backgroundGAF.png
wbackground = backgroundGAF_wide.png
layout = large3
covers = 1
cover_style = 3d
console_transparent = 1
This sets a default large3 template layout with transparent custom background and 3d covers.
The locations of files contained in the sample GAF config and their descriptions are listed below:
Filename |
Description |
apps/USBLoader/config.txt |
Global options file |
USB-Loader/config.txt |
Copy of global options file |
USB-Loader/themes/GAF/theme.txt |
Theme options file |
USB-Loader/themes/GAF/backgroundGAF.png |
Menu background image for 4:3 |
USB-Loader/themes/GAF/backgroundGAF_wide.png |
Menu background image for 16:9 |
USB-Loader/themes/GAF/bg_gui.png |
GUI background image for 4:3 |
USB-Loader/themes/GAF/bg_gui_wide.png |
GUI background image for 16:9 |
USB-Loader/themes/GAF/pointer.png |
Change mouse pointer in GUI mode |
Bibliography
1. full source reference