Update CONTRIBUTING.md

chore: update symlink hash logic

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -5,6 +5,10 @@ labels: ["bug"]
 assignees:
   - aclist
 body:
+  - type: markdown
+    attributes:
+      value: |
+          ### WARNING: When posting log/config data, redact any sensitive information like API keys.
   - type: checkboxes
     id: kb
     attributes:

.github/ISSUE_TEMPLATE/trouble.yml

@@ -5,6 +5,10 @@ labels: ["troubleshooting"]
 assignees:
   - aclist
 body:
+  - type: markdown
+    attributes:
+      value: |
+          ### WARNING: When posting log/config data, redact any sensitive information like API keys.
   - type: dropdown
     id: device
     attributes:

.github/workflows/mirror.yml

@@ -8,7 +8,7 @@ jobs:
   mirror-to-codeberg:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - uses: pixta-dev/repository-mirroring-action@v1

.gitignore

@@ -1 +1,4 @@
 tags
+__pycache__
+pre-commit
+tests/

CHANGELOG.md

@@ -1,5 +1,157 @@
 # Changelog
 
+## [6.0.6-beta.1] 2026-05-17
+## Changed
+- Update symlink hash logic to align with DZGUI 7 beta
+- Update A2S helper to latest commit
+
+## [6.0.5-beta.2] 2026-04-17
+## Changed
+- During server connection attempts, only download mods local to specific server
+
+## [6.0.5-beta.1] 2026-04-13
+## Fixed
+- Update A2S module checksums to support servers with missing description field
+## Changed
+- Bump version to reflect hotfixes on stable branch
+
+## [6.0.2-beta.5] 2026-04-12
+## Fixed
+- Use conditional logic when testing GLibUnix namespaces
+
+## [6.0.2-beta.4] 2026-04-10
+## Fixed
+- Use GLibUnix namespace when setting up SIGINT handling
+
+## [6.0.2-beta.3] 2026-01-26
+## Fixed
+- Raise error correctly from module
+
+## [6.0.2-beta.2] 2026-01-18
+## Fixed
+- Helpers not being downloaded (uncommented boilerplate)
+
+## [6.0.2-beta.1] 2026-01-18
+## Fixed
+- Do not spawn dialogs from inside of thread when fetching prereqs
+## Changed
+- Optimize time complexity of startup checks
+- Optimize coordinate calculation by using local records first
+- Rename some internal functions
+- Wrap entire startup process in dialog
+
+## [6.0.1-beta.1] 2026-01-16
+## Fixed
+- Explicitly use Python 3.13 when calling subprocesses
+
+## [6.0.0-beta.20] 2026-01-14
+## Fixed
+- Write cache file after wiping
+
+## [6.0.0-beta.19] 2026-01-14
+## Fixed
+- Steam Deck compatible script path expansion
+
+## [6.0.0-beta.18] 2026-01-14
+## Fixed
+- Update UI checksums
+
+## [6.0.0-beta.17] 2026-01-14
+## Added
+- More descriptive help dialogs when initial dependencies are missing
+
+## [6.0.0-beta.16] 2026-01-04
+## Fixed
+- Regression introduced in previous hotfix
+
+## [6.0.0-beta.15] 2025-12-27
+## Fixed
+- Path discovery during first-time setup when parsing filepaths with whitespaces
+- First-time setup dialog continuously triggering when DayZ install path had whitespaces in it
+
+## [6.0.0-beta.14] 2025-12-09
+## Fixed
+- Dialogs with newlines breaking output in log table
+
+## [6.0.0-beta.13] 2025-11-29
+## Fixed
+- Server filter panel not being hidden when entering other page contexts
+- Path to remote changelog being constructed incorrectly
+
+## [6.0.0-beta.12] 2025-11-14
+## Changed
+- Require Python 3.13
+## Fixed
+- Normalize beta version
+
+## [6.0.0-beta.11] 2025-11-13
+## Added
+- Support sandboxed flatpak
+
+## Changed
+- Preferred client from radio toggle to combobox
+
+## Fixed
+- Config file erroneously getting updated when populating settings menu
+
+## [6.0.0-beta.10] 2025-11-10
+## Fixed
+- Python 3.14 error in finally block
+- Require Python version between 3.11 and 3.12
+
+## [6.0.0-beta.9] 2025-11-05
+## Fixed
+- UI not being constructed correctly if CHANGELOG.md was missing
+
+## [6.0.0-beta.8] 2025-11-04
+## Added
+- Internal flag to allow distribution packaged releases to disable in-app updates
+- Pre-boot check to test whether script was invoked directly
+- Commandline usage help text
+
+## Fixed
+- ESC key destroying wait dialogs while a thread is pending
+- Tooltip signals being erroneously drawn on main menu
+- Leaky variable name in dialog titles
+- Prevent extraneous signals from propagating when column width is adjusted
+- Script failing to start when remote endpoints are unavailable (GaryBlackbourne)
+
+## Changed
+- Optimize time complexity of pre-boot checks (GaryBlackbourne)
+- Moved location of notes file
+- Rewrote distance calculation module (GaryBlackbourne)
+
+## [6.0.0-beta.7] 2025-09-20
+## Added
+- Users can save text notes to describe servers
+
+## Changed
+- State file serialization methods
+
+## [6.0.0-beta.6] 2025-09-12
+## Added
+- Support DayZ Experimental
+- Show additional client information in Options menu
+- Warn user of client version mismatches
+- Support clickable hyperlinks
+
+## Fixed
+- Mods rarely not appearing in local mod list if download completed too quickly
+- Statusbar not updating when clicking a row after spamming keyboard input
+- Extraneous logs being generated when subscribing to mods
+- Narrow width of columns in modlist dialogs occluding text
+- Newline terminators in history file
+- Floating point number calculation
+- Window resizing too small if no prior resolution was set
+
+## [6.0.0-beta.5] 2025-08-20
+## Fixed
+- Servers returning malformed A2S_INFO blocking server browser from loading
+
+## [6.0.0-beta.4] 2025-08-13
+## Fixed
+- Branch toggle signal being emitted when entering Options menu from other contexts
+
 ## [6.0.0-beta.3] 2025-08-08
 ## Added
 - Additional server metadata to details dialog
@@ -13,6 +165,9 @@
 - Prevent debug button from activating when in certain input fields
 - Window size not updating correctly when unmaximizing window after changing "fullscreen at boot" setting
 
