Generating dumps

While simply applying the scripts to the right records will achieve dumps equivalent to those found in this repository, there is a reproducible procedure that may be followed to recreate the dumps.

Requirements

1. Install the latest version of xEdit. Download the latest version from NexusMods and extract the archive in the Fallout 76 installation folder.
2. Download the source code of this repository's latest version. Copy the files inside the Edit scripts directory over to the Edit scripts directory created by xEdit in the Fallout 76 installation directory.
   Do not move the scripts into a subdirectory of Edit scripts because then xEdit will be unable to find some scripts.

Run one script

If you want to run only a selection of dump scripts, follow the procedure below for each script you want to run.

1. Find the relevant records
   Most scripts apply only to records with a particular signature. For each plugin, xEdit lists the records with a given signature under the appropriate heading. Expand the headers for the relevant records in each plugin.
2. Select the relevant records
   Select the headers that correspond to the records expected by the script. Hold Ctrl while clicking a header to add it to your current selection.
3. Apply the script
   Right-click one of the headers that you have selected, click Apply Script..., select the desired script from the drop-down list, and press the OK button.
4. Let it run
   Wait for the script to complete. A message will be displayed in the Messages tab on the right side of xEdit once the script has finished executing. Additionally, the title of the xEdit window will change back to FO76Edit after the script has finished executing. Most scripts take a few minutes; ExportTabularIDs.pas takes a few hours.
5. Inspect the generated files
   Check the files in the dumps/ directory in the root directory of Fallout 76. If the script has created multiple files (ending in .001, .002, etc.), use a tool such as HJ-Split to join the files.

Run all scripts

// WIP //