Settings - squidgy617/BrawlInstallerPlugins GitHub Wiki
BrawlInstaller supports a variety of different builds by allowing users to customize their settings. These settings are documented on this page.
settings.ini
After configuring settings, a settings.ini file is generated that the BrawlInstaller plugins use to determine various behaviors. This settings.ini is stored in the root folder of the user's build directory.
Note that any settings in settings.ini
that contain your build path in them will be saved with the build path replaced with {buildPath}
. Paths outside of the build will not save in this manner.
The settings currently supported by the BrawlInstaller plugins are as follows:
- rspLoading - [Values: true, false] : Whether or not the build uses RSP (result-screen portrait) loading. If this is set to
true
, character select portraits will not be installed to the build'ssc_selcharacter.pac
, and will instead only be installed as result-screen portraits in/pf/menu/common/char_bust_tex/
. - cssIconStyle - [Values: P+, PM, REMIX, vBrawl] : The style of CSS icon that will be installed into your build. When installing a character package, the plugin will attempt to find a CSS icon that matches your preferred style. If one cannot be found, CSS icon installation will be skipped and must be performed manually.
- bpStyle - [Values: vBrawl, REMIX] : The style of battle portrait that will be installed into your build. When installing a character package, the plugin will attempt to find a folder of battle portraits that matches your preferred style. If such a folder cannot be found, the plugin defaults to vBrawl battle portraits.
- replayIconStyle - [Values: vBrawl, P+] : The style of replay icon that will be installed into your build. When installing a character package, the plugin will attempt to find a replay icon that matches your preferred style. If such a folder cannot be found, replay icon installation will be skipped.
- installPortraitNames - [Values: true, false] : Whether or not character selection portrait names should be installed when installing a character package. These are the names displayed over the character's portrait when they are selected on the character select screen. If this is set to true, portrait names will be installed, otherwise they will not.
- portraitNameStyle - [Values: PM, vBrawl] : The style of portrait name to install when installing character packages. When installing a character package, the plugin will attempt to find a portrait name that matches your preferred style. If one cannot be found, portrait name installation will be skipped and must be performend manually.
- franchiseIconSizeCSS - [Values: any integer] : The size in pixels of franchise icons on the character select screen.
- installStocksToCSS - [Values: true, false] : Whether or not stock icons should be installed to
sc_selcharacter.pac
. - installStocksToInfo - [Values: true, false] : Whether or not stock icons should be installed to
info.pac
. - installStockIconsToResult - [Values : true, false] : Whether or not stock icons should be installed to
STGRESULT.pac
. - installStocksToSTockFaceTex - [Values : true, false] : Whether or not stock icons should be installed to
StockFaceTex.brres
. - installStocksToSSS - [Values : true, false] : Whether or not stock icons should be installed to
sc_selmap.pac
. - singleStocks - [Values : true, false] : When this is true, installed characters will only have the first stock icon in their character package installed, leaving them with only one stock icon. Additionally, when costumes are uninstalled, stock icons will not be uninstalled with them.
- fiftyCostumeCode - [Values : true, false] : Whether or not the build uses the fifty costume code. If set to
true
, cosmetics will be named to match the naming scheme supported by the fifty costume code, otherwise they will be named according to vanilla Brawl standards. - kirbyHatExe - [Values : a .exe path] : The direct path to the .exe file for QuickLava's Kirby hat manager to run when installing Kirby hats.
- defaultKirbyHat - [Values : fighter ID in hex format, none] : The hexadecimal fighter ID that Kirby hats should default to in the event that a valid Kirby hat cannot be found. If set to a hexadecimal value, this ID will be used to automatically set up a Kirby hat based on the one that corresponds to that fighter (e.g. a value of 0x21 will cause packages that are missing Kirby hats to generate a new Kirby hat that is a copy of Lucario's). If set to
none
, Kirby hat installation will be skipped entirely and the fighter's Kirby hat value will be set to "None". - assemblyFunctionsExe - [Values : a .exe path] : The direct path to the .exe file for QuickLava's Code Menu to run when adding a character to the code menu.
- sawndReplaceExe - [Values : a .exe path] : The direct path to the .exe file for QuickLava's Sawnd Porting tool to run when changing soundbank IDs.
- sfxChangeExe - [Values : a .exe path] : The direct path to the .exe file for Codes' sfxchange.exe tool to run when changing soundbank IDs.
- soundbankStyle - [Values : hex, dec] : The naming convention used for soundbanks in your build. The plugin will use this setting to determine how soundbanks imported into your build should be named. If it is set to
hex
, soundbanks will be named after their soundbank ID in hexadecimal format. If set todec
, soundbanks will be named after their soundbank ID in decimal format. - addSevenToSoundbankName - [Values : true, false] : Whether 7 should be added to soundbank IDs when naming soundbanks. If this is set to
true
, all soundbanks will be named as the ID provided + 7. If set tofalse
, all soundbanks will be named only as the ID provided. - addSevenToSoundBankIds - [Values : true, false] : Whether 7 should be added to SFX IDs within soundbanks when converting them using QuickLava and Codes' tools. If this is set to
true
, soundbank IDs passed to QuickLava's tool will have 7 added to them. If this is set tofalse
, soundbank IDs will be passed to QuickLava's tool unmodified. - installVictoryThemes - [Values : true, false] : Whether victory and credits themes should be installed to the build or not when installing character packages. This primarily exists in case of builds that do not use the P+ tracklist system. If this is set to
false
, victory and credits themes will not be installed. - gfxChangeExe - [Values : a .exe path] : The direct path to the .exe file for Codes' gfxchange.exe tool to run when changing Effect.pac IDs. This should be in the same directory as Codes' tracechange.exe, which will also be run in the event of Effect.pac ID conflicts.
- installBPNames - [Values : true, false] : Whether or not battle portrait nameplates should be installed to
info.pac
. - installSingleplayerCosmetics - [Values : true, false] : Whether or not franchise icons and BP names (if the user has opted to install them at all) should be installed into single player modes as well (e.g. Classic Mode, Home Run Contest, Training, etc).
- installToSse - [Values : true, false] : Whether or not characters should be installed to SSE mode. This is only functional for builds that support Subspace Emissary Ex.
- sseUnlockStage - [Values : start, end] : Indicates when characters installed into SSE mode should be unlocked. A value of
start
will cause installed characters to be unlocked at the start of the SSE campaign. A value ofend
will cause installed characters to be unlocked after defeating the final boss. - installTrophies - [Values : true, false] : Whether trophies included in character packages should be installed or not.
- customStageLists - [Values : comma separated list of file paths] : The filepaths for the .asm files of any custom stage lists included in your build. These are sometimes used to allow interchangeable stage lists in-game. As long as these filepaths appear somewhere in your build, extra tabs will be added to the stage list window when using the
Manage Stages
plugin. - installCSSIconNames - [Values : true, false] : Whether or not to install CSS icon names when available. Names will always be installed for SSE mode regardless of this setting.