Simple command line utilities for extracting data from Elder Scrolls and Fallout game files, from Oblivion to Fallout 76.

Note: For Starfield and Creation Engine 2, a fork of fo76utils has been created, ce2utils.

• baunpack - list the contents of, or extract from .BA2 or .BSA archives.
• bcdecode - convert BC1 to BC5 block compressed DDS textures to uncompressed RGBA image data in raw or DDS format. BC6H and BC7 decompression are also supported, using code from detex. bcdecode can also be used to convert from .hdr to .dds, and to pre-filter cube maps for use in PBR.
• btddump - extract terrain data from Fallout 76 .BTD files to raw height map, land textures, ground cover, or terrain color.
• cubeview - view cube maps or other textures from archive files.
• esmdump - list records from .ESM files in text or TSV format.
• esmview - interactive version of esmdump, also includes a NIF viewer for objects with an associated model (MODL).
• findwater - create a height map of water bodies, optionally using .NIF meshes for Skyrim and newer games.
• fo4land - extract landscape data from Oblivion, Fallout 3, Skyrim, and Fallout 4.
• landtxt - create an RGB land texture from the output of btddump (formats 2, 4, 6, and 8) or fo4land (formats 2, 4, and 5), or directly from terrain data in ESM/BTD file(s), using a set of DDS texture files.
• markers - find references to a set of form IDs defined in a text file, and mark their locations on an RGBA format map, optionally using DDS icon files.
• nif_info - list data from a set of .NIF files in .BA2 or .BSA archives, convert to .OBJ format, or render the model to a DDS file, or display it.
• render - render a world, cell, or object from ESM file(s), terrain data, and archives. Supports Fallout 76 and Fallout 4, and partly the older games (TES4/FO3/FNV are limited to terrain and water only).
• terrain - older and simpler program to render terrain and water only to an RGB image, using files created by btddump, findwater, or fo4land. Includes 2D and isometric mode.
• wrldview - interactive version of render.

Running any of the programs without arguments prints detailed usage information.

Windows and Linux binaries are automatically compiled on every update to the source code, using GitHub workflows. To download these as .zip archives, select the most recent successful "Build FO76Utils" workflow run on the GitHub Actions page, then either "build-linux" or "build-win" under Artifacts. Note that downloading the files requires logging in to GitHub.

The environment variable FO76UTILS_DATAPATH can be used to set the default input data path globally for all tools. If this environment variable is set, for example to "D:/SteamLibrary/steamapps/common/Fallout76/Data", then the paths Fallout76/Data and Fallout76/Data/SeventySix.esm can be replaced in all the example commands with "" and SeventySix.esm, respectively.

Can be built with MSYS2 (https://www.msys2.org/) on 64-bit Windows, and also on Linux. Run "scons" to compile. mman.c and mman.h are from mman-win32 (https://github.com/alitrack/mman-win32). All source code is under the MIT license.

Note: when downloading the source code with 'git clone', the --recurse-submodules or --recursive option needs to be added to also download libfo76utils:

git clone --recurse-submodules https://github.com/fo76utils/fo76utils.git

• Download and run the MSYS2 installer from https://www.msys2.org/.
• In the MSYS2 MSYS terminal, run these commands to install development packages:

  • pacman -Syu
    pacman -Su
    pacman -S --needed base-devel mingw-w64-x86_64-toolchain
    pacman -S msys/scons
    

• Optionally, install SDL 2 for cubeview, wrldview, and the NIF viewer mode of esmview and nif_info, matplotlib for plotting scripts, and SWIG for building the Python interface to libfo76utils:

  • pacman -S mingw64/mingw-w64-x86_64-SDL2
    pacman -S mingw64/mingw-w64-x86_64-python-matplotlib
    pacman -S mingw64/mingw-w64-x86_64-swig
    

• The installed MSYS2 and MinGW packages can be updated anytime by running pacman -Syu again.
• In the MSYS2 MinGW x64 terminal, compile the utilities with scons. Use scons -j 8 for building with 8 parallel jobs, and scons -c to clean up and delete the object files and executables. Running scons with the rgb10a2=1 option compiles all tools that can render NIF files with RGB10A2 frame buffer format, and adding pymodule=1 builds a Python interface to libfo76utils under scripts.
• If Visual Studio is also installed on the system, tools=mingw needs to be added to the scons options.
• By default, the code generated is compatible with Intel Sandy Bridge or newer CPUs. Adding avx=0 or avx2=1 disables instruction set extensions or also enables them for Haswell or newer, respectively.
• Optionally, for the makemap and icon extraction scripts only, download and install ImageMagick and SWFTools.

./btddump Fallout76/Data/Terrain/Appalachia.btd fo76hmap.dds 0 -80 -80 80 80 1
./btddump Fallout76/Data/Terrain/Appalachia.btd fo76ltex.dds 2 -80 -80 80 80 1
./btddump Fallout76/Data/Terrain/Appalachia.btd fo76gcvr.dds 4 -80 -80 80 80 1
./btddump Fallout76/Data/Terrain/Appalachia.btd fo76vclr.dds 6 -80 -80 80 80 2
./btddump Fallout76/Data/Terrain/Appalachia.btd fo76txts.dds 8 -80 -80 80 80
./findwater Fallout76/Data/SeventySix.esm fo76wmap.dds fo76hmap.dds Fallout76/Data
./landtxt fo76ltex.dds fo76ltx2.dds fo76txts.dds ltex/fo76.txt -d Fallout76/Data -gcvr fo76gcvr.dds -vclr fo76vclr.dds -mip 6
./terrain fo76hmap.dds fo76terr.dds 9216 6144 -ltex fo76ltx2.dds -light 150 100 35 -wmap fo76wmap.dds -watercolor 0x600A1A22

./btddump Fallout76/Data/Terrain/Appalachia.btd fo76hmap.dds 0 -80 -80 80 80 1
./findwater Fallout76/Data/SeventySix.esm fo76wmap.dds fo76hmap.dds Fallout76/Data
./landtxt Fallout76/Data/SeventySix.esm fo76ltx2.dds -d Fallout76/Data -r -80 -80 80 80 -l 1 -mip 6
./terrain fo76hmap.dds fo76terr.dds 9216 6144 -ltex fo76ltx2.dds -light 150 100 35 -wmap fo76wmap.dds -watercolor 0x600A1A22

./baunpack Fallout76/Data -- textures/interface/season/season

./esmdump Fallout4/Data/Fallout4.esm -u | python3 scripts/esmvcdisp.py -h 69 60 184 -

./esmview Skyrim/Data/Skyrim.esm Skyrim/Data skyrim_english -F tes5cell.txt

# list options
scons -f SConstruct.maps game=tes5 listvars=1
# build Skyrim map
scons -f SConstruct.maps game=tes5
# extract the map icons only
scons -f SConstruct.maps game=tes5 interface/tes5icon_02.dds

./nif_info -render1920x1080 glassdome.dds Fallout76/Data palaceofthewindingpath/palace_bld_glassdome01.nif
./nif_info -render1920x1080 44.dds Fallout76/Data weapons/44/44load.nif
./nif_info -view1920x1080 Fallout76/Data meshes/test/testpbrmaterials01.nif
./cubeview 1280 720 Fallout76/Data textures/shared/cubemaps/outsideoldtownreflectcube_e.dds

./render Fallout76/Data/SeventySix.esm whitespring.dds 4096 4096 Fallout76/Data -r -32 -32 32 32 -cam 0.125 54.7356 180 -135 53340 -99681 74002.25 -light 1.7 70.5288 135 -lcolor 1 0xFFFCF0 0.875 -1 -1 -ssaa 1 -rq 0x2F -ltxtres 512
./markers Fallout76/Data/SeventySix.esm fo76mmap.dds 4096,4096,0.125,54.7356,180,-135,4096,-256,16384 fo76icondefs.txt
./render Fallout76/Data/SeventySix.esm watoga.dds 9024 9024 Fallout76/Data -r 0 -71 71 0 -cam 0.25 180 0 0 146368.4 -141504.4 65536 -light 1.7 70.5288 135 -ssaa 1 -rq 0x2F -ltxtres 2048 -mip 1 -lmip 2