Skip to content

Instructions

Jump to bottom
ak2yny edited this page Mar 19, 2024 · 20 revisions

Installation

  • Download the GUI.

  • To install, run self extracting archive OHSGUI-[version].exe and enter/paste or browse for the path to the OHS folder.

    • First Install OHS if it isn't already. The OHS folder should look like this (only OpenHeroSelect.exe and json2xmlb.exe are required, everything else is optional, incl. help_files folder, error.log, LICENCE.txt and Source Code.txt).
    • OHS and the GUI are portable, which means that they can be moved (in their entirety) to a different location at any time. However, portable programs cannot be used from locations that are synchronized with OneDrive.
    • Advanced users can alternatively use 7-zip to open OHSGUI-[version].exe, extract it and copy the extracted files to the OHS folder or copy the .exe and extract it in the OHS folder or extract it directly to the OHS folder. The GUI can also be used without OHS, but in order to be able to run OHS, it must be in the OHS folder.
    • The latest version is required. Existing settings are recognized.

  • In this OHS folder, find OpenHeroSelectGUI with the white S.H.I.E.L.D. icon and run it.

  • Optionally, make a shortcut of OpenHeroSelectGUI.exe in the location of your choice (e.g. Desktop).

    • For non-Desktop shortcuts, shift + right-click on the .exe and select 'Create shortcut'. The shortcut can then be moved anywhere (taskbar, start-menu, etc.).

    • The .exe can also simply be dragged & dropped to these locations (a link symbol will confirm that a link will be created - if the link symbol doesn't appear, hold shift + ctrl while dragging the file).

    • Important: Make sure to use OpenHeroSelectGUI.exe for shortcuts. The self extracting archive automatically creates a link in the OHS' main folder, but it can't be used for shortcuts.

    • Equally important: By default, the GUI is in the OHSGUI subfolder, but requires access to the main OHS folder. To apply this to the shortcut, define the start in field to point to the OHS' main folder:

      OpenHeroSelectGUI - Shortcut Properties 2023-08-01 4_38_19 PM

  • Optionally, add additional stage models for MUA:

The UI (User Interface)

  • The main part of this app is the roster creation UI for each game, X - Men Legends II (XML2) and Marvel Ultimate Alliance (MUA). Each has its own page which you can select on the leftmost side, the so called navigation pane. I'm calling these tabs.
  • The MUA tab differs from the XML2 tab. MUA has a stage selection with a menulocation layout, where we assign characters to, so they appear correctly in the stage background. XML2 has a simple list with a limit.

OHSGUI-SCAC-XML2 OpenHeroSelect GUI 2023-08-08 8_29_10 PM

  • In each game tab there are three main sections:
    • 1: The available characters list. This is a list of all files that are in the game's herostat folder. For MUA, that's 'mua/xml' by default. The folder (xml) can be changed in the settings tab. This can also be an absolute path (e.g. 'D:\Games\MUA\Mods\Herostats').
    • 2: The selected characters list. Characters that the user selects are added here. Each game has check-boxes to select which characters should be unlocked from the start. Custom characters are not unlockable otherwise, unless a mod does that (e.g. Improved Unlockables Mod). In MUA, there is a drop-down box, where you can select a stage effect for each character. Be warned: Only two effects can be hidden in the F12 character menu. There's a switch in MUA that enables more than two effects, but that shows all effects, except those on locations 03 and 24.
    • 3: The game specific settings. Here are switches to enable unlocks, select the limit or layout, and buttons to unlock all characters or starting the game.
  • The remaining space in the MUA tab is taken by the layout and stage model preview, including clickable locations.
  • In the XML2 tab, this space is used for an additional part to edit skins, which can be hidden.

Add characters

  • Install character mods to the game files or in Mod Organizer 2.
  • In the character mod's archive, find the herostat.txt. The name can vary. The file is usually in the archive's main folder or data folder. Check the mod archive's readme, if you can't find it.
  • Add the herostat.txt to OHS:
    • Place it in the herostatFolder (by default mua/xml for MUA). Rename the herostat. All files in this folder and its sub-folders will be available in the program.
    • Use the reload button to update the available characters when OpenHeroSelect GUI is running.
    • Alternatively, drag & drop a herostat on the available characters list on the left (tree view) or use the browse button ... above the list.
    • In file explorer, you can place herostats in sub-folders. Examples:
      • Creating xml/Ant-Man.txt will make Ant-Man available without tree-structure.
      • Creating xml/MCU/Ant-Man.txt will make Ant-Man available with a tree-structure, in the MCU sub-menu.
    • If you merged the GUI with the existing OHS you will already have all your previously added characters available.

Create a Roster

  • Navigate to the MUA or XML2 tab.
  • Build your roster by double-clicking on available characters on the left, or by dragging & dropping on either a location or the selected characters list on the right.
    • In the MUA tab, you can also click on a character and then on a location.
    • Replace characters by dragging new characters onto an occupied location (MUA), or by removing one from the list (select and delete) and adding the new one.
  • Manually save the roster for later or run OHS. Ways to save the roster:
    • Automatically, when OHS runs or the GUI is closed normally.
    • Press S on the keyboard.
    • Click on the Save button.
    • Click on the Save as... button or press Ctrl + S to save the roster with a custom name. (Note: This roster must be saved and restored through an .ini file, the location doesn't matter).

Build a Roster/Herostat

  • If you start the GUI for the first time and if the OHS settings are missing, you have to define the game's folder in the settings tab.
  • Click on Run OHS (or press Ctrl + R) to let OHS do its magic.
  • If there was an error, the GUI will open explorer and select the error.log.

Options

  • If you start the GUI for the first time, you have to define the game's folder in the settings tab (gear icon on the bottom left).
    • If all fields are empty, use the browse button ... next to the 'Game Installation Path' field.
      • Browse for the start-up .exe that is in the game's installation folder (by default it's Xmen.exe for XML2 and Game.exe for MUA).
      • The default installation folder is C:\Program Files (x86)\Activision\Marvel - Ultimate Alliance.
      • This will automatically fill the 'Game or Mod Path' field and set the correct .exe file for OHS.
    • Otherwise, use the browse button ... next to the 'Game or Mod Path' field.
      • The folder is the same as above, but you don't select the .exe, but the installation folder directly.
      • MO2 users will need to use this field and select an MO2 mod folder. Make sure that the selected folder has a data folder in it.
      • This field is filled automatically, if you merged the GUI with an existing OHS.
    • OHSGUI-SCAC-Options1
  • MO2 users can optionally, use the browse button ... next to the 'Game Installation Path' field, to select the .exe in a different location.
    • This can be the MO2 .exe.
    • Optionally, paste an argument into the 'Arguments for MO2' field (expand by clicking on the 'Game Installation Path' card). For example, "moshortcut://Marvel Ultimate Alliance:Marvel Ultimate Alliance Online Enabled" will automatically start the instance with the name Marvel Ultimate Alliance through the executable with the name Marvel Ultimate Alliance Online Enabled. MO2exe
  • Saved OHS settings will load automatically, if you merged the GUI with an existing OHS.
    • The rest of the settings are usually not important, but I recommend to leave most settings default or disabled.
    • You can enable to automatically start the game for example. This will apply when OHS runs, but not for MO2 users.
  • In each game tab, there are game specific options available.
    • Enable the unlock feature with a switch to update unlocks according to the unlock selection in the selected list. (Previous unlocks are retained if this option is disabled.)
    • For XML2 you can choose the roster size, for MUA you can select the stage layout and model.
    • For MUA you can enable or disable to update the stage, this will also affect the chosen effects.
    • For MUA you can also select how to handle the effects. If you care about the background in the F12 menu, you may want to enable this option. This will only enable the first two effects, because hidable effects are limited.
    • Load default characters or a random roster by clicking on the arrow next to the Load ... button underneath the selected list.
    • Here you can also find a button to run the game through the UI (user interface). This button works regardless whether you are an MO2 user or not, as long as the settings are correct.

Backups

  • The GUI will automatically save the selected characters and will continue with the same roster when launched next time.
  • To backup rosters externally, just copy the complete mua or xml2 folder.
    • If you manually save rosters with custom names, you may want to save them in the mua or xml2 folder, so that they are included in a backup. The roster files (.cfg) are always saved in the mua/rosters or xml2/rosters folder, even if the save location was chosen elsewhere.
  • To restore a saved roster manually:
    • Use the Load Settings button an browse for an .ini file that was saved with OHS or the GUI.
    • Alternatively, load roster .cfg files directly through the Load ... button underneath the selected list.
    • To restore a backup from the xml2 or mua folder, copy the folder back to the OHS folder. Replace existing files.

Skin Editor & Installer

  • Underneath the MUA and XML2 tabs (left page/tab selection pane), there is a 'Herostat Skin Editor' tab.
  • This is a limited herostat editor, which lets you modify the skin information of a character, with nearly no chance for errors, even if you don't know anything about modding.
  • The skin editor has the same available characters list as the other tabs.
  • To edit & install a skin:
    1. Select a character from the available characters list. This will show the skin information for this character.
      • Change the skin details here, for example the skin name in the big fields.
      • To remove a skin, click on the 'Delete' button or press the Del key. Warning: Steps can't be undone.
      • To add a skin, click on the + button on the bottom. If there's no +, this means that no more skins can be added.
      • The skin order can be changed by dragging and dropping skins (click outside of the text fields).
      • Changes aren't saved until the Save button's pressed.
      • To restore the last saved skin details, select a different character from the available characters list, then select the same (previous) character again.
    2. Select a skin from the skin list. This will show the 'Skin Installer'.
      • This must be done by clicking outside of the text fields, but not on the 'Delete' button.
      • It's best to click on the character number on the left of skin details (this is save, even though a 'Delete' tool tip may pop up).
    3. Click on the first browse button ... to browse for a skin file.
      • This file will automatically be renamed and copied to the correct location.
      • Additionally, the skin installer will try to search and clone a package if necessary. MO2 users might not have access to packages and an information about potentially missing packages might show.
      • It's highly recommended to not change or add skin numbers. Instead, change skin names and the order only. This will replace skins on installation, which is the preferred method.
        • Skins installed with this method (replace) won't have issues with packages. A potential packages message can be ignored.
        • On the other hand, skins that were added or had their numbers changed, might cause issues in game, if a packages message appears.
        • Additionally, skins with added numbers might conflict with other characters that share their character number, or with skins that other characters use to shape-shift.
      • Skins will automatically be hex-edited.
      • If a working Alchemy 5 installation's found, the skin installer will attempt to fix the skin for the platform, which can be selected in the drop-down box.
      • After installation, an information box will show and mark problematic properties in red for the platform (MUA PC skins only show a red info if the skin isn't hex-edited).
      • When installing a skin, hud heads that are named identically to the skin will be automatically installed as well. For example: if the skin 'Hyperion_MFF.igb' is installed and the file 'hud_head_Hyperion_MFF.igb' exists in the same folder, it's automatically installed.
  • OHSGUI-SCAC-SkinInstaller1
  • To install hud heads:
    • Repeat the steps to install a skin, but press on the browse button ... right of the button for skins.
    • Usually, you press this button, right after installing a skin (steps i. and ii. are not necessary).
  • To install mannequins (selection portraits in XML2):
    1. Select a character to show the skin information.
    2. Select any skin to show the 'Skin Installer'.
    3. Click on the browse button ... next to 'Install select item ...'.
    • A skin may be selected already, in which case steps i. and ii. can be skipped.
  • To install swap skins for shapeshifters:
    • Repeat the steps to install a skin, but press on the browse button ... next to 'Install swap skin'.
    • Usually, you press this button, right after installing a skin (steps i. and ii. are not necessary).
    • For Emma Frost's Diamond Form, click on the button with her icon. A tool tip shows which skin number it will be installed to. Attention: if a skin number in the herostat uses a Diamond Form number, a Diamond Form skin won't be installed.
    • For Human Torch's Flame On skins, click on the button with his icon. A tool tip shows which skin number it will be installed to. Attention: the number is just the skin number plus 10, which might conflict with another skin.
    • For other shapeshifter skins, click on the browse button ... and enter a number for the target skin. Then, click 'OK' and browse for a skin. Note: Only skins with the character number can be installed this way. Other skins (e.g. NPC skins) have to be installed manually.
  • OHSGUI-SCAC-SkinInstaller2

Herostat Splitter

  • The 'Herostat Splitter' is on the right in the 'Herostat Skin Editor' tab.
  • Use it to browse for a compiled (.engb) or decompiled (.xml) herostat and have it split into individual herostats for OHS.
  • To do so:
    1. Click on Load Herostat....
    2. Browse for a herostat file (.engb or decompiled as .xml/.txt) and click 'Open'.
  • The splitter automatically creates a new folder with the split herostats and names the herostats if possible. It also automatically creates a roster and menulocation file. The names are given using the current date and time.
  • By default, the herostats are added to the herostats folder (xml).
    • Optionally, the output folder can be chosen with the browse button ....
    • The reset button sets the output folder back to the herostats folder (xml). Initially, and if the field is empty, this also defaults to the herostats folder.
  • Split herostats are now available in the available characters list.
  • This allows editing and installing skins through the GUI. To build the roster back to the .engb, the roster must be selected from the .cfg file (named after the date and time of splitting).
  • Files (herostats, roster, menulocations) can be manually renamed in Explorer.

Team Bonus Editor

  • Underneath the 'Herostat Skin Editor' tab (left page/tab selection pane), there is a 'Team Bonus Editor' tab.
  • This is a full team bonus file editor, which lets us change the team bonus names and bonuses and change members.
  • The editor functions similar to the skin editor, which is why this section is currently incomplete.
  • To remove a team member, press Del while it's selected.
  • To add a team member, drag and drop it from the selected characters list. A bonus must be selected first.
    • Only characters from the current roster can be added.
    • Previously added characters remain
  • Team bonus limits are automatically controlled by the editor.
  • A skin filter can be added. Note: MUA filters allow any number. If this number is not in the character's current herostat, the bonus won't apply (for this character).
  • The team bonus settings are automatically saved when running OHS or closing the GUI. They are manually saved together with saving settings/rosters (shortcuts S or Ctrl + S).
  • Team bonuses are automatically copied to the game files when OHS runs.
Clone this wiki locally