Managing Trophies - squidgy617/BrawlInstallerPlugins GitHub Wiki

This serves as a guide for managing trophies in your build using the BrawlInstaller plugin suite.

NOTE: It is not currently known how trophies with new IDs can affect save files. While no issues have been found during testing, be advised that using new IDs is considered experimental. If you wish to be absolutely safe, try to use existing IDs only instead of new ones.

Installing Trophies

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 > Install > Install Trophy.

Upon selecting the Install Trophy plugin, you will be presented with the following form:

image

At the top of the form, you the following ID fields:

  • Slot ID - If you wish to attach your trophy to a fighter, you can specify the fighter's slot ID here. If you do this and your build contains the code Clone Classic & All-Star Result Data V1.21 [ds22, Dantarion, DukeItOut], the new trophy will be used as the unlock when the specified fighter completes Classic or All-Star mode. Likewise, if you have SSE Ex, the trophy will be used for the game over screen for that fighter. If you do not wish to attach your trophy to a specific fighter, you may leave this field blank.
  • Trophy ID - The ID you would like to use for the trophy. If you leave this blank, the first unused trophy ID will be chosen. You can use the ID of an existing trophy to make it so your new trophy has the same unlock conditions as the original, effectively allowing you to add trophies without tying them to any fighter. It's not recommended to use the ID of a trophy that is tied to a fighter in Classic, All-Star, or SSE mode. This field has an ID Picker you can use to select a trophy.
  • Thumbnail ID - The ID to be used for the thumbnail of your new trophy, which are located in /pf/menu/collection/Figure.brres. If you leave this field blank, the first unused thumbnail ID will be selected for you, which is recommended. If you decide to fill in this field, it is recommended that you always pick a thumbnail ID that is not already in use, otherwise you may end up overwriting or reusing an existing thumbnail. This field has an ID Picker so you can see which IDs are already in use.

Below these fields you will find the trophy settings. These match up with the trophy settings section in the "Package Character" plugin. They are as follows:

  • Name - The name of the trophy as it appears in the trophy viewer.
  • Description - The description of your trophy as it appears in the trophy viewer.
  • Category - The category the trophy should appear under in the trophy viewer.
  • Game Icon 1 - An icon representing the first console the character appeared on. If you do not select an item from this list, it will default to "None".
  • Game Icon 2 - An icon representing the last console the character appeared on. If you do not select an item from this list, it will default to "None".
  • Game Name 1 - The name of the first game the character appeared in.
  • Game Name 2 - The name of the last game the character appeared in.
  • Series - The series the character is from, which determines what series the trophy is displayed under in the gallery. If you do not select an item from this list, it will default to "Others".
  • Thumbnail - The thumbnail for the trophy, as it appears in the gallery.
  • HD Thumbnail - This field is for including an HD thumbnail. At this time, this field is unused.

Once you've configured the settings how you'd like them, click the Install button. The form will close and there may be a brief pause before you receive a prompt indicating the trophy was installed successfully. If you configured your trophy correctly and set your trophy ID to match a trophy you've already unlocked, you should be able to find your new trophy in the appropriate location in the trophy gallery.

Uninstalling Trophies

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 > Uninstall > Uninstall Trophy.

When you run this plugin, you will see the following form:

image

This form is very simple, containing only the following two fields:

  • Slot ID - If you are uninstalling a trophy tied to a character, specify the character's slot ID here to ensure that the necessary changes are made to remove the trophy from them. This modifies the same items as the corresponding field in the Install Trophy plugin. If your trophy is not tied to a fighter, you may leave this field blank.
  • Trophy - The trophy you wish to remove. You cannot manually enter a value here, and must instead use the ID Picker attached to this field to populate a value.

Once you've entered your values, click the Uninstall button to uninstall the trophy. There may be a brief pause before you are presented with a prompt indicating success. If you did everything correctly and there were no errors, you should be able to see your trophy has been removed in-game.