Configuring Settings - squidgy617/BrawlInstallerPlugins GitHub Wiki

This document serves as a detailed breakdown of the build settings that can be configured for the BrawlInstaller plugin suite.

To start with this guide, you'll first want to follow the installation instructions on the main page. Afterward, open BrawlCrate and navigate to Plugins > BrawlInstaller Plugins > Settings.

Most of the options in this form should be self-explanatory, but this documentation should help explain any settings that may be unclear at a glance.

Upon opening the Settings plugin, you will be presented with the Build Settings menu.

This screen has numerous configurable options. The first thing to note, however, is that every option has a tooltip associated with it. Hover over any labels on the form to see a tooltip explaining what that setting means. This should be sufficient to learn about most of the settings, but if some are still confusing, read on.

If you are using a standard P+Ex or PMEX REMIX build with no significant modifications (that is, modifications to the entire build, rather than simple character additions and the like), you can click the P+Ex Defaults or REMIX Defaults buttons, respectively, to automatically fill in these fields with the standard settings for those builds. You can then adjust the settings as needed using this form.

The cosmetic settings section contains options related to the cosmetics used in your build.

• RSP Loading - This setting indicates if character portraits on the character select screen are loaded from the character's RSPs (result-screen portraits), located in pf/common/char_bust_tex, instead of from the normal location in pf/menu2/sc_selcharacter.pac. If this is checked, character portraits will only be installed as RSPs in pf/common/char_bust_tex, and not in sc_selcharacter.pac. For most builds, this should be left unchecked.

• 50CC - This setting indicates if the build uses naming conventions associated with the fifty-costume code for cosmetics. If this is checked, stock icons, battle portraits, and other cosmetics will be named using their cosmetic ID multiplied by 50, as is required by the fifty-costume code. For most modern builds, including P+Ex and PMEX REMIX, this should be checked. While REMIX does not use the fifty costume code, it does use the naming conventions associated.

• CSS Icon Style - This setting indicates what style of character icons are used in the character select screen of your build. This simply determines which CSS icon will be installed when installing character packages that include multiple styles. If your build does not use any of the listed styles, you should set this to the one that is closest, and ensure any character packages for your build use the same option.

  • P+ - The style of icon used in Project+ and P+Ex. This icon displays as a diamond shape on the character select screen.
  • vBrawl - The style of icon used in vanilla Brawl. This icon displays as a rectangular shape on the character select screen, and has a blue background.
  • PM - The style of icon used in Project M. This icon displays as a rectangular shape on the character select screen, and has a purple background.
  • REMIX - The style of icon used in PMEX REMIX. This icon displays as a hexagonal shape on the character select screen.

• BP Style - This setting indicates what style of portraits are displayed in a match in your build. This simply determines which style of battle portrait will be installed when installing character packages that include multiple styles. If your build does not use any of the listed styles, you should set this to the one that is closest, and ensure any character packages for your build use the same option.

  • vBrawl - The style of battle portrait used in vanilla Brawl, Project+, P+Ex, and most modern builds. It is a standard square portrait.
  • REMIX - The style of battle portrait used in PMEX REMIX. It is a portrait with a hexagonal background.

• Portrait Name Style - This setting indicates what style of names are displayed on the portraits displayed on the character select screen in your build. This simply determines which style of portrait name will be installed when installing character packages that include multiple styles. If your build does not use any of the listed styles, you should set this to the one that is closest, and ensure any character packages for your build use the same option.

  • vBrawl - The style of portrait names used in vanilla Brawl.
  • PM - The style of portrait names used in Project M and some other modern builds.
  • REMIX - The style of portrait names used in PMEX REMIX.

• Stock Icon Install Locations - These settings determine which locations in your build character-specific stock icons will be installed. These are the stock icons that look like the character's head.

  • Character Select - Check this if your build uses stock icons on the character select screen in modes like Classic Mode. When checked, stock icons will be installed to sc_selcharacter.pac. For most builds, this should be checked.
  • Stage Select - Check this if your build uses stock icons on the stage select screen. When checked, stock icons will be installed to sc_selmap.pac. For most vanilla Brawl style builds, this should be checked, but for most modern builds it should be unchecked.
  • Result Screen - Check this if your build uses stock icons on the result screen after a match to indicate KOs and deaths. When checked, stock icons will be installed to STGRESULT.pac. For PMEX REMIX, this should be unchecked, but for most other builds it should be checked.
  • Rotation Mode - Check this if your build uses stock icons to display characters in modes like Rotation Mode. When checked, stock icons will be installed to StockFaceTex.brres. For most builds, this should be checked.
  • Battle UI - Check this if your build uses character-specific stock icons during a match. When checked, stock icons will be installed to info.pac. On most modern builds, this should be checked, but for builds like PMEX REMIX and vanilla-style builds, this should be unchecked.
  • Single Stock - Check this if your build only uses one stock icon per character - that is, they don't use a different stock icon for each costume. When checked, characters installed will only be installed with the first stock icon in their character package. Additionally, when a costume is uninstalled, stock icons will not be uninstalled with it.

• Install Portrait Names - Whether or not to install the names that appear on character portraits on the CSS. For most builds, this should be checked, but for Project+ builds, this should be unchecked.

• Install BP Names - Whether or not to install the names that appear on the UI during battle. For most modern builds, this should be unchecked.

• Install Single Player Cosmetics - Whether or not to install cosmetics (franchise icons and BP names) to single-player modes such as training and classic mode. For most builds, this should be checked.

• Install CSS Icon Names - Whether or not to install the names that appear on the icons on the CSS. For vBrawl and PM-style builds, this should usually be checked. For other builds, it should usually be unchecked.