+## Dropped
+- Extraneous information from right statusbar
+
 ## [6.0.0-beta.2] 2025-07-29
 ## Fixed
 - Missing parameters when closing application via window decorations

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Introduction
+
+Thank you for your interest in DZGUI!
+
+This guide goes over development conventions and best practices for contributors.
+If you are a developer, you can skip to the end.
+
+# Requesting help
+
+If you encounter a problem with DZGUI, you can submit tickets on the GitHub
+[issue tracker](https://github.com/aclist/dztui/issues) under the
+`troubleshooting` tag.
+
+# How can I help the project?
+
+There are several ways to help this project.
+1. Report bugs that you find
+2. Request features that you would like
+3. Contribute features and fixes to the codebase
+4. Contribute documentation to the project
+
+Before making any contribution, please read the `CODE_OF_CONDUCT.md` and act
+accordingly.
+
+## Submitting a ticket
+
+Navigate to the GitHub [issue tracker](https://github.com/aclist/dztui/issues).
+From there, follow the onscreen prompts. You will be asked questions such as:
+
+- What version are you using?
+- What distribution are you using?
+- What is the issue that you found?
+- How can we reproduce the issue?
+
+You can also attach screenshots, logs, or other data that can help us.
+
+## Requesting a feature
+
+You can also request features via the same issue tracker. It is good practice to
+first search for your idea to see if a similar one has already been posted.
+If not, open a ticket where you describe your feature and its possible benefits.
+
+Please note that this is a community project, so it takes time for us to develop
+features. Putting in a feature request does not mean that it will be implemented,
+but we will do our best to support as many cool ideas as possible.
+
+## Contributing code or documentation
+
+If you would like to take ownership or assist with an issue on the issue tracker, or
+contribute a new change, please follow the guidelines below.
+
+Fork this repository and check out the code up to `prerelease/<latest-version>`.
+If there is no pending prerelease PR, you can base your changes off of
+the `testing` branch. You may later be asked to retarget your PR to the prerelease
+branch once a new one is made. This is because out-of-band PRs are consolidated into
+the next release before merging.
+
+The following naming conventions apply for PRs:
+- fix/<your-fix> - patch/hotfix branches
+- feat/<your-feature> - feature branches
+- doc/<your-doc-branch> - documentation branches
+- infra/<your-infra-branch> - infrastructure branches
+
+Implement your changes and test them locally. If they work you may
+open a merge request, and then we review your changes. If everything is OK, it
+will be merged to `prerelease/<latest-version>`, then `testing`, and after a live
+testing phase, to `stable` as well.
+
+It is recommended to follow
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), as this
+integrates well with tooling and helps the project review your code.

README.md

@@ -11,6 +11,15 @@ This overcomes certain limitations in the Linux client and helps prepare the gam
 - Concatenate launch options to pass to Steam
 - Connect to mod-enabled LAN servers
 
+## Design philosophy
+
+DZGUI follows a specific set of guidelines, enumerated below:
+
+- Provide a free and open-source tool under GPL
+- Do not use undocumented, third-party servers to aggregate data; no central "DZGUI" server
+- All connections go to Steam and DayZ servers directly; the tool should function in perpetuity without intermediary endpoints
+- Target Linux desktop and Steam deck specifically; not a cross-platform tool
+
 ## Setup and usage
 
 Refer to the documentation for installation and setup instructions:
@@ -18,7 +27,6 @@ Refer to the documentation for installation and setup instructions:
 - [GitHub](https://aclist.github.io/dzgui/index.html)
 - [Mirror (Codeberg)](https://aclist.codeberg.page)
 
-
 ![A screenshot of DZGUI](/images/example.png)
 
 ## Attribution

dzgui.sh

@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
 set -o pipefail
 
-version=6.0.0.beta-3
+src_path="$(readlink -e "$0")"
+version=6.0.6-beta.1
 
 #CONSTANTS
 aid=221100
@@ -39,6 +40,7 @@ cols_file="$state_path/$prefix.cols.json"
 
 #CACHE FILES
 coords_file="$cache_path/$prefix.coords"
+src_path_file="$cache_path/$prefix.src"
 
 #legacy paths
 hist_file="$config_path/history"
@@ -63,17 +65,14 @@ testing_url="$url_prefix/testing"
 releases_url="https://github.com/$author/$repo/releases/download/browser"
 km_helper_url="$releases_url/latlon"
 
-
 set_im_module(){
     #TODO: drop pending SteamOS changes
-    pgrep -a gamescope | grep -q "generate-drm-mode"
-    if [[ $? -eq 0 ]]; then
-        GTK_IM_MODULE=""
+    if pgrep -a gamescope | grep -q "generate-drm-mode"; then
+        unset GTK_IM_MODULE
         logger INFO "Detected Steam Deck (Game Mode), unsetting GTK_IM_MODULE"
-    else
-        return
     fi
 }
+
 redact(){
     sed 's@\(/home/\)[^/]*@\1REDACTED@g'
 }
@@ -87,13 +86,21 @@ logger(){
     printf "%s␞%s␞%s::%s()::%s␞%s\n" "$date" "$tag" "$self" "$caller" "$line" "$string" \
         | redact >> "$debug_log"
 }
+
 setup_dirs(){
-    for dir in "$state_path" "$cache_path" "$share_path" "$helpers_path" "$freedesktop_path" "$config_path" "$log_path"; do
-        if [[ ! -d $dir ]]; then
-            mkdir -p "$dir"
-        fi
+    directories=()
+    directories+=("$state_path")
+    directories+=("$cache_path")
+    directories+=("$share_path")
+    directories+=("$helpers_path")
+    directories+=("$freedesktop_path")
+    directories+=("$config_path")
+    directories+=("$log_path")
+    for dir in "${directories[@]}"; do
+        mkdir -p "$dir"
     done
 }
+
 setup_state_files(){
     if [[ -f "$debug_log" ]]; then
         rm "$debug_log" && touch $debug_log
@@ -104,13 +111,13 @@ setup_state_files(){
         logger INFO "Migrating legacy version file"
     fi
     # wipe cache files
-    local path="$cache_path"
-    if find "$path" -mindepth 1 -maxdepth 1 | read; then
-        for file in $path/*; do
+    if [[ $(ls -A "$cache_path") ]]; then
+        for file in "$cache_path"/*; do
             rm "$file"
         done
         logger INFO "Wiped cache files"
     fi
+    echo "$src_path" > "$src_path_file"
 }
 print_config_vals(){
     local keys=(
@@ -132,10 +139,10 @@ print_config_vals(){
 
 }
 test_gobject(){
-    python3 -c "import gi"
+    python3.13 -c "import gi"
     if [[ ! $? -eq 0 ]]; then
         logger CRITICAL "Missing PyGObject"
-        fdialog "Requires PyGObject (python-gobject)"
+        quit_with_help_dialog "Requires PyGObject (python-gobject)"
         exit 1
     fi
     logger INFO "Found PyGObject in Python env"
@@ -214,17 +221,14 @@ default_steam_path="$default_steam_path"
 
 #Preferred Steam launch command (for Flatpak support)
 preferred_client="$preferred_client"
-
-#DZGUI source path
-src_path="$src_path"
 END
 }
 depcheck(){
     for dep in "${!deps[@]}"; do
-        command -v "$dep" 2>&1>/dev/null
-        if [[ $? -eq 1 ]]; then
+        if ! command -v "$dep" &> /dev/null; then
             local msg="Requires $dep >= ${deps[$dep]}"
-            raise_error_and_quit "$msg"
+            echo "$msg"
+            exit 1
         fi
     done
     local jqmsg="jq must be compiled with support for oniguruma"
@@ -233,14 +237,31 @@ depcheck(){
     [[ $? -ne 0 ]] && raise_error_and_quit "$jqmsg"
     logger INFO "Initial dependencies satisfied"
 }
+open_url(){
+    url="$1"
+    if [[ -n "$BROWSER" ]]; then
+        logger INFO "Opening '$url' in '$BROWSER'"
+        "$BROWSER" "$url"
+    else
+        logger INFO "Opening '$url' with xdg-open"
+        xdg-open "$url"
+    fi
+}
+quit_with_help_dialog(){
+    local sel
+    msg="$1"
+    help_button="Open help page"
+    url="https://aclist.github.io/dzgui/installation.html"
+    logger CRITICAL "$msg"
+    sel=$(zenity --info --extra-button="$help_button" --text="$msg")
+    [[ $sel == "$help_button" ]] && open_url "$url" &
+    exit 1
+}
 check_pyver(){
-    local pyver=$(python3 --version | awk '{print $2}')
-    local minor=$(<<< $pyver awk -F. '{print $2}')
-    if [[ -z $pyver ]] || [[ ${pyver:0:1} -lt 3 ]] || [[ $minor -lt 10 ]]; then
-        local msg="Requires Python >=3.10"
-        raise_error_and_quit "$msg"
+    if [[ ! $(python3.13 --version) ]]; then
+        local msg="Requires Python 3.13"
+        quit_with_help_dialog "$msg"
     fi
-    logger INFO "Found Python version: $pyver"
 }
 watcher_deps(){
     if [[ ! $(command -v wmctrl) ]] && [[ ! $(command -v xdotool) ]]; then
@@ -314,6 +335,8 @@ check_unmerged(){
     fi
 }
 check_version(){
+    echo "# Checking version"
+    [[ -n $reference_branch ]] && return
     local version_url=$(format_version_url)
     local upstream=$(curl -Ls "$version_url" | awk -F= '/^version=/ {print $2}')
     local res=$(get_response_code "$version_url")
@@ -377,10 +400,11 @@ prompt_dl(){
 dl_changelog(){
     local mdbranch
     local md
+    source "$config_file"
     [[ $branch == "stable" ]] && mdbranch="dzgui"
     [[ $branch == "testing" ]] && mdbranch="testing"
-    local md="$url_prefix/${mdbranch}/$file"
-    curl -Ls "$md" > "$state_path/CHANGELOG.md"
+    local changelog="$url_prefix/${mdbranch}/CHANGELOG.md"
+    curl -Ls "$changelog" > "$state_path/CHANGELOG.md"
 }
 test_display_mode(){
     pgrep -a gamescope | grep -q "generate-drm-mode"
@@ -391,6 +415,7 @@ test_display_mode(){
     fi
 }
 check_architecture(){
+    echo "# Checking system architecture"
     local cpu=$(< /proc/cpuinfo awk -F": " '/AMD Custom APU [0-9]{4}$/ {print $2; exit}')
     read -a APU_MODEL <<< "$cpu"
     if [[ ${APU_MODEL[3]} != "0932" ]] && [[ ${APU_MODEL[3]} != "0405" ]]; then
@@ -407,6 +432,7 @@ check_architecture(){
     logger INFO "Setting architecture to 'Steam Deck'"
 }
 check_map_count(){
+    echo "# Checking map count"
     [[ $is_steam_deck -gt 0 ]] && return 0
     local map_count_file="/proc/sys/vm/max_map_count"
     local min_count=1048576
@@ -456,6 +482,7 @@ tdialog(){
     $steamsafe_zenity --info --text="$1" "${zenity_flags[@]}"
 }
 steam_deps(){
+    echo "# Checking Steam"
     local flatpak
     local steam
     [[ $(command -v flatpak) ]] && flatpak=$(flatpak list | grep valvesoftware.Steam)
@@ -464,50 +491,64 @@ steam_deps(){
         local msg="Found neither Steam nor Flatpak Steam"
         raise_error_and_quit "$msg"
         exit 1
-    elif [[ -n "$steam" ]] && [[ -n "$flatpak" ]]; then
-        [[ -n $preferred_client ]] && return 0
-        if [[ -z $preferred_client ]]; then
-            preferred_client="steam"
-        fi
-    elif [[ -n "$steam" ]]; then
-        preferred_client="steam"
-    else
-        preferred_client="flatpak"
     fi
-    update_config
-    logger INFO "Preferred client set to '$preferred_client'"
-}
-migrate_files(){
-    if [[ ! -f $config_path/dztuirc.oldapi ]]; then
-        cp $config_file $config_path/dztuirc.oldapi
-        logger INFO "Migrated old API file"
-    fi
-    [[ ! -f $hist_file ]] && return
-    rm $hist_file
-    logger INFO "Wiped old history file"
 }
 stale_symlinks(){
+    echo "# Cleaning stale symlinks"
     local game_dir="$steam_path/steamapps/common/DayZ"
-    for l in $(find "$game_dir" -xtype l); do
-        logger DEBUG "Updating stale symlink '$l'"
-        unlink "$l"
+    readarray -t links < <(find "$game_dir" -xtype l)
+    for link in "${links[@]}"; do
+        logger DEBUG "Updating stale symlink '$link'"
+        unlink "$link"
     done
 }
+
+check_availability() {
+    if [[ -z $1 ]]; then
+        return 1
+    fi
+    local url=$1
+    local timeout_sec="1"
+    if [[ $2 ]]; then
+        timeout_sec=$2
+    fi
+    if ! ping -w "$timeout_sec" "$url" > /dev/null 2>&1; then
+        logger WARN "Failed to reach $url, service may be down."
+        return 1
+    fi
+}
+
 local_latlon(){
+    echo "# Checking coordinates"
     if [[ -z $(command -v dig) ]]; then
-        local local_ip=$(curl -Ls "https://ipecho.net/plain")
+        local url_ipecho="https://ipecho.net/plain"
+        if ! check_availability "ipecho.net"; then
+            logger WARN "Failed to get external ip address, ipecho.net service may be down."
+            return 1
+        fi
+        local local_ip=$(curl -Ls "$url_ipecho")
     else
+        # TODO : implement checking remote
         local local_ip=$(dig -4 +short myip.opendns.com @resolver1.opendns.com)
     fi
-    local url="http://ip-api.com/json/$local_ip"
-    local res=$(curl -Ls "$url" | jq -r '"\(.lat)\n\(.lon)"')
+    if calc_local_coords "$local_ip"; then
+        return 0
+    fi
+    local url_ip_api="http://ip-api.com/json/$local_ip"
+    if ! check_availability "ip-api.com"; then
+        logger WARN "Failed to get local coordinates, ip-api.com service may be down."
+        return 1
+    fi
+    local res=$(curl -Ls "$url_ip_api" | jq -r '"\(.lat)\n\(.lon)"')
     if [[ -z "$res" ]]; then
         logger WARN "Failed to get local coordinates"
         return 1
     fi
     echo "$res" > "$coords_file"
 }
+
 lock(){
+    echo "# Setting up lock file"
     [[ ! -f $lock_file ]] && touch $lock_file
     local pid=$(cat $lock_file)
     ps -p $pid -o pid= >/dev/null 2>&1
@@ -526,9 +567,12 @@ get_hash(){
     md5sum "$1" | awk '{print $1}'
 }
 fetch_a2s(){
-    # this file is currently monolithic
-    [[ -d $helpers_path/a2s ]] && { logger INFO "A2S helper is current"; return 0; }
-    local sha=c7590ffa9a6d0c6912e17ceeab15b832a1090640
+    sum="d26da2fe03df2b95436f823f0496887b"
+    if [[ -d $helpers_path/a2s ]] && [[ $(get_hash "$helpers_path/a2s/info.py") == $sum ]]; then
+        logger INFO "A2S helper is current"
+        return 0
+    fi
+    local sha=b40eb24cdbb06ebd08272f224257fe5a81610e86
     local author="yepoleb"
     local repo="python-a2s"
     local url="https://github.com/$author/$repo/tarball/$sha"
@@ -542,13 +586,13 @@ fetch_a2s(){
     logger INFO "Updated A2S helper to sha '$sha'"
 }
 fetch_dzq(){
-    local sum="0a334e1e144e76e560419d155435c91e"
+    local sum="0d316badbb8d943c5f078e73862cac3e"
     local file="$helpers_path/a2s/dayzquery.py"
     if [[ -f $file ]] && [[ $(get_hash "$file") == $sum ]]; then
         logger INFO "DZQ is current"
         return 0
     fi
-    local sha=a22a9f428cbe075d7dda62f78000296955eea92a
+    local sha="07483b88ed096327ebca752f5e177011b604d7fe"
     local author="yepoleb"
     local repo="dayzquery"
     local url="https://raw.githubusercontent.com/$author/$repo/$sha/dayzquery.py"
@@ -585,11 +629,12 @@ fetch_helpers_by_sum(){
     [[ -f "$config_file" ]] && source "$config_file"
     declare -A sums
     sums=(
-        ["funcs"]="c2aec0a2fc153a2535e6493b3751ca81"
+        ["funcs"]="1cd26343cd68a5382e3377a9757497fa"
         ["query_v2.py"]="55d339ba02512ac69de288eb3be41067"
-        ["servers.py"]="4c5013aaf694806cfecd4f1c905bdc9a"
-        ["ui.py"]="294a7daf544a96e2a108d252df5e0676"
+        ["servers.py"]="ed442c3aecf33f777d59dcf53650d263"
+        ["ui.py"]="cf52a3d5883afe02a013d8673df494fa"
         ["vdf2json.py"]="2f49f6f5d3af919bebaab2e9c220f397"
+        ["pefile.py"]="b452974a84bff1d821872fcebf59e380"
     )
     local author="aclist"
     local repo="dztui"
@@ -608,6 +653,10 @@ fetch_helpers_by_sum(){
         realbranch="dzgui"
     fi
 
+    if [[ -n $reference_branch ]]; then
+        realbranch="$reference_branch"
+    fi
+
     for i in "${!sums[@]}"; do
         file="$i"
         sum="${sums[$i]}"
@@ -645,15 +694,12 @@ fetch_km_helper(){
 }
 get_response_code(){
     local url="$1"
-    curl -Ls -I -o /dev/null -w "%{http_code}" "$url"
-}
-raise_error_and_quit(){
-    echo "$1"
-    exit 1
+    curl --connect-timeout 3 -Ls -I -o /dev/null -w "%{http_code}" "$url"
 }
+
 fetch_ip_db(){
     parse_dl_url(){
-        curl -Ls "$url" \
+        curl --connect-timeout 3 -Ls "$url" \
         | grep "csv.gz" \
         | awk -F"['']" '{print $2}'
     }
@@ -669,6 +715,9 @@ fetch_ip_db(){
     fetch(){
         logger INFO "Triggering fetch routine"
         local url="$1"
+        local ip_file="${state_path}/ips.csv"
+        local base_file="${state_path}/${this_month}.csv.gz"
+        local extracted_file="${state_path}/${this_month}.csv"
 
         curl -Ls "$url" > "$base_file"
         if [[ $? -ne 0 ]]; then
@@ -688,7 +737,7 @@ fetch_ip_db(){
             logger WARN "Abnormal exit while parsing IPs"
             return
         fi
-        rm "${state_path}/${month}.csv"
+        rm "${state_path}/${this_month}.csv"
 
         readarray -t records < <(cat $ip_file | awk -F, 'NR==1 {print $1} END {print $1}')
         if [[ ${records[0]} != "0.0.0.0" ]] && [[ ${records[1]} != "224.0.0.0" ]]; then
@@ -703,55 +752,57 @@ fetch_ip_db(){
             rm "$ip_file"
         fi
 
-        echo "$month" > "$month_file"
-        logger INFO "Wrote '$month' to stub '$month_file'"
+        echo "$this_month" > "$month_file"
+        logger INFO "Wrote '$this_month' to stub '$month_file'"
         logger INFO "Updated '$ip_file'"
     }
 
+    check_remote(){
+        local url="$1"
+        local res=$(get_response_code "$url")
+        if [[ $res -ne 200 ]]; then
+            logger WARN "Failed to retrieve remote resource: '$url' ($res)"
+            return
+        fi
+        logger INFO "Resolved remote URL: '$url'"
+
+        # test dl url
+        local dl_url="$(parse_dl_url)"
+        local res=$(get_response_code "$dl_url")
+        if [[ $res -ne 200 ]]; then
+            logger WARN "Remote resource unavailable: '$dl_url' ($res)"
+            return
+        fi
+        logger INFO "Resolved download URL: '$dl_url'"
+        fetch "$dl_url"
+    }
+
     local url="https://db-ip.com/db/download/ip-to-city-lite"
-    local month_file="${state_path}/.month"
-    local ip_file="${state_path}/ips.csv"
-
-    # test main url
-    local res=$(get_response_code "$url")
-    if [[ $res -ne 200 ]]; then
-        logger WARN "Failed to retrieve remote resource: '$url' ($res)"
-        return
-    fi
-    logger INFO "Resolved remote URL: '$url'"
-
-    # test dl url
-    local dl_url="$(parse_dl_url)"
-    local res=$(get_response_code "$dl_url")
-    if [[ $res -ne 200 ]]; then
-        logger WARN "Remote resource unavailable: '$dl_url' ($res)"
-        return
-    fi
-    logger INFO "Resolved download URL: '$dl_url'"
-
-    local month=$(parse_dl_url_date "$dl_url")
-    local base_file="${state_path}/${month}.csv.gz"
-    local extracted_file="${state_path}/${month}.csv"
+    month_file="${state_path}/.month"
+    this_month=$(date +%Y-%m)
 
     # no stub file
     if [[ ! -f $month_file ]]; then
         logger WARN "No stub file '$month_file' present"
-        fetch "$dl_url"
-        return
-    fi
-
-    # local needs update
-    local last_month=$(< "$month_file")
-    if [[ $last_month != "$month" ]]; then
-        logger WARN "Local stub '$last_month' does not match remote stub '$month'"
-        fetch "$dl_url"
+        check_remote "$url"
         return
     fi
 
     # if stub is same date, abort
-    logger INFO "Local stub '$last_month' is identical to remote, skipping"
+    local last_month=$(< "$month_file")
+    if [[ $last_month == "$this_month" ]]; then
+        logger INFO "Local stub '$last_month' is identical to remote, skipping"
+        return
+    fi
+
+    # local needs update
+    logger WARN "Local stub '$last_month' does not match '$this_month'"
+    check_remote "$url"
+    return
+
 }
 fetch_helpers(){
+    echo "# Checking helper files"
     fetch_a2s
     fetch_dzq
     fetch_km_helper
@@ -850,12 +901,26 @@ file_picker(){
 }
 find_library_folder(){
     local search_path="$1"
-    steam_path="$(python3 "$helpers_path/vdf2json.py" -i "$1/steamapps/libraryfolders.vdf" \
-        | jq -r '.libraryfolders[]|select(.apps|has("221100")).path')"
-    if [[ ! $? -eq 0 ]] || [[ -z $steam_path ]]; then
+    readarray -t paths < <(python3.13 "$helpers_path/vdf2json.py" -i "$1/steamapps/libraryfolders.vdf" \
+        | jq -r '.libraryfolders[]|select(.apps|has("221100")).path')
+    if [[ ! $? -eq 0 ]]; then
         logger WARN "Failed to parse Steam path using '$search_path'"
         return 1
     fi
+    if [[ ${#paths[@]} -eq 0 ]]; then
+        logger WARN "No valid VDF paths in '$search_path'"
+        return 1
+    fi
+    if [[ ${#paths[@]} -gt 1 ]]; then
+        for path in "${paths[@]}"; do
+            if [[ -d "$path" ]]; then
+                steam_path="$path"
+                break
+            fi
+        done
+    else
+        steam_path="${paths[0]}"
+    fi
     logger INFO "Steam path resolved to: $steam_path"
 }
 create_config(){
@@ -864,6 +929,7 @@ create_config(){
     unset default_steam_path
     unset steam_path
 
+    preferred_client="steam"
     while true; do
         local player_input="$($steamsafe_zenity \
             --forms \
@@ -924,6 +990,7 @@ create_config(){
     done
 }
 varcheck(){
+    echo "# Checking config file"
     local msg="Config file '$config_file' missing. Start first-time setup now?"
     local msg2="The Steam paths set in your config file appear to be invalid (DayZ was moved or uninstalled). Restart first-time setup now?"
     if [[ ! -f $config_file ]]; then
@@ -937,7 +1004,7 @@ varcheck(){
     source "$config_file"
     local workshop_dir="$steam_path/steamapps/workshop/content/$aid"
     local game_dir="$steam_path/steamapps/common/DayZ"
-    if [[ ! -d $steam_path ]] || [[ ! -d $game_dir ]] || [[ ! $(find $game_dir -type f) ]]; then
+    if [[ ! -d $steam_path ]] || [[ ! -d $game_dir ]] || [[ ! $(find "$game_dir" -type f) ]]; then
         logger WARN "DayZ path resolved to '$game_dir'"
         logger WARN "Workshop path resolved to '$workshop_dir'"
         qdialog "$msg2" "Yes" "Exit"
@@ -948,18 +1015,16 @@ varcheck(){
         create_config
         return 0
     fi
-    if [[ $src_path != $(realpath "$0") ]]; then
-        src_path=$(realpath "$0")
-        update_config
-    fi
 }
 is_dzg_downloading(){
+    echo "# Checking DayZ"
     if [[ -d $steam_path ]] && [[ -d $steam_path/downloading/$aid ]]; then
         logger WARN "DayZ may be scheduling updates"
         return 0
     fi
 }
 is_steam_running(){
+    echo "# Checking Steam"
     local res=$(ps aux | grep "steamwebhelper" | grep -v grep)
     if [[ -z $res ]]; then
         logger WARN "Steam may not be running"
@@ -972,6 +1037,7 @@ get_response_code(){
     curl -Ls -I -o /dev/null -w "%{http_code}" "$url"
 }
 test_connection(){
+    echo "# Testing connection"
     declare -A hr
     local res1
     local res2
@@ -1005,6 +1071,7 @@ legacy_cols(){
     mv $cols_file.new $cols_file
 }
 stale_mod_signatures(){
+    echo "# Checking stale mods"
     [[ ! -f "$versions_file" ]] && return
     local workshop_dir="$steam_path/steamapps/workshop/content/$aid"
     if [[ -d $workshop_dir ]]; then
@@ -1018,18 +1085,48 @@ stale_mod_signatures(){
 
 }
 create_new_links(){
+    echo "# Setting up symlinks"
     "$func_helper" "update_symlinks"
 }
+calc_local_coords(){
+    local ip="$1"
+    [[ ! -f "$geo_helper" ]] && return 1
+
+    IFS="." read -ra split <<< "$ip"
+    [[ ${#split[@]} -ne 4 ]] && return 1
+
+    prefix="^${split[0]}.${split[1]}."
+    readarray -t res < <(grep "$prefix" "$geo_helper")
+
+    for address in "${res[@]}"; do
+        IFS="," read -ra fields <<< "$address"
+        upper="${fields[1]}"
+        IFS="." read -ra upper_digits <<< "$upper"
+        if [[ ${split[2]} -gt ${upper_digits[2]} ]]; then
+            continue
+        fi
+        if [[ ${split[2]} -eq ${upper_digits[2]} ]]; then
+            if [[ ${split[3]} -gt ${upper_digits[3]} ]]; then
+                continue
+            fi
+            if [[ ${split[3]} -eq ${upper_digits[3]} ]]; then
+                echo "${fields[-2]}" >> "$coords_file"
+                echo "${fields[-1]}" >> "$coords_file"
+                return 0
+            fi
+        fi
+        if [[ ${split[2]} -lt ${upper_digits[2]} ]]; then
+            echo "${fields[-2]}" >> "$coords_file"
+            echo "${fields[-1]}" >> "$coords_file"
+            return 0
+        fi
+    done
+    return 1
+}
 initial_setup(){
-    setup_dirs
-    setup_state_files
-    depcheck
-    check_pyver
-    test_gobject
-    watcher_deps
     check_architecture
     test_connection
-    fetch_helpers > >(pdialog "Checking helper files")
+    fetch_helpers
     varcheck
     source "$config_file"
     lock
@@ -1038,14 +1135,12 @@ initial_setup(){
     check_version
     check_map_count
     steam_deps
-    migrate_files
     stale_symlinks
     stale_mod_signatures
     create_new_links
     local_latlon
     is_steam_running
     is_dzg_downloading
-    print_config_vals
 }
 uninstall(){
     _full(){
@@ -1089,22 +1184,82 @@ uninstall(){
     rm "$self"
     echo "Uninstall routine complete"
 }
+
+usage(){
+cat <<- EOM
+DZGUI - Free and Open Source DayZ launcher
+
+Usage:
+
+  dzgui.sh [options]
+
+Description:
+
+  When no option is provided, the script launches DZGUI.
+
+Options:
+
+  -u, --uninstall:
+      Uninstalls the software
+
+  -v, --version:
+      Prints the version
+
+  -h, --help:
+      Prints this message
+EOM
+}
+
 main(){
-    local zenv=$(zenity --version 2>/dev/null)
+    # setup zenity environment
+    local zenv=""
+    zenv=$(zenity --version 2>/dev/null)
     [[ -z $zenv ]] && { echo "Requires zenity >= ${deps[$steamsafe_zenity]}"; exit 1; }
-    if [[ $1 == "--uninstall" ]] || [[ $1 == "-u" ]]; then
-        uninstall &&
-        exit 0
-    fi
+
+    # parse arguments
+    while [[ $# -gt 0 ]]; do
+        case $1 in
+            "--uninstall" | "-u")
+                uninstall
+                exit 0
+                # shift
+                ;;
+            "--version" | "-v")
+                echo $version
+                exit 0
+                # shift
+                ;;
+            "--help" | "-h")
+                usage
+                exit 0
+                # shift
+                ;;
+            *)
+                echo "Unrecognized command!"
+                return 1
+        esac
+    done
 
     set_im_module
 
-    printf "Initializing setup...\n"
-    initial_setup
+    printf "Checking dependencies...\n"
+    setup_dirs
+    setup_state_files
+    depcheck
+    check_pyver
+    test_gobject
+    watcher_deps
+
+    initial_setup > >(pdialog "Initializing setup")
 
     printf "All OK. Kicking off UI...\n"
-    python3 "$ui_helper" "--init-ui" "$version" "$is_steam_deck"
+    python3.13 "$ui_helper" "--init-ui" "$version" "$is_steam_deck"
+
 }
-main "$@"
-#TODO: tech debt: cruddy handling for steam forking
-[[ $? -eq 1 ]] && pkill -f dzgui.sh
+
+if [[ $(basename "$0") == "dzgui.sh" ]]; then
+   main "$@"
+
+   #TODO: tech debt: cruddy handling for steam forking
+   [[ $? -eq 1 ]] && pkill -f dzgui.sh
+fi

helpers/latlon.c

@@ -1,36 +0,0 @@
-#include <stdio.h>
-#include <stdlib.h>
-#include <math.h>
-
-#define R 6371
-#define TO_RAD (3.1415926536 / 180)
-double dist(double th1, double ph1, double th2, double ph2)
-{
-	double dx, dy, dz;
-	ph1 -= ph2;
-	ph1 *= TO_RAD, th1 *= TO_RAD, th2 *= TO_RAD;
-
-	dz = sin(th1) - sin(th2);
-	dx = cos(ph1) * cos(th1) - cos(th2);
-	dy = sin(ph1) * cos(th1);
-	return asin(sqrt(dx * dx + dy * dy + dz * dz) / 2) * 2 * R;
-}
-
-int main(int argc, const char * argv[])
-{
-	if(argc < 5 || argc > 5){
-		return 1;
-	}
-	float coords[4];
-	for(int i=1;i<5;i++){
-		if(atof(argv[i]) == 0){
-			return 1;
-		}
-		coords[i] = atof(argv[i]);
-	}
-	
-	double d = dist(coords[1], coords[2], coords[3], coords[4]);
-	printf("%.1f\n", d);
-
-	return 0;
-}

helpers/pefile.py

@@ -0,0 +1,492 @@
+import json
+import struct
+import typing  # noqa
+
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+from shlex import shlex
+from typing import BinaryIO, Union
+
+# https://learn.microsoft.com/en-us/windows/win32/debug/pe-format
+endian = "<"
+IMAGE_DIRECTORY_ENTRY = 2
+VERSION_RESOURCE = 16
+RESOURCE_NODE = ".rsrc"
+PE32_x86 = "0x10b"
+PE32_x64 = "0x20b"
+VS_VERSION_INFO_MAGIC = "0xfeef04bd0000"
+VS_VERSION_INFO_ID = "VS_VERSION_INFO"
+
+
+class VersionMatch(Enum):
+    LOCAL_OLDER = 1
+    LOCAL_NEWER = 2
+    SAME_VERSION = 3
+
+
+class u8:
+    fmt = "B"
+
+
+class u16:
+    fmt = "H"
+
+
+class u32:
+    fmt = "L"
+
+
+class u64:
+    fmt = "Q"
+
+
+class i8:
+    fmt = "b"
+
+
+class i16:
+    fmt = "h"
+
+
+class i32:
+    fmt = "l"
+
+
+class i64:
+    fmt = "q"
+
+
+class PackedData:
+    @classmethod
+    def unpack(cls, data: BinaryIO):
+        r = []
+        for key, value in cls.__annotations__.items():
+            if value == str:
+                f = data.read(8).rstrip(b"\x00\x00").decode()
+            else:
+                fmt = endian + (value.fmt)
+                size = struct.calcsize(fmt)
+                f = struct.unpack(fmt, data.read(size))[0]
+            r.append(f)
+        return cls(*r)
+
+
+@dataclass(slots=True, frozen=True)
+class COFF_FILE_HDR(PackedData):
+    machine_type: u16
+    number_of_sections: u16
+    timestamp: u32
+    pointer_to_symbol_table: u32
+    number_of_symbols: u32
+    size_of_optional_header: u16
+    characteristics: u16
+
+
+@dataclass(slots=True, frozen=True)
+class OPTIONAL_HDR_X86(PackedData):
+    magic: u16
+    major_linker_ver: u8
+    minor_linker_ver: u8
+    size_of_code: u32
+    size_of_initialized_data: u32
+    size_of_uninitialized_data: u32
+    address_of_entry_point: u32
+    base_of_code: u32
+    base_of_data: u32
+
+
+@dataclass(slots=True, frozen=True)
+class OPTIONAL_HDR_X64(PackedData):
+    magic: u16
+    major_linker_ver: u8
+    minor_linker_ver: u8
+    size_of_code: u32
+    size_of_initialized_data: u32
+    size_of_uninitialized_data: u32
+    address_of_entry_point: u32
+    base_of_code: u32
+
+
+@dataclass(slots=True, frozen=True)
+class OPTIONAL_HDR_WIN_X86(PackedData):
+    image_base: u32
+    section_alignment: u32
+    file_alignment: u32
+    major_operating_system_version: u16
+    minor_operating_system_version: u16
+    major_image_version: u16
+    minor_image_version: u16
+    major_subsystem_version: u16
+    minor_subsystem_version: u16
+    win32_version_value: u32
+    size_of_image: u32
+    size_of_headers: u32
+    checksum: u32
+    subsystem: u16
+    dll_characteristics: u16
+    size_of_stack_reserve: u32
+    size_of_stack_commit: u32
+    size_of_heap_reserve: u32
+    size_of_heap_commit: u32
+    loader_flags: u32
+    number_of_rva_and_sizes: u32
+
+
+@dataclass(slots=True, frozen=True)
+class OPTIONAL_HDR_WIN_X64(PackedData):
+    image_base: u64
+    section_alignment: u32
+    file_alignment: u32
+    major_operating_system_version: u16
+    minor_operating_system_version: u16
+    major_image_version: u16
+    minor_image_version: u16
+    major_subsystem_version: u16
+    minor_subsystem_version: u16
+    win32_version_value: u32
+    size_of_image: u32
+    size_of_headers: u32
+    checksum: u32
+    subsystem: u16
+    dll_characteristics: u16
+    size_of_stack_reserve: u64
+    size_of_stack_commit: u64
+    size_of_heap_reserve: u64
+    size_of_heap_commit: u64
+    loader_flags: u32
+    number_of_rva_and_sizes: u32
+
+
+@dataclass(slots=True, frozen=True)
+class DATA_DIR(PackedData):
+    virtual_address: u32
+    size: u32
+
+
+@dataclass(slots=True, frozen=True)
+class SECTION_HDR(PackedData):
+    name: str
+    virtual_size: u32
+    virtual_address: u32
+    size_of_raw_data: u32
+    pointer_to_raw_data: u32
+    pointer_to_relocations: u32
+    pointer_to_line_numbers: u32
+    number_of_relocations: u16
+    number_of_line_numbers: u16
+    characteristics: u32
+
+
+@dataclass(slots=True, frozen=True)
+class RESOURCE_DIRECTORY_TABLE(PackedData):
+    characteristics: u32
+    timestamp: u32
+    major_version: u16
+    minor_version: u16
+    number_of_name_entries: u16
+    number_of_id_entries: u16
+
+
+@dataclass(slots=True, frozen=True)
+class RESOURCE_DIRECTORY_ENTRY(PackedData):
+    """
+    This field is either a string identifying a data leaf
+    (if the high bit is set) or an ID to another nested directory
+    (if the high bit is clear). The outermost level is always a
+    directory. If it is a name, the lower 31 bits are the offset from the
+    beginning of the resource section's raw data to the name
+    (the name consists of 16 bits length and trailing wide characters,
+    in Unicode, not 0-terminated).
+    """
+
+    name_or_id: u32
+    data_or_subdir: u32
+
+
+@dataclass(slots=True, frozen=True)
+class RESOURCE_DATA_ENTRY(PackedData):
+    data_rva: u32
+    size: u32
+    codepage: u32
+    reserved: u32
+
+
+@dataclass(slots=True, frozen=True)
+class VS_VERSION_INFO_HDR(PackedData):
+    size: u16
+    value_length: u16
+    value_type: u16
+
+
+@dataclass(slots=True, frozen=True)
+class DayZVersion:
+    major: int
+    minor: int
+    patch: int
+
+
+@dataclass(slots=True, frozen=True)
+class FileVersion:
+    major: int
+    minor: int
+    build: int
+    revision: int
+
+
+@dataclass(slots=True, frozen=True)
+class Result:
+    local: Union[str, None]
+    remote: str
+    build: str
+    path: Union[Path, None]
+    match: VersionMatch
+    error: Union[Exception, None]
+
+
+class PeFileError(Exception):
+    """Expected contents missing from headers or resource nodes"""
+
+    pass
+
+
+class AppNotInstalledError(Exception):
+    """App not present in user's libraryfolders"""
+
+    pass
+
+
+class AppMovedError(Exception):
+    """VDF points to a nonexistent location on disk"""
+
+    pass
+
+
+class VDFLoadError(Exception):
+    """Malformed VDF or JSON conversion"""
+
+    pass
+
+
+def parse_version_number(data: BinaryIO):
+    # https://learn.microsoft.com/en-us/windows/win32/api/verrsrc/ns-verrsrc-vs_fixedfileinfo
+    minor = struct.unpack("<L", data.read(4))[0] >> 16 & 0xFFFF
+    major = struct.unpack("<L", data.read(4))[0] >> 0 & 0xFFFF
+    build = struct.unpack("<L", data.read(4))[0] >> 0 & 0xFFFF
+    revision = struct.unpack("<L", data.read(4))[0] >> 16 & 0xFFFF
+    return FileVersion(major, minor, build, revision)
+
+
+def seek_to_hex(address: str, data: BinaryIO) -> None:
+    data.seek(int(address, base=16))
+
+
+def seek_to_pe_stub(data: BinaryIO) -> None:
+    MAGIC = "0x3c"
+    seek_to_hex(MAGIC, data)
+    e_lfanew = hex(struct.unpack("<h", data.read(2))[0])
+    seek_to_hex(e_lfanew, data)
+    pe_stub = data.read(4).rstrip(b"\x00\x00\x00\x00").decode()
+    if pe_stub != "PE":
+        raise PeFileError("missing PE header data")
+
+
+def get_dayz_version(file: Path) -> DayZVersion | Exception:
+    try:
+        version = get_version(file)
+    except Exception as e:
+        raise e
+    patch = str(version.build) + str(version.revision)
+    dz_vers = DayZVersion(version.major, version.minor, int(patch))
+    return dz_vers
+
+
+def dayz_version_to_str(v: DayZVersion) -> str:
+    return ".".join(str(el) for el in [v.major, v.minor, v.patch])
+
+
+def dayz_version_from_str(v: str) -> DayZVersion:
+    vers = v.split(".")
+    assert len(vers) == 3
+    return DayZVersion(*[int(el) for el in vers])
+
+
+def get_version(file):
+    with open(file, "rb") as f:
+        seek_to_pe_stub(f)
+        COFF = COFF_FILE_HDR.unpack(f)
+
+        pos = f.tell()
+        blob = f.read()
+        magic = hex(struct.unpack("<H", (blob[0:2]))[0])
+        f.seek(pos)
+
+        if magic == PE32_x86:
+            OPTIONAL_HDR_X86.unpack(f)
+            OBJW = OPTIONAL_HDR_WIN_X86.unpack(f)
+        else:
+            OPTIONAL_HDR_X64.unpack(f)
+            OBJW = OPTIONAL_HDR_WIN_X64.unpack(f)
+
+        if OBJW.number_of_rva_and_sizes < 1:
+            raise PeFileError("no data resource directory")
+
+        data_dirs = []
+        for rva in range(OBJW.number_of_rva_and_sizes):
+            data_dir = DATA_DIR.unpack(f)
+            data_dirs.append(data_dir)
+
+        res_dir = data_dirs[IMAGE_DIRECTORY_ENTRY]
+        dir_va = res_dir.virtual_address
+
+        for section in range(COFF.number_of_sections):
+            hdr = SECTION_HDR.unpack(f)
+            if hdr.name == RESOURCE_NODE:
+                va = hdr.virtual_address
+                ptr = hdr.pointer_to_raw_data
+                offset = dir_va - va + ptr
+                seek_to_hex(hex(offset), f)
+                break
+
+        if hdr.name != RESOURCE_NODE:
+            raise PeFileError("no root resource node found")
+
+        table = RESOURCE_DIRECTORY_TABLE.unpack(f)
+        total = table.number_of_name_entries + table.number_of_id_entries
+
+        for entry in range(total):
+            entry = RESOURCE_DIRECTORY_ENTRY.unpack(f)
+            if entry.name_or_id == VERSION_RESOURCE:
+                while entry.data_or_subdir & (1 << 31):
+                    shift = entry.data_or_subdir & ~(1 << 31)
+                    seek_to_hex(hex(offset + shift), f)
+                    table = RESOURCE_DIRECTORY_TABLE.unpack(f)
+                    total = (
+                        table.number_of_name_entries
+                        + table.number_of_id_entries
+                    )
+                    for entry in range(total):
+                        entry = RESOURCE_DIRECTORY_ENTRY.unpack(f)
+                break
+            if entry.name_or_id > VERSION_RESOURCE:
+                raise PeFileError("no version info node found")
+        seek_to_hex(hex(offset + entry.data_or_subdir), f)
+
+        data = RESOURCE_DATA_ENTRY.unpack(f)
+        # https://stackoverflow.com/questions/2170843/va-virtual-address-rva-relative-virtual-address
+        offset = data.data_rva - hdr.virtual_address + hdr.pointer_to_raw_data
+        seek_to_hex(hex(offset), f)
+
+        hdr = VS_VERSION_INFO_HDR.unpack(f)
+        # https://learn.microsoft.com/en-us/windows/win32/menurc/vs-versioninfo
+        byte_len = len(VS_VERSION_INFO_ID.encode("utf-16le"))
+        label = f.read(byte_len).decode("utf-16le")
+        if label != VS_VERSION_INFO_ID:
+            raise PeFileError(f"header identifier != '{VS_VERSION_INFO_ID}'")
+        f.read(32 - byte_len)
+
+        identifier = hex(struct.unpack("<Q", f.read(8))[0])
+        if identifier != VS_VERSION_INFO_MAGIC:
+            raise PeFileError(
+                f"{VS_VERSION_INFO_ID} address != '{VS_VERSION_INFO_MAGIC}'"
+            )
+
+        try:
+            version = parse_version_number(f)
+        except Exception as e:
+            return PeFileError(e)
+
+        return version
+
+
+def get_pefile_path(path: str, appid: int) -> Path:
+    binary = "DayZ_x64.exe"
+    identifier = {221100: "DayZ", 1024020: "DayZ Exp"}
+    name = identifier[appid]
+
+    pe_path = None
+    path = path + "/steamapps/libraryfolders.vdf"
+
+    with open(path, "r") as f:
+        try:
+            j = json.loads(vdf_to_json(f))
+        except Exception:
+            raise VDFLoadError("Failed to parse libraryfolders")
+
+        for obj in j["libraryfolders"]:
+            if str(appid) in j["libraryfolders"][obj]["apps"]:
+                pe_path = j["libraryfolders"][obj]["path"]
+                pe_path += f"/steamapps/common/{name}/{binary}"
+                break
+
+    if pe_path is None:
+        raise AppNotInstalledError(
+            f"Failed to find a libraryfolder for the appid '{appid}'"
+        )
+
+    pe_path = Path(pe_path)
+    if pe_path.exists() is False:
+        raise AppMovedError(
+            f"Path '{pe_path}' specified in libraryfolders does not exist"
+        )
+
+    return pe_path
+
+
+def compare_versions(local: DayZVersion, remote: DayZVersion):
+    """
+    packaging.version module is not available OOTB on some distributions
+    """
+    if dayz_version_to_str(local) == dayz_version_to_str(remote):
+        return VersionMatch.SAME_VERSION
+
+    if local.major < remote.major:
+        return VersionMatch.LOCAL_OLDER
+    if local.major > remote.major:
+        return VersionMatch.LOCAL_NEWER
+    if local.major == remote.major:
+        if local.minor < remote.minor:
+            return VersionMatch.LOCAL_OLDER
+        if local.minor > remote.minor:
+            return VersionMatch.LOCAL_NEWER
+        if local.minor == remote.minor:
+            if local.patch < remote.patch:
+                return VersionMatch.LOCAL_OLDER
+            if local.patch > remote.patch:
+                return VersionMatch.LOCAL_NEWER
+            if local.patch == remote.patch:
+                return VersionMatch.SAME_VERSION
+
+
+def vdf_to_json(stream):
+    def _istr(indent, string):
+        return (indent * "  ") + string
+
+    jbuf = "{\n"
+    lex = shlex(stream)
+    indent = 1
+
+    while True:
+        tok = lex.get_token()
+        if not tok:
+            return jbuf + "}\n"
+        if tok == "}":
+            indent -= 1
+            jbuf += _istr(indent, "}")
+            ntok = lex.get_token()
+            lex.push_token(ntok)
+            if ntok and ntok != "}":
+                jbuf += ","
+            jbuf += "\n"
+        else:
+            ntok = lex.get_token()
+            if ntok == "{":
+                jbuf += _istr(indent, tok + ": {\n")
+                indent += 1
+            else:
+                jbuf += _istr(indent, tok + ": " + ntok)
+                ntok = lex.get_token()
+                lex.push_token(ntok)
+                if ntok != "}":
+                    jbuf += ","
+                jbuf += "\n"

helpers/servers.py

@@ -29,6 +29,18 @@ params = [
 ]
 
 
+class BmAPIError(Exception):
+    pass
+
+
+class BmIdError(Exception):
+    pass
+
+
+class InvalidIpError(Exception):
+    pass
+
+
 def get_netmask() -> str:
     hostname = os.uname()[1]
     i = socket.gethostbyname(hostname)
@@ -75,6 +87,7 @@ def parse_json(json: list) -> list:
         except KeyError:
             continue
 
+        malformed = False
         for key in [
             "map",
             "gametype",
@@ -86,9 +99,17 @@ def parse_json(json: list) -> list:
             try:
                 row[key]
             except KeyError:
-                continue
+                malformed = True
+                break
+
+        if malformed is True:
+            continue
+
+        try:
+            r = row["gametype"].split(",")
+        except KeyError:
+            continue
 
-        r = row["gametype"].split(",")
         if "no3rd" in r:
             view = "1PP"
         else:
@@ -151,7 +172,7 @@ def parse_json(json: list) -> list:
     return rows
 
 
-def query_direct(ip: str, qport: int, TIMEOUT=3.0) -> dict | None:
+def query_direct(ip: str, qport: int, TIMEOUT: float=3.0) -> dict | None:
     try:
         info = a2s.info((ip, qport), TIMEOUT)
 
@@ -185,38 +206,57 @@ def query_direct(ip: str, qport: int, TIMEOUT=3.0) -> dict | None:
         return None
 
 
-@dataclass
+@dataclass(slots=True, frozen=True)
 class Res:
     status: int
     parsed: bool
     json: Union[str, None]
 
 
-@dataclass
+@dataclass(slots=True, frozen=True)
 class Ping:
     addr: str
     iteration: int
     ping: int
 
 
-@dataclass
+@dataclass(slots=True, frozen=True)
 class Details:
     data: Union[list, None]
     description: str
     success: bool
 
 
-def is_passworded(ip: str, qport: int) -> bool:
+@dataclass(slots=True, frozen=True)
+class Prereqs:
+    password: bool
+    gameport: int
+    appid: Union[int, None]
+    version: Union[str, None]
+
+
+@dataclass(slots=True)
+class Record:
+    """
+    The gameport field is manipulated by the RowType.CONN_BY_IP method
+    """
+    ip: str
+    gameport: int
+    qport: int
+
+
+def get_prereqs(ip: str, qport: int) -> Prereqs:
     try:
         info = a2s.info((ip, qport))
     except TimeoutError:
-        return False
+        return Prereqs(False, 0, None, None)
 
-    try:
-        password = info.password_protected
-    except AttributeError:
-        return False
-    return password
+    gameport = getattr(info, "port", 0)
+    is_password = getattr(info, "password_protected", False)
+    appid = getattr(info, "game_id", None)
+    version = getattr(info, "version", None)
+
+    return Prereqs(is_password, gameport, appid, version)
 
 
 def details(ip: str, qport: int) -> Details:
@@ -245,10 +285,10 @@ def details(ip: str, qport: int) -> Details:
     for keyword in keywords:
         if "etm" in keyword:
             day_accel = float(keyword.lstrip("etm"))
-            day_accel = f"{day_accel:g}"
+            day_accel = float(f"{day_accel:g}")
         if "entm" in keywords:
             night_accel = float(keyword.lstrip("entm"))
-            night_accel = f"{night_accel:g}"
+            night_accel = float(f"{night_accel:g}")
 
     try:
         password = info.password_protected
@@ -339,12 +379,12 @@ def ping(iteration: int, row: list) -> Ping:
     return Ping(addr, iteration, ping)
 
 
-def query_api(key: str, param: str) -> Res:
+def query_api(key: str, appid: int, param: str) -> Res:
     LIMIT = 10000
     url = "https://api.steampowered.com/IGameServersService/GetServerList/v1/?"
 
     payload: dict[str, Union[int, str]] = {
-        "filter": r"\appid\221100" + param,
+        "filter": r"\appid" + fr"\{appid}" + param,
         "limit": LIMIT,
         "key": key,
     }
@@ -371,3 +411,62 @@ def query_api(key: str, param: str) -> Res:
         data = None
     finally:
         return Res(status, parsed, data)
+
+
+def query_bm_api(api_key: str, bm_id: str) -> Record:
+    if bm_id.isnumeric() is False:
+        raise BmIdError("ID must be numeric only")
+
+    payload: dict[str, Union[int, str]] = {
+        "sort": "-players",
+        "filter[game]": "dayz",
+        "filter[ids][whitelist]": bm_id,
+    }
+
+    url = "https://api.battlemetrics.com/servers?"
+    par = parse.urlencode(payload)
+    url = f"{url}{par}"
+
+    hdr = {"Authorization": "Bearer " + api_key}
+    r = request.Request(url, headers=hdr)
+
+    try:
+        with request.urlopen(r) as response:
+            try:
+                j = json.load(response)
+            except json.decoder.JSONDecodeError:
+                raise BmAPIError("Malformed response from Battlemetrics")
+
+            if len(j["data"]) < 1:
+                raise BmAPIError("Not a valid Battlemetrics ID")
+            j = j["data"][0]["attributes"]
+            return Record(j["ip"], j["port"], j["portQuery"])
+    except HTTPError:
+        raise BmAPIError("Failed to query Battlemetrics")
+
+
+def validate_ip(addr: str) -> Record:
+    fields = addr.split(":")
+    if len(fields) != 2:
+        raise InvalidIpError("Address must be formatted as IP:Queryport")
+
+    ip = fields[0]
+    port = fields[1]
+
+    try:
+        int(port)
+    except ValueError:
+        raise InvalidIpError(f"'{port}' is not a valid port")
+
+    if int(port) > 65535 or int(port) < 0:
+        raise InvalidIpError(f"'{port}' is not a valid port")
+
+    try:
+        socket.inet_aton(ip)
+    except OSError:
+        raise InvalidIpError(f"'{ip}' is not a valid IP")
+
+    ip = addr.split(":")[0]
+    qport = int(addr.split(":")[1])
+    record = Record(ip, 0, qport)
+    return record

helpers/tools/.gitignore

@@ -0,0 +1 @@
+latlon

helpers/tools/Makefile

@@ -0,0 +1,24 @@
+bin := latlon
+
+CC = gcc
+
+CFLAGS += -Wall
+CFLAGS += -Wextra
+CFLAGS += -Wpedantic
+CFLAGS += -std=c23
+CFLAGS += -O3
+
+LDFLAGS += -lm
+
+PREFIX ?= $(HOME)/.local/share/dzgui
+
+all: $(bin)
+
+install: $(bin)
+	install -Dm 755 $(bin) $(PREFIX)
+
+$(bin): latlon.c
+	$(CC) $(CFLAGS) $^ -o $@ $(LDFLAGS)
+
+clean:
+	rm -f $(bin)

helpers/tools/latlon.c

@@ -0,0 +1,77 @@
+// This small program computes the distance between two points on the Earths
+// surface. The algorithm used for computing is called haversine formula.
+// Source for the algorithm can be found here:
+// https://en.wikipedia.org/wiki/Haversine_formula
+
+#include <math.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+// Earth's radius in meters.
+#define RADIUS ((12756L / 2.0L) * 1000L)
+
+// PI natural constant
+#define PI 3.1415926536L
+
+// coordinates struct for storing points
+struct Coordinate {
+    double latitude;
+    double longitude;
+};
+
+/**
+ * @brief Calculates a radian value from an angle
+ */
+double radian_from(const double angle) {
+    return (angle * PI) / 180;
+}
+
+/**
+ * @brief Calculate the haversine function from an angle in radian
+ */
+double haversine(const double angle) { return ((1.0L - cos(angle)) / 2); }
+
+/**
+ * @brief Calculate the distance between two coordinates
+ */
+double great_circle_distance(const struct Coordinate a,
+                             const struct Coordinate b) {
+
+    // calculate longitude and latitude differences
+    struct Coordinate diff_coord = {
+        .longitude = a.longitude - b.longitude,
+        .latitude  = a.latitude - b.latitude,
+    };
+
+    // calculate haversine(theta) value, where theta is the angle between the
+    // two coordinates
+    double hav_theta = haversine(diff_coord.latitude)
+                       + cos(a.latitude) * cos(b.latitude) * haversine(diff_coord.longitude);
+
+    // calculate distance from radius, and haversine(theta) values 
+    double distance = 2 * RADIUS * asin(sqrt(hav_theta));
+
+    return distance;
+}
+
+int main(int argc, const char* argv[]) {
+    if (argc < 5 || argc > 5) {
+        return 1;
+    }
+
+    const struct Coordinate a = {
+        .latitude  = radian_from(atof(argv[1])),
+        .longitude = radian_from(atof(argv[2])),
+    };
+    const struct Coordinate b = {
+        .latitude  = radian_from(atof(argv[3])),
+        .longitude = radian_from(atof(argv[4])),
+    };
+
+    // Returns the distance in meters.
+    // To pretty-print the result in a consumer of this module, it is
+    // recommended to divide the result by 1,000 and round it.
+    printf("%.1f\n", great_circle_distance(a, b));
+
+    return 0;
+}