Settings - Gravemind2401/Reclaimer GitHub Wiki

The settings panel can be opened using the menu under Tools > Settings. The settings are grouped into sections that can be selected from using the drop-down at the top of the settings panel. The settings from each section are outlined below.

Table of Contents

Reclaimer

Setting Default Description
Auto Updates Check1 No Check for updates when Reclaimer starts
Max Recent Files Count 10 The maximum number of files to keep in the Recent Files menu
Restore Window State No If the Reclaimer window is maximized when you close it then it will start maximized next time you open it

1 Automatic update checks will happen a maximum of once per 12 hours. Update checks can be run manually using the Check for updates menu.

Batch Extractor

Setting Default Description
Auto Update Data Folder No When a folder is selected from the Data Folder Prompt it will be saved as the new Data Folder
Batch Worker Count 1 The number of files that can be extracted concurrently. Higher numbers will use more CPU.
Bitmap Format TIF The bitmap format to use for batch extractions
Bitmap Mode Default See below
Data Folder .\Plugins\Batch Extractor\ The folder that extracted files will be saved to
Data Folder Prompt Yes Show a confirmation popup to select the output folder each time a batch extraction is started
Folder Mode Hierarchy See below
Model Format AMF The model format to use for batch extractions
Overwrite Existing Yes When disabled, items will not be extracted if a file with the same name already exists

Bitmap Mode

This controls the way in which bitmaps are extracted.

  • Default: Each bitmap will be saved to a single 32-bit RGBA image.
  • Bgr24: Each bitmap will be saved to a single 24-bit RGB image.
  • IsolateAlpha: Each bitmap will be saved to two separate image files - one for RGB channels and one for the alpha channel. The files will be named {tag_name}_hue and {tag_name}_alpha respectively.
  • IsolateAll: Each bitmap will be saved to four separate image files - one for each channel. The files will be named as {tag_name}_{channel}.
  • MixedIsolate: If a bitmap name ends with _multi, _multipurpose or _cc (the underscore may also be a space) then IsolateAll is used. Otherwise, IsolateAlpha is used.

Folder Mode

Controls the subdirectory structure of extracted files.

  • Hierarchy: Tags will be extracted to a folder path the same as the tag name.
    • For example, a tag named objects\scenery\foliage\tree.bitmap would be saved to {data_folder}\objects\scenery\foliage\tree.tif.
  • TagClass: Tags will be extracted to a folder with the same name as their tag group.
    • For example, a tag named objects\scenery\foliage\tree.bitmap would be saved to {data_folder}\bitmap\tree.tif.
  • Hybrid: Tags will be extracted to a folder path which is their tag group name followed by the tag name.
    • For example, a tag named objects\scenery\foliage\tree.bitmap would be saved to {data_folder}\bitmap\objects\scenery\foliage\tree.tif.

Map Browser

Setting Default Description
Additional Map Folders Additional folders where the map browser will search for map files (other than Steam). The map browser will search each of these folders for any .map files, including subfolders, up to 3 levels deep.
Close After Selecting Map No Close the map browser after picking a map from the list
Show On Startup No Open the map browser as soon as Reclaimer starts
Steam Library Folder The "Steam Library" folder for the Steam Library that has MCC installed (not the MCC install folder itself). This will be the folder that has a steamapps subfolder. If this folder is not set correctly then no MCC maps will appear in the map browser.

Note that the map browser will not automatically search again if you change the folder settings. After changing folder settings, you will need to click the "Reload Map List" button in the bottom left of the map browser.

Map Viewer

Setting Default Description
Auto Update Maps Folder No Each time a map file is opened it’s parent folder will be saved as the new Maps Folder
Hierarchy View No Disable to group tags by type, enable to group tags by folder structure
Maps Folder The initial folder selected when browsing for a map file

Meta Viewer

Setting Default Description
Plugin Profiles (based on Assembly folder structure) See below
Plugins Folder The parent folder containing all per-game plugin folders
Show Invisibles No Show fields in the meta viewer even if they are marked as not visible

Plugin Profiles

Plugin profiles are used to determine which xml plugins should be loaded for any given map file. A map type can be included in multiple profiles to specify fallback profiles. This will cause the meta viewer to search the profiles list from top to bottom and use the first one with a matching xml file, allowing map types to have separate plugin folders but still have some plugins in common if nothing changed between builds.

Property Description
Subfolder The folder path, relative to the Plugins Folder, that the plugins for this profile are stored
Filename Format See below
Map Types A list of different types of map files this profile can be used for
Module Types A list of different types of Halo 5 module files this profile can be used for

Filename Format

This is the format of the plugin filenames. The filename format uses tokens that represent details of the tag that is being loaded.

  • {0} represents the tag group code, such as bitm
  • {1} represents the tag group name, such as bitmap
  • {0,-4} in the default setting represents the tag group code, but right-padded with spaces if it is shorter than 4 characters
  • If a tag group code contains characters that are not valid Windows filename characters, they will be substitued with _.

Model Viewer

Setting Default Description
Assimp Scale 0.03048 The scale to use when exporting models via Assimp (used for obj and collada exports)
Default Save Format RMF The initial 'Save as type' option when saving models from the Model Viewer
Embedded Material Extension tif The file extension used for texture file references saved as part of Assimp exports (obj and collada)

Module Viewer

Setting Default Description
Hierarchy View No Disable to group tags by type, enable to group tags by folder structure
Modules Folder The initial folder selected when browsing for a module file
Show Tag Resources This option enables tag resources to appear in the tag list for module files. Tag resources will be nested under the tag they belong to. This is useful for dumping resource data.
String IDs File The path to the "string IDs file"

String IDs File

In Halo Infinite module files, there are no tag names. Instead, each tag "name" will just be the ID of the tag. The string IDs file is used to look up tag names by ID. You can find a starting file to use here: https://github.com/Surasia/ReclaimerFiles

The string IDs file must be one string per line, in the format of stringIdNumber:path\to\tag\tag_name. Even if you don't know the actual tag names, you can use this file to provide your own tag names to help identify certain tags.

Pak Viewer

Setting Default Description
s3dpak Folder The initial folder selected when browsing for s3dpak files

Sound Extractor

Setting Default Description
FFmpeg Path .\Plugins\ffmpeg\ffmpeg.exe The path to ffmpeg.exe
Log FFmpeg Output No Enable to show ffmpeg console output in Reclaimer’s output panel
Output File Extension wav The file extension to use when creating sound files. FFmpeg will use this to determine any conversion that should be done. If left blank then no conversion will be done.
Output Filename Format {0}[{1}] See below

Output Filename Format

This controls format of the filenames of extracted sound files. A single sound tag can have multiple sound permutations in it. Each permutation is extracted into a separate file. The filename format uses tokens that represent details of each tag that is being extracted.

  • {0} will be replaced with tag name
  • {1} will be replaced with the permutation name
  • {2} will be replaced with the permutation index
  • The rest of the name will remain how it is in the setting. For example, using the default setting a sound file name could be tag_name[permutation_name].wav because the [] characters will not be replaced.
⚠️ **GitHub.com Fallback** ⚠️