• Franchise Icon Size - The number in this field determines the height and width of franchise icons displayed behind the character portraits on the character select screen. In most builds, this should be 64, but for Project+ and P+Ex, it should be 128.

This section displays a list of the custom stage list ASM files used in your build. This is used specifically for builds that use the modern Project+ stagelist system. Some builds have extra .asm files that contain additional stage lists on top of the standard and netplay stage lists.

If your build uses something like this, you can click the + icon to the right of the listbox, which will open a prompt to select a .asm file. Selecting the file will add it to the list. You can click the - icon to remove an entry from the list. Stage lists included in these .asm files will be added to the stage list form when using the Manage Stages plugin.

If any of the paths in this list are in your build, the build path will be replaced with {buildPath} on save.

Most builds do not use this setting at all.

The configuration settings section contains general options related to actions the BrawlInstaller plugins should take when working on your build.

• lKHM .exe - The path to your preferred .exe file of QuickLava's lavaKirbyHatManager. This must be placed somewhere in your build for Kirby hats to work correctly in P+Ex builds. If you used the BrawlInstaller.Tools.Setup.exe, this should be present in your build. If BrawlInstaller is able to locate it in your build, this field will be populated automatically. BrawlInstaller will default to the OFFLINE version if it is found, unless you specify otherwise. If this path is in your build, the build path will be replaced with {buildPath} on save.

  • Default Kirby Hat ID - The default fighter ID to copy a Kirby hat from if no Kirby hat settings are included in a character package. For instance, if you set this to Lucario's ID of 0x21, any fighters without Kirby hats will use a copy of Lucario's hat when swallowed by Kirby. This field accepts either decimal or hexadecimal values, the latter must be preceded by 0x to be read correctly. Lucario's ID of 0x21 is recommended because it is the most stable at this time. If this field is not filled in, the none setting will be used, meaning characters without Kirby hats will simply not have one added. This can cause instability on P+Ex builds that do not have the code Temporary Hatless Clone Kirby Inhale Fix [DukeItOut].

  • Install Kirby Hats - When checked, the plugin will attempt to install a Kirby hat whenever one is available, or resort to a default when one is not. When unchecked, Kirby hats will never be installed, regardless of the other Kirby hat settings. This can cause instability on P+Ex builds not using the code Temporary Hatless Clone Kirby Inhale Fix [DukeItOut].

• PowerPC .exe - The path to your preferred .exe file of QuickLava's fork of the PowerPC Assembly Functions code menu. This must be placed somewhere in your build for characters to be added to the code menu. If you used the BrawlInstaller.Tools.Setup.exe, this should be present in your build. If BrawlInstaller is able to locate it in your build, this field will be populated automatically. BrawlInstaller will default to the Dolphin version if it is found, unless you specify otherwise. If this path is in your build, the build path will be replaced with {buildPath} on save.

• lSIDRA .exe - The path to QuickLava's lavaSawndIDReplaceAssist.exe. This can be placed anywhere, but if you used the BrawlInstaller.Tools.Setup.exe, this should be present in your build. This is necessary to automatically resolve soundbank conflicts when installing characters. If BrawlInstaller is able to locate it in your build, this field will be populated automatically. If this path is in your build, the build path will be replaced with {buildPath} on save.

• sfxchange .exe - The path to Codes' sfxchange.exe. This can be placed anywhere, but if you used the BrawlInstaller.Tools.Setup.exe, this should be present in your build. This is necessary to automatically resolve soundbank conflicts when installing characters. If BrawlInstaller is able to locate it in your build, this field will be populated automatically. If this path is in your build, the build path will be replaced with {buildPath} on save.

  • Soundbank Format - This setting indicates how soundbank files are named in your build. If set to decimal, BrawlInstaller will name all soundbanks in decimal format. If set to hexadecimal, it will name them in hexadecimal format. Most modern builds use the hexadecimal format.
  • Increment Soundbank IDs by 7 - When this setting is checked, SFX IDs will be incremented by 7 when resolving soundbank conflicts. This should be checked on P+Ex, PMEX REMIX, and most modern builds.
  • Increment Soundbank names by 7 - When this setting is checked, soundbanks will be named as their ID incremented by 7. This should be unchecked on P+Ex, PMEX REMIX, and most modern builds.

• gfxchange .exe - The path to Codes' gfxchange.exe. This can be placed anywhere, but if you used the BrawlInstaller.Tools.Setup.exe, this should be present in your build. This is necessary to automatically resolve Effect.pac ID conflicts when installing characters. If BrawlInstaller is able to locate it in your build, this field will be populated automatically. If this path is in your build, the build path will be replaced with {buildPath} on save.

• Install Fighters to SSE - When checked, characters will be installed to Subspace Emissary mode. Only check this option if your build supports Kapedani's Subspace Emissary Ex. This comes with the latest version of P+Ex.

• Install Trophies - When checked, new trophies will be installed whenever they are available as part of a character package. While adding trophies appears to be stable at this time, some properties are unknown, so this feature is considered experimental at this time.

• Install Victory Themes - When checked, victory and credits themes will be installed whenever they are available as part of a character package. Only select this if your build supports Project+'s modern tracklist system. Most modern builds, such as P+Ex and PMEX REMIX, use this.

• SSE Unlock Stage - When characters are installed to Subspace Emissary mode, this setting determines whether they are unlocked right away, or are locked until completing the mode. Selecting Start will make it so fighters are unlocked from the start by default, and selecting End will make it so fighters are not unlocked until completing the story by default.

Once your settings are configured, you can hit the Save button to save them. A file called settings.ini will be created in your build's root folder, and any future plugin runs using the build will use these settings. You can then hit Close to exit the window.

If you wish to alter settings again in the future, you can always select the Settings option again and alter as needed.