Plugins - squidgy617/BrawlInstallerPlugins GitHub Wiki

Each plugin can be accessed from the Plugins menu in BrawlCrate by hovering over the "BrawlInstaller Plugins" option. Plugins may prompt the user for input. When plugins prompt the user to enter IDs such as fighter IDs or cosmetic IDs, these IDs can almost always be entered as either a hex value (e.g. "0x21") or an integer value (e.g. "33") - the plugins will convert them as needed.

On first run of any plugin, the user will be prompted to configure their settings if they have not done so already.

All plugins attempt to create backups of files that they modify, replace, or delete. These backups are stored in /Backups/ in the BrawlCrate root directory. The plugins will also create a log of the work they are doing. The most recent log file created by one of the plugins can be found in /Logs/log.txt in the BrawlCrate root folder.

Configuration

Settings

Usage: Plugins menu > BrawlInstaller Plugins > Settings

Summary: Allows the user to configure their build settings and saves these settings to a settings.ini file in the build's root folder.

This plugin opens a form allowing the user to configure build settings. A detailed breakdown of the settings featured on this form can be found here. After setting configuration is complete, a settings.ini file will be created in the root folder of the build directory.

For a detailed breakdown of the settings configured by this plugin, see the section on the settings.ini file.

Installer Plugins

Install Character

Usage: Plugins menu > BrawlInstaller Plugins > Install > Install Character

Summary: Installs a character into your build and adds them to the roster for all modes the build supports.

This plugin allows you to select the files for a Brawl character packaged in a .zip file and automatically performs all the necessary work to add the character to your build. It is primarily designed for installing brand-new characters to a build, but it also attempts to resolve issues if you attempt to overwrite an existing character within a build as well. A detailed breakdown on how to use this plugin and what it does can be found here.

Install Cosmetics

Usage: Plugins menu > BrawlInstaller Plugins > Install > Install Cosmetics

Summary: Allows you to select cosmetics and install them into your build for an existing fighter.

This plugin installs cosmetics into a build and makes the necessary changes to add them for an existing fighter. This plugin works exactly like the Install Costume plugin, but doesn't make changes to .pac files or Ex configs. A detailed breakdown on how to use the costume plugin and what it does can be found here.

Install Costume

Usage: Plugins menu > BrawlInstaller Plugins > Install > Install Costume

Summary: Allows you to select cosmetics and costume .pac files and install them into your build as a costume for an existing fighter.

This plugin installs cosmetics and fighter .pac files into a build and makes the necessary changes to add them as a new costume for an existing fighter. A detailed breakdown on how to use this plugin and what it does can be found here.

Install Franchise Icon

Usage: Plugins menu > BrawlInstaller Plugins > Install > Install Franchise Icon

Summary: Allows you to select images and/or a model for a franchise icon and install it into all screens used in your build.

This plugin installs franchise icons to all locations defined for use in a build.

When run, the user is prompted to first select a franchise icon with a black background, then to select one with a transparent background, and finally to select a MDL0 file of their franchise icon. After choosing (or skipping) the files, the user is prompted to enter their desired franchise icon ID. The plugin then installs the selected image and model files to the appropriate locations in the build based on the build settings. If a model file is imported, the transparent background icon will be skipped. If the chosen franchise icon ID is already in use, the user will be prompted to enter a different one.

Once the franchise icons are installed in all locations, the user will receive a message indicating such. To actually use the franchise icon, the user must set a fighter's Ex config to use the chosen franchise icon ID.

Uninstaller Plugins

Uninstall Character

Usage: Plugins menu > BrawlInstaller Plugins > Uninstall > Uninstall Character

Summary: Uninstalls a character completely from your build.

This plugin allows you to enter a fighter ID for a character you wish to uninstall from your build. A detailed breakdown on how to use this plugin and what it does can be found here.

Uninstall Cosmetics

Usage: Plugins menu > BrawlInstaller Plugins > Uninstall > Uninstall Cosmetics

Summary: Allows you to uninstall the cosmetics for a selected costume from a fighter of your choosing.

This plugin uninstalls cosmetics from a build and makes the necessary changes to remove them for an existing fighter. This plugin works exactly like the Uninstall Costume plugin, but doesn't make changes to .pac files or Ex configs. A detailed breakdown on how to use the costume plugin and what it does can be found here.

Uninstall Costume

Usage: Plugins menu > BrawlInstaller Plugins > Uninstall > Uninstall Costume

Summary: Allows you to uninstall a selected costume from a fighter of your choosing.

This plugin uninstalls cosmetics and fighter .pac files from a build and makes the necessary changes to remove a costume from an existing fighter. A detailed breakdown on what this plugin does and how to use it can be found here.

Uninstall Franchise Icon

Usage: Plugins menu > BrawlInstaller Plugins > Install > Uninstall Franchise Icon

Summary: Allows you to enter a franchise icon ID and have the corresponding franchise icon removed from your build.

This plugin uninstalls franchise icons from all locations defined for use in a build.

When run, the user is prompted to enter their chosen franchise icon ID. The plugin then uninstalls the selected franchise icon from the appropriate locations in the build based on the build settings.

Once the franchise icons are uninstalled in all locations, the user will receive a message indicating such.

Extraction Plugins

Extract Character

Usage: Plugins menu > BrawlInstaller Plugins > Extract > Extract Character

Summary: Prompts you to select a character and directory of your choosing, then extracts a character package from your build of that character at the specified location. This character package can then be modified or installed into other builds as desired.

