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.

If you wish to add a character with the installer plugin, the character must be packaged in the correct way. This can be done manually (it is recommended that you use one of these templates) or by using the Package Character plugin in this suite, which is the recommended method. Character packages can also be extracted from a build using the Extract Character plugin, and those extracted packages can then be edited.

Some character packages can be found on BrawlVault here. There are also template packages available in the next section.

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.

Character packages can also come with a FighterSettings.txt file that declares various parameters for the fighter, usually for modifying Gecko codes. See the FighterSettings.txt section for more details.

DOWNLOAD: Rockman X (by CaliKingz01) Example Package

DOWNLOAD: Empty Template Package

These sample packages give an example of what a proper character package should look like. In both examples, every folder contains text files with additional instructions on how they should be used.

When packaging a character, you can include a "FighterSettings.txt" file in the root directory of the package. This is generated automatically if you use the "Package Character" plugin and set any values that go in this file.

All of the settings are also documented in the template packages.

The following settings are supported by the FighterSettings.txt file:

• throwReleasePoint - [Values : a comma-separated pair of float values] : The values used in the code ThrowN Fix and Throw Release Points v1.1c (Throw Animation Fix) [Magus]
• creditsThemeId - [Values : a song ID in hex format] : The song ID used for the credits theme of your character if you're using a vanilla credits theme. If you provide a credits theme, that will be installed instead of using the ID.
• lucarioBoneId - [Values : a bone ID in hex format] : The bone ID used in the code Lucario Clone Aura Sphere Bone ID Fix [Dantarion, ds22, PyotrLuzhin, Yohan1044, KingJigglypuff, Desi]
• lucarioKirbyEffectId - [Values : an Effect.pac ID in hex format] : The Effect.pac ID used for the Kirby hat for the code Kirby Lucario Clone Aura Sphere GFX Fix [ds22, DesiacX, Eon]
• jigglypuffBoneId - [Values : a bone ID in hex format] : The bone ID used in the code Jigglypuff Clone Rollout Bone Fix [codes, DesiacX]
• jigglypuffEFLSId - [Values : an EFLS ID in hex format] : The EFLS ID/index used in the code Jigglypuff Clone Rollout Max Charge GFX Fix [Codes, DesiacX]
• jigglypuffSfxIds - [Values : a comma-separated list of four SFX IDs in hex format] : The SFX IDs used in the code Jigglypuff Clone Rollout SFX Fix [codes, DesiacX]
• bowserBoneId - [Values : a bone ID in hex format] : The bone ID used in the code Bowser Clone Fire Breath Bone Fix [KingJigglypuff]
• trophyId - [Values : a trophy ID in hex format] : The ID of the trophy that will be assigned to the character when they are installed. This is meant to be used if you wish to assign your character a trophy that already exists in the game rather than give them an entire new trophy. If you are setting up a new trophy, do not set this.
• doorId - [Values : a Subspace door ID in hex format] : The ID of the door that must be passed through for the character to be unlocked in SSE mode. If left blank, character will be unlocked per conditions specified in build settings. In hex, this ID should match the GDOR ID displayed in BrawlCrate (e.g. a GDOR ID of 4900102 should be written here as 0x4900102)

When packaging a character, you can include a trophy with your fighter. If you elect to do so, you will also need a "TrophySettings.txt" file in the /Trophy/ directory of the package. This is generated automatically if you use the "Package Character" plugin and elect to include a trophy.

The settings in this file determine values for the trophy that appear in game, such as it's name and description.

Note that while adding trophies does appear to be stable at this time, the process is not fully understood, so this feature is considered experimental. Users have the option to opt out of installing them, though, so including them does not hurt.

All of the settings are also documented in the template packages.

The following settings are supported by the TrophySettings.txt file:

• trophyName - [Values : any string] : The name that will display when viewing the trophy.
• description - [Values : any string] : The description that will display when viewing the trophy. You can include <br/> anywhere in your description that you wish to place a line break.
• gameIcon1 - [Values : a game icon index, see below] : The index for the icon representing the system on which the character first appeared.
• gameIcon2 - [Values : a game icon index, see below] : The index for the icon representing the system on which the character last appeared.
• gameName1 - [Values : any string] : The name of the game in which the character first appeared.
• gameName2 - [Values : any string] : The name of the game in which the character last appeared.
• seriesIndex - [Values : a series index, see below] : The index for the series with which the character is associated.

Game Icon Indexes

Below is a list of valid values for the gameIcon1 and gameIcon1 settings, followed by the system the icon represents.

• 0 - None
• 1 - Nintendo 64
• 2 - Gamecube
• 3 - NES
• 4 - Famicom Disk System
• 5 - Nintendo DS
• 6 - Super Nintendo
• 7 - Gameboy Advance
• 8 - Gameboy
• 9 - Wii
• 10 - Game & Watch

Series Indexes

Below is a list of valid values for the seriesIndex setting, followed by the series the index represents.

• 0 - Super Smash Bros.
• 1 - The Subspace Emissary
• 2 - Super Mario Bros.
• 3 - Donkey Kong
• 4 - The Legend of Zelda
• 5 - Metroid
• 6 - Yoshi's Island
• 7 - Kirby Super Star
• 8 - Star Fox
• 9 - Pokemon
• 10 - F-Zero
• 11 - Mother
• 12 - Ice Climber
• 13 - Fire Emblem
• 14 - Kid Icarus
• 15 - WarioWare
• 16 - Pikmin
• 17 - Animal Crossing
• 18 - Game & Watch
• 19 - Others
• 20 - Metal Gear Solid
• 21 - Sonic the Hedgehog