This repo is no longer being maintained. Please get the new version of BrawlInstaller here.

BrawlInstaller Plugins

DEMO VIDEO (from an older version)

A BrawlCrate plugin suite for easy installation of Brawl mods into BrawlEX builds. Currently supports automatic installation of entire characters, including their cosmetics, as long as they are packaged in a .zip file with the correct structure.

Currently this plugin performs all the necessary installation to get an EX character fully playable in all modes, including Subspace Emissary, so long as your build supports Subspace Emissary Ex.

If you find any bugs or issues with the plugins, please check the FAQ below first. If the FAQ does not help, please submit them as an issue here on GitHub or message me about it directly on discord @ Squidgy#9561

Features

Install or uninstall fully playable characters and costumes into a build of Super Smash Bros. Brawl in just a few clicks.
Add, edit, and manage stages and music for your build using intuitive forms.
Extract characters from a build as fully installable packages - either individually or en masse.
Installed characters playable in all modes, including support for Subspace Emissary Ex.
Automatic detection and handling of conflicts on fighter IDs, names, soundbanks, Effect.pac IDs, and more.
Tools to compare BrawlCrate-compatible files and apply changes from one file to another.
Numerous settings to support many different kinds of builds.
Tools to easily list IDs already in use in a build.
Automatic backup and restore features in case of unintended results.
Logging features to help diagnose issues when they are encountered.
Support for Ex modules and several non-Ex modules (Lucario, Marth, Sonic, and Pit's patched PM module).

Installation

Simple Installation

If you do not already have BrawlCrate, download and install the latest release.
Navigate to the latest BrawlInstaller release and download the BrawlInstaller.Tools.Setup.exe. Run this installer and follow the on-screen instructions. Only install components not already present in your build.
In BrawlCrate, navigate to Tools > Settings > General and modify the Default Build Path to match the path you chose for the tools in step 2.
In BrawlCrate, navigate to Tools > Settings > Updater, click Manage Subscriptions, Add, and paste this link: https://github.com/squidgy617/BrawlInstallerPlugins, then hit Okay. If you set this up in BrawlCrate, the plugins will update automatically when you launch BrawlCrate.
Restart BrawlCrate.

Once you have completed these steps, you are ready to begin using the BrawlInstaller plugins.

Additionally, it's recommended to set up a git repository for your build like this template for an easy method of source control. BrawlInstaller does create automatic backups, so this is not necessary, but still recommended.

<details> <summary><h2>Manual Installation</h2></summary>

If you would prefer to install everything used by BrawlInstaller manually, you can follow these directions.

<b>Prerequisites</b>

In order for these plugins to function correctly, you will need a few things:

The latest version of BrawlCrate. You should also ensure you have your build path set to your build's root folder by navigating to Tools > Settings > General and modifying the "Default Build Path" there.
The latest version of Python. You can download this at python.org. Also ensure your Python path is set within BrawlCrate by navigating to Tools > Settings > BrawlAPI and setting the "Installation Path" field under "Python".
A BrawlEx build of Super Smash Bros. Brawl. It is strongly recommended to use these plugins with a build of Project+ EX, although it should technically be able to support other BrawlEx builds as well.
(OPTIONAL) The latest version of QuickLava's Kirby Hat Manager. You will want to ensure this is installed in your build's root folder (should be in the same directory as the /pf/ folder). This is necessary if you want Kirby hats to function correctly on P+ EX builds. You do not need to download this when using a build such as REMIX which already comes with it. If you install this, you will also need the Microsoft Visual C++ Redistributable.
(OPTIONAL) The latest version of QuickLava's fork of the P+ EX code menu. You will want to ensure this is installed in your build's root folder (should be in the same directory as the /pf/ folder). This is necessary if you want your character added to the code menu. You do not need to download this when using a build such as REMIX which already comes with it. You also should not use this if your build is designed around a different code menu. If you install this, you will also need the Microsoft Visual C++ Redistributable.
(OPTIONAL) The latest version of QuickLava's Sawnd ID Replace Assist. This can be anywhere on your computer. This is necessary if you want to be able to change soundbank IDs in the event of a conflict.
(OPTIONAL) The latest version of Codes' "Porting_Tools.zip", which is linked in the official BrawlEx Guide for P+ EX. This can be anywhere on your computer. This is necessary if you want to be able to change soundbank IDs or Effect.pac IDs in the event of a conflict.
(OPTIONAL) The latest version of Kapedani's Subspace Emissary Ex. This can be installed over your P+Ex build's root directory. This is only necessary if you are not on the latest P+Ex version and would like to install your characters into Subspace Emissary mode. If you want additional CSS slots for SSE, you can also download a basic expanded CSS here.
If you're trying to use the Install Character plugin, you'll need a proper character package .zip file. You can find an example package using CaliKingz01's RockmanX PSA and Shy's cosmetics here. You can also find a variety of character packages uploaded here.

<b>Setup</b>

For initial installation, you can set this repo as a subscription in BrawlCrate by navigating to Tools > Settings > Updater, clicking "Manage Subscriptions", and pasting this link: https://github.com/squidgy617/BrawlInstallerPlugins. If you set this up in BrawlCrate, the plugins will update automatically when you launch BrawlCrate. Alternatively, you can download the release manually and extract the contents to your BrawlCrate installation's "BrawlAPI" folder.

The plugins create backups of your files during execution, however, I cannot guarantee you will not run into issues, especially if you configure your settings incorrectly. If you want an extra safety net, I recommend setting up a git repository for your build like this template for an easy method of source control. With the automatic backup functionality, this is not really necessary, but still a good idea.

</details>

Guides

Character Packages

Character Packages available here.

The Install Character plugin works by extracting files from a "Character Package", a .zip file containing the fighter's files, cosmetics, etc. with a particular directory structure.

Character packages can be created manually or automatically using the "Package Character" plugin. There are also a few template packages that you can use to create your own. For more information, visit the wiki page.

Ideally, mod creators should create good character packages for you to use with this plugin, but if no package exists, anybody can create one using the previously mentioned plugin or templates.

[Plugins](https://github.com/squidgy617/BrawlInstallerPlugins/w

BrawlInstallerPlugins

Install / Use

README