master.sh

#!/usr/bin/env bash
# SPDX-License-Identifier: Unlicnese
# SPDX-FileCopyrightText: Copyright 2024 Guilherme M. Miranda <alchemist.software@proton.me>

# Bash strict mode - Exit early, instead of failing later
set -o errtrace
set -o errexit
set -o nounset
set -o pipefail

wad_checksum_error() {
    cat <<EOF >&2
Checksums did not verify for the Master Levels WAD files. Please make
sure that all files are copied from a Master Levels installation
directory, with their original upper-case names.
EOF
    exit 1
}

tar_checksum_error() {
    cat <<EOF >&2
Checksum did not math for the Master Levels tar archive.
Something went terribly wrong.
EOF
    exit 1
}

base_dir="${PWD}"
source_dir="${PWD}/source"
output_dir="${PWD}/output"
vcdiff_dir="${PWD}/vcdiff"
master_tar="${PWD}/master.tar"

vcdiff_vanilla="${vcdiff_dir}/masterpack-vanilla.vcdiff"
vcdiff_freedoom="${vcdiff_dir}/masterpack-freedoom.vcdiff"
vcdiff_psx="${vcdiff_dir}/masterpack-psx.vcdiff"

vcdiff="${vcdiff_dir}/masterpack.vcdiff"

wad_vanilla="${output_dir}/masterpack-vanilla.wad"
wad_freedoom="${output_dir}/masterpack-freedoom.wad"
wad_psx="${output_dir}/masterpack-psx.wad"

wad="${output_dir}/masterpack.wad"

cd "$source_dir"

sha256sum --status -c <<EOF 2>/dev/null || wad_checksum_error
SHA256 (ATTACK.WAD) = 4b9a404a4ee43ed33f7c2e208269b84b58ccfec5823afa1fe50e3dd08e927622
SHA256 (BLACKTWR.WAD) = a0120667412fcf293ea13cdc31c1fa0626d7828f83a195aa09f4170797d07473
SHA256 (BLOODSEA.WAD) = 1b1acb09f4319db32903dc502d84fc034d21611e375771f4aaac66fafabea39a
SHA256 (CANYON.WAD) = a2dd18d174d25a5d31046114bf73d87e9e13e49e9e6b509b2c9942e77d4c9ecf
SHA256 (CATWALK.WAD) = ce1241e16b2e8bb8bbceea84a281e81f865c52670e4eb3649dc7372870985b77
SHA256 (COMBINE.WAD) = fef0ac1090ba2f0bce92503625047d726c2d8d1964561bd557234e7ab6202dff
SHA256 (DOOM.WAD) = 6fdf361847b46228cfebd9f3af09cd844282ac75f3edbb61ca4cb27103ce2e7f
SHA256 (FISTULA.WAD) = 864d51febc039b1431c5d75fb051f567433adbddce4bb4d8b6e959fc0b414724
SHA256 (GARRISON.WAD) = 7a7a37d1f31c51ced17167f5283daffef27d79310df0c96b13f4cb1723a2417c
SHA256 (GERYON.WAD) = ec5c0b1b846764d4b7cc8038e5fac1b1562627d0bcca413a55e918d3141cbfbc
SHA256 (MANOR.WAD) = fe0a502310ef1b32597e2e82d6f7f12ad77cb603ac5838056dee86f4bae31e2f
SHA256 (MEPHISTO.WAD) = 585040c5408bc66583dbe1b8e36d009c81799f7dbebd002af48e4c00088bfbd5
SHA256 (MINOS.WAD) = fc3996e52b527dd4d7e76b023eebaa0c18263c94e21115b06ba64c8cda371ec0
SHA256 (NESSUS.WAD) = 05a2e5f7e13acfe21895f6ad2ecd216052d8c5c4bcb65b67745678ca0ae3e0dc
SHA256 (PARADOX.WAD) = 4e9f37b8209dc7006637050876d917e9a68b053ef24e17725432781b00969bdf
SHA256 (SUBSPACE.WAD) = 2c61963efe338abc38b13fb01f238fd95d6b0e2a627ca78db038b9761ff6e6ac
SHA256 (SUBTERRA.WAD) = 3dba2abcb85ae3685c259b21bd867d542439c591c12162a36066f1fbab6cbdd8
SHA256 (TEETH.WAD) = 629e2a6eb1a0234ef0f152384a01130b3d8cd0e44f6c292463dbc2d6ae34d14e
SHA256 (TNT.WAD) = c0a9c29d023af2737953663d0e03177d9b7b7b64146c158dcc2a07f9ec18f353
SHA256 (TTRAP.WAD) = 90c7d8fc103e7b02b9602d5eb37fa439da1c5880355e4ee9fa53428ef30dcf45
SHA256 (VESPERAS.WAD) = 14a515f480455a4bd23c8204d9d236c9ba18c147e8c10a364300832ee804fea3
SHA256 (VIRGIL.WAD) = c468a1684be8e8055fca52c0c0b3068893481dbaeff0d25f2d72a13b340dff09
EOF

# Make sure these files don't have the executable bit set, or the tar
# won't match the expected one for the patch.
chmod 644                                                                      \
    DOOM.WAD TNT.WAD                                                           \
    VIRGIL.WAD MINOS.WAD NESSUS.WAD GERYON.WAD VESPERAS.WAD                    \
    MANOR.WAD TTRAP.WAD                                                        \
    BLOODSEA.WAD BLACKTWR.WAD MEPHISTO.WAD TEETH.WAD                           \
    SUBSPACE.WAD COMBINE.WAD FISTULA.WAD SUBTERRA.WAD CATWALK.WAD GARRISON.WAD \
    PARADOX.WAD ATTACK.WAD CANYON.WAD

# Creates a tar file deterministically.
# See https://reproducible-builds.org/docs/archives/ for information.
tar --sort=name --mtime="2024-05-05 00:00:00Z" --owner=root --group=root       \
    --format=gnu --blocking-factor=20 --numeric-owner -cf "${master_tar}"      \
    DOOM.WAD DOOM2.WAD TNT.WAD                                                 \
    VIRGIL.WAD MINOS.WAD NESSUS.WAD GERYON.WAD VESPERAS.WAD                    \
    MANOR.WAD TTRAP.WAD                                                        \
    BLOODSEA.WAD BLACKTWR.WAD MEPHISTO.WAD TEETH.WAD                           \
    SUBSPACE.WAD COMBINE.WAD FISTULA.WAD SUBTERRA.WAD CATWALK.WAD GARRISON.WAD \
    PARADOX.WAD ATTACK.WAD CANYON.WAD

cd "${base_dir}"

sha256sum --status -c <<EOF 2>/dev/null || tar_checksum_error
SHA256 (master.tar) = 8a9bdb02828eeb927fe2785841889abe676868c9d2b586905e936897b117bdd0
EOF

if [ ! -d "$output_dir" ]; then mkdir "$output_dir"; fi

xdelta3 -d -f -s "${master_tar}" "${vcdiff_vanilla}"  "${wad_vanilla}"
xdelta3 -d -f -s "${master_tar}" "${vcdiff_freedoom}" "${wad_freedoom}"
xdelta3 -d -f -s "${master_tar}" "${vcdiff_psx}"      "${wad_psx}"

xdelta3 -d -f -s "${master_tar}" "${vcdiff}"          "${wad}"