This plugin allows you to enter a fighter ID for a charater you wish to extract from your build. Like other prompts, the fighter ID can be entered in either hexadecimal (e.g. "0x21") or decimal (e.g. "33") format. The user will then be asked to select a directory to extract the character to.

After the user has input their selections, the plugin will attempt to gather up all assets and settings for the character within the build set in the user's build path. It will read through various files in the build to achieve this.

After the fighter is successfully extracted, the user will receive a message indicating such, and they can use the extracted character package as they please. The user can edit extracted packages using the Package Character plugin as well.

NOTE: Characters extracted with this plugin will only contain assets present in the build, since it is impossible to create new assets for other build types. To work with builds of all settings, missing assets will need to be added manually.

Extract All characters

Usage: Plugins menu > BrawlInstaller Plugins > Extract > Extract All Characters

Summary: Allows you to select a directory, then extracts character packages from your build to that directory for every valid character in the build.

This plugin performs the same tasks as "Extract Character", but it does so for every single valid character in your build. Characters are only considered valid if they have all necessary Ex configs, and the plugin does know how to identify Ex redirects as well.

The user will first be prompted to select a directory to extract the character packages to. Afterward, the plugin will perform the operations used in "Extract Character" on every character in the build.

Once all characters have been extracted, the user will receive a message indicating such, and they can use the extracted character packages as they please.

NOTE: This process can take some time. Also note that some vanilla characters might be extracted as well, but since vanilla characters work differently from Ex characters, these are unlikely to work correctly.

Manager Plugins

Manage Music

Usage: Plugins menu > BrawlInstaller Plugins > Manage > Manage Music

Summary: Opens the tracklists form, which allows you to add, edit, and remove tracklists, updating the parameters and .brstm files associated with them. Only supports builds using the modern Project+ tracklist system.

This plugin uses forms with a variety of controls, which are too extensive to detail here. For more detailed information, see the guide on managing music.

Manage Stages

Usage: Plugins menu > BrawlInstaller Plugins > Manage > Manage Stages

Summary: Opens the stage list form, which allows you to re-order, add, edit, and remove stage slots, updating their cosmetics, parameters, and more. Only supports builds using the modern Project+ stage system.

This plugin uses forms with a variety of controls, which are too extensive to detail here. For more detailed information, see the guide on managing stages.

Packaging Plugins

Package Character

Usage: Plugins menu > BrawlInstaller Plugins > Package Character

Summary: Opens a form that allows you create or edit character packages.

This plugin uses forms with a variety of controls, which are too extensive to detail here. For more detailed information, see the guide on packaging characters.

File Plugins

Apply File Patch

Usage: Plugins menu > BrawlInstaller Plugins > Files > Apply File Patch

Summary: Allows you to select a .filepatch file and apply it to a file of your choosing.

This plugin allows you to apply a patch to a file in order to make changes to it without replacing the file in its entirety. You can find more information in the guide on comparing and patching files.

Compare Files

Usage: Plugins menu > BrawlInstaller Plugins > Files > Compare Files

Summary: Allows you to select two files and compare the differences between them, then either apply those differences to one of the files or export them as a .filepatch.

This plugin can perform a variety of different tasks that are too extensive to detail here. For more information, see the guide on comparing and patching files.

Create Build Patch

Usage: Plugins menu > BrawlInstaller Plugins > Files > Create Build Patch

Summary: Populates a form that allows you to edit .buildpatch files or create new ones, then save them to a desired location.

This plugin uses a form with a variety of controls too extensive to detail here. For more information, see the guide on build patches.

Install Build Patch

Usage: Plugins menu > BrawlInstaller Plugins > Files > Install Build Patch

Summary: Allows you to select a .buildpatch to automatically apply to your build.

This plugin locates all the files to be replaced or patched from a .buildpatch file and applies the appropriate changes to them. For more detailed information on how it works, see the guide on build patches.

Other Plugins

Output Fighter Info To Text

Usage: Plugins menu > BrawlInstaller Plugins > Output Fighter Info To Text

Summary: Creates a fighter_info.txt file in BrawlAPI/Resources/BrawlInstaller containing useful IDs for every character in your build.

This plugin will iterate through all of the EX configs in your build and print the fighter ID, name, cosmetic ID, franchise icon ID, soundbank ID, and victory theme ID of each fighter found to a fighter_info.txt file located in your /BrawlAPI/Resources/BrawlInstaller/ directory in the BrawlCrate root folder. This can be useful if you need a reference for what IDs are available.

All IDs printed are in decimal format except for EffectID, which is printed in hexadecimal format.

Restore Backup

Usage: Plugins menu > BrawlInstaller Plugins > Restore Backup

Summary: Allows you to restore a backup of your choosing, restoring all files that were modified or erased during execution of any of the plugins.

This plugin allows you to restore backups created when running the other plugins, such as installing or uninstalling characters. The plugins attempt to create backups of any file they modify, delete, or replace during execution, and these backups can be found in the /Backups/ folder in your BrawlCrate root directory. The last nine backups are stored - older backups are deleted when one of the plugins attempt to back something up.

When this plulgin is run, it will first check if any backups exist. If they do not, it simply displays a message and ends execution. If backups are found, the user will be displayed a list of options and prompted to enter a number associated with one of the backups in the list. Whichever backup the user selects will be restored to the user's build by copying every file within to it's respective directory into the build. Once execution completes, a message will be displayed indicating such.

⚠️ **GitHub.com Fallback** ⚠️