Merge pull request #276 from aclist/chore/update-readme

chore: update readme

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: aclist

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,57 @@
+name: Bug report
+description: Submit bugs that affect functionality here
+title: "[BUG] Your title here"
+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:
+      label: Did you check if this issue already exists?
+      options:
+        - label: I have checked the [Knowledge Base](https://aclist.github.io/dzgui/kb.html) and searched through [past issues](https://github.com/aclist/dztui/issues?q=is%3Aissue+is%3Aclosed) and did not find my issue there.
+          required: true
+  - type: dropdown
+    id: device
+    attributes:
+      label: Device type
+      options:
+        - Desktop PC
+        - Steam Deck
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: DZGUI version
+    validations:
+      required: true
+      placeholder: "5.6.0"
+  - type: input
+    id: distro
+    attributes:
+      label: Linux distribution
+    validations:
+      required: true
+      placeholder: "Arch Linux"
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the bug
+      description: What did you expect to happen?
+      placeholder: "E.g., When doing X, Y occurred. Include as much detail as possible."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional log output
+      description: Attach the file `$HOME/.local/state/dzgui/DZGUI_DEBUG.log` by clicking this area to highlight it and then dragging the file in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,47 @@
+name: Feature suggestion
+description: Submit requests for new features here
+title: "[FEAT] Your title here"
+labels: ["enhancement"]
+assignees:
+  - aclist
+body:
+  - type: dropdown
+    id: device
+    attributes:
+      label: Device type
+      options:
+        - Desktop PC
+        - Steam Deck
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: DZGUI version
+    validations:
+      required: true
+      placeholder: "5.6.0"
+  - type: input
+    id: distro
+    attributes:
+      label: Linux distribution
+    validations:
+      required: true
+      placeholder: "Arch Linux"
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the feature
+      description: A clear and detailed description
+      placeholder: "E.g., Add a dialog to the Options menu that automatically lets the user do Y"
+    validations:
+      required: true
+  - type: textarea
+    id: why
+    attributes:
+      label: Describe the benefit
+      description: How will this feature benefit large numbers of users?
+      placeholder: "E.g., Currently, users have to manually do X to achieve Y. Implementing this feature would achieve A, B, and C."
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/trouble.yml

@@ -0,0 +1,50 @@
+name: Troubleshooting
+description: Submit user error/troubleshooting questions here
+title: "[HELP] Your title here"
+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:
+      label: Device type
+      options:
+        - Desktop PC
+        - Steam Deck
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: DZGUI version
+    validations:
+      required: true
+      placeholder: "5.6.0"
+  - type: input
+    id: distro
+    attributes:
+      label: Linux distribution
+    validations:
+      required: true
+      placeholder: "Arch Linux"
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the issue
+      description: A detailed description. What did you expect to happen?
+      placeholder: "Include as much detail as possible and state the steps leading up to the problem. E.g., First I do this, then I do this, then this happens."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional log output
+      description: Attach the file `$HOME/.local/state/dzgui/DZGUI_DEBUG.log` by clicking this area to highlight it and then dragging the file in.
+    validations:
+      required: false

.github/workflows/mirror.yml

@@ -0,0 +1,18 @@
+name: Mirror to Codeberg
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  mirror-to-codeberg:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: pixta-dev/repository-mirroring-action@v1
+        if: ${{ vars.GIT_REMOTE != '' }}
+        with:
+          target_repo_url: ${{ vars.GIT_REMOTE }}
+          ssh_private_key: ${{ secrets.GIT_SSH_PRIVATE_KEY }}

.gitignore

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

CHANGELOG.md

@@ -0,0 +1,768 @@
+# Changelog
+
+## [6.0.2] 2026-01-26
+## Fixed
+- Explicitly use Python 3.13 when calling subprocesses
+- Raise error correctly from module
+- 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] 2026-01-16
+## Fixed
+- Explicitly use Python 3.13 when calling subprocesses
+
+## [6.0.0] 2026-01-14
+## Added
+- Support DayZ Experimental
+- Ping display on server tables
+- Save descriptive text notes on a per-server basis
+- Speed up load time and navigation of server tables
+- More robust threading and cache system when filtering servers
+- Show additional DayZ client information in Options menu
+- Warn user of DayZ client version mismatches
+- Support clickable hyperlinks in dialogs
+- Rich server metadata details dialog (right-click on server table)
+- Filter by modded servers
+- Breadcrumbs showing current menu context
+- Dedicated changelog page
+- Dedicated keybindings page
+- Dedicated settings page ("Options")
+- Support sandboxed version of Flatpak
+- Vim-style navigation keybindings
+- Added "Return to main menu" button to dialog windows when failing to load server table
+- Dynamic context menus for modded servers
+- Additional keybindings for new filter toggles
+- If a server is locked, prompt user when connecting
+- Internal flag to allow distro-packaged releases to disable in-app updates
+- Pre-boot checks to test whether script was invoked directly
+- Commandline usage help text (GaryBlackbourne)
+- More descriptive help dialogs when initial dependencies are missing
+
+## Fixed
+- Script failing to start when remote endpoints are unavailable (GaryBlackbourne)
+- Key stickiness when quickly navigating through entries in tables
+- Servers returning malformed A2S_INFO blocking server browser from loading
+- Normalized buttons in dialogs and restored proper padding
+- GTK errors being emitted to stdout when inserting debug table
+- Entry dialog sensitivity when validating API keys
+- Additional validation on entry dialogs to prevent submitting empty text
+- Suppress errors during pre-boot checks when mods are not installed
+- Centered filter checkboxes within panel
+- Do not pop unhighlight/select stale buttons if no stale mods exist
+- Improved keybinding interaction with side panels
+- Suppress typeahead search in mod dialogs
+- Do not trigger global API cooldown if no LAN/favorite servers are found
+- Fix table column expansion in server mod dialogs
+- Missing parameters when closing application via window decorations
+- Statusbar contents not updating on certain pages
+- Prevent debug button from activating when in certain input fields
+- Window size not updating correctly when unmaximizing window after changing "fullscreen at boot" setting
+- Branch toggle signal being emitted when entering Options menu from other contexts
+- 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
+- ESC key destroying wait dialogs while a thread is pending
+- Tooltip signals being erroneously emitted on main menu
+- UI not being constructed correctly if CHANGELOG.md was missing
+- Config file erroneously getting updated when populating settings menu
+- Leaky variable name in dialog titles
+- Prevent extraneous signals from propagating when column width is adjusted
+- Server filter panel not being hidden when entering other page contexts
+- Path to remote changelog being constructed incorrectly
+- Dialogs with newlines breaking output in log table
+- 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
+
+## Changed
+- Require Python 3.13
+- Reduced global API cooldown from 60s to 30s
+- Clarify dialog messages when DayZ path could not be found
+- Auto-focus first item when opening context menus
+- Opacity setting on side buttons when in a different context
+- Refactored BM API key validation to account for new key format
+- State file serialization methods
+- Optimize time complexity of pre-boot checks (GaryBlackbourne)
+- Rewrote distance calculation module (GaryBlackbourne)
+- Changed preferred client setting from radio toggle to combobox
+
+## Dropped
+- Ping readout in statusbar
+- Extraneous information from right statusbar
+
+## [5.8.3] 2026-01-04
+## Fixed
+- Normalize checksum numbers and dates
+
+## [5.8.2] 2026-01-04
+## Fixed
+- Fix regression in symlink routine introduced by previous hotfix
+
+## [5.8.1] 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
+
+## [5.8.0] 2025-07-06
+## Added
+- Filter servers by official/unofficial status
+- Automatically fetch geolocation records
+## Changed
+- Updated internal versioning of helper files
+## Fixed
+- Corrected erroneous 2024 date in prior changelog entries
+
+## [5.7.0] 2025-04-17
+## Added
+- Save application dimensions when quitting and restore on subsequent boot
+## Fixed
+- Issues with the window exceeding the bounds of the screen when displaying some table contexts
+## Changed
+- More direct server ping query method that should return marginally more accurate times
+
+## [5.6.7] 2025-04-04
+## Dropped
+- Removed extraneous pre-boot API checks that could cause error messages to be printed if the user had not set up an API key yet
+
+## [5.6.6] 2025-03-16
+## Changed
+- Update IP database records for 2025-03
+
+## [5.6.5] 2025-03-04
+## Fixed
+- Livonia server results being dropped from batch queries
+
+## [5.6.4] 2025-02-10
+### Changed
+- Drop launch flag and check for invocation through Steam automatically
+
+## [5.6.3] 2025-02-09
+### Changed
+- Update IP database records for 2025-02
+
+## [5.6.2] 2025-01-22
+### Fixed
+- Resolve regression introduced with IP resolution feature in 5.6.0 (restores functionality of right-click action: Add to My Servers)
+
+## [5.6.1] 2025-01-10
+### Fixed
+- Add fallback support for jq 1.6
+
+## [5.6.0] 2025-01-06
+### Added
+- Application header bar and controls
+- Menu context subtitle in header bar
+- Bulk delete mods (via 'List installed mods' list). Not compatible with Manual Mod install mode
+- Highlight stale mods in mods list
+- Added --steam launch parameter
+- Open Steam workshop subscriptions dialog when switching from Manual to Auto mode
+- Hover tooltips to most buttons
+- Add in-app documentation link to Codeberg mirror
+- Additional logging
+### Fixed
+- Avoid sudo escalation if system map count is sufficient (jiriks74)
+- Duplicate dialog title on Steam Deck
+- Resolve remote IP when saving records for game servers with multiple hosts
+- More performant symlink traversal when checking for legacy links
+- Only iterate on missing symlinks at boot (400% performance uplift)
+- Fix for server list truncation causing some servers to not appear in results
+- Empty dialog popups if user manually deletes local mods while application is running
+- Update statusbar when removing servers from list/repopulating
+- Abort DayZ path discovery if Steam files are not synched
+- Race condition when checking for installed mods
+- Favorite server message not updating correctly
+- Improved handling for cases where there are no locally installed mods
+- Set up mod symlinks at boot, rather than only on server connect
+- Prevent context menus from opening when table is empty
+- When reloading table in-place, prevent duplicate panel elements from being added if already present
+- Clean up local mod signatures from versions file when deleting mods
+- Focus first row when opening mods list
+### Changed
+- Redact usernames in log files
+- Prevent ArrowUp/ArrowDown input when inside keyword field
+- Admonish user to restart Steam in error dialog if DayZ path could not be found
+- Refactor control flow for more robust contextual parsing
+- Stop sending modal dialog hints to outer window
+- Clean up signal emission
+- Clarify some error messages and normalize text formatting
+- Update forum URL
+- Update README.md
+- Update IP database to 2025-01
+- Reduce IP database size by 50%
+- Update documentation to 5.6.x standard
+### Dropped
+- Hall of Fame section from button links, to be moved inside documentation
+- Unused imports
+
+## [5.5.3] 2024-12-13
+### Fixed
+- Add remote resource health checks before downloading updates
+### Added
+- Add fallback repository
+
+## [5.5.1] 2024-12-03
+### Fixed
+- Support localized decimal separators when parsing installed mod sizes
+
+## [5.5.0] 2024-11-10
+### Added
+- Support servers running DLC content (fixes Frostline servers)
+- Expose a toggle setting for whether to launch the application in fullscreen
+- Text autocompletion in maps search field (partial search)
+- Add disk space warning to popup dialog when downloading mods
+### Fixed
+- Servers in saved servers list would populate context menu with same option when right-clicking in server browser
+- Enable adding/removing servers to/from My Saved Servers when in Recent Servers context
+- Prevent maps combobox from duplicating contents
+- Restore keyboard input to keyword entry field
+### Changed
+- Abort fallback query method if DLC is required
+
+## [5.4.2] 2024-10-05
+### Fixed
+- Sanitize third-party API IDs to remove UGC collisions
+
+## [5.4.1] 2024-09-25
+### Added
+- Pre-boot validation check for users with self-compiled version of jq
+### Fixed
+- Use fallback logic for modlist queries when user traverses networks
+- Fix signal handling control flow for checkbox toggles
+- When reloading the server browser, the map combobox selection would revert to the last selected map instead of All Maps
+- Server filter toggle signals were accessible from the main menu when switching between menu contexts
+- Global cooldown dialog could sometimes block filter toggles after cooldown reset
+- Normalized minor version number due to a previous clerical error
+
+## [5.4.0] 2024-08-27
+### Added
+- Scan local area network for DayZ servers
+- Freedesktop application icons for system taskbar, tray, and other dialogs
+- Emit CPU model name when exporting system debug log
+### Fixed
+- Errors being printed to the console when Exit button was explicitly clicked
+- Detect Steam Deck OLED APU variant during initial setup
+- Encapsulate player names correctly so that names with whitespace in them are supported
+- Test if DayZ directory is empty at startup, implying that the game was moved to a new library collection
+- Report WM_CLASS name to the window manager
+
+## [5.3.2] 2024-07-02
+### Fixed
+- Server list would sometimes be missing some expected servers due to truncation being caused when a server erroneously set an incomplete gametype
+
+## [5.3.1] 2024-06-15
+### Added
+- Uninstall routine: invoke via dzgui.sh -u or dzgui.sh --uninstall and choose from full or partial uninstall
+
+## [5.3.0] 2024-06-15
+### Added
+- Server browser tables now display the number of players in queue (for full servers)
+- Warning dialog if the user's API key returned no servers, and a global API cooldown dialog (60 seconds)
+### Fixed
+- Removing servers from My Servers via the right-click context menu was not actually removing the server and drawing an empty dialog
+- Resolved an issue where, when Steam was not installed in a standard location and the user was prompted to let DZGUI auto-discover the correct path, this information was not retained correctly
+
+## [5.2.4] 2024-05-29
+### Fixed
+- Resolved an issue that could cause an old path to a prior DayZ installation to be reinserted in the config file if the Steam client did not synch the new path internally. DZGUI would try to ask the user to re-run first-time setup and update the path, but the old path would still be used.
+
+## [5.2.3] 2024-04-19
+### Added
+- Added Debug Mode button to main menu
+
+### Changed
+- Reworded debug mode notification dialog
+- Updated geolocation records
+
+### Dropped
+- Dropped seen_news key from configs
+
+## [5.2.2] 2024-04-18
+### Added
+- Cover artwork/icons for Steam "Recent Games" and tree view
+
+### Changed
+- Updated documentation to the v5.0.0 spec
+
+## [5.2.1] 2024-04-01
+### Fixed
+- Fixed a regression where where the first-time setup dialog would not trigger auto-path discovery
+
+### Changed
+- Reworded some menus and dialogs for clarity
+
+## [5.2.0] 2024-03-21
+### Added
+- Refresh player count for active row: invoke via right-click context meu or directly with the Ctrl-r hotkey. This feature has a 30 second global cooldown to prevent throttling.
+
+### Fixed
+- Improve case-insensitive keyword search to be portable across awk versions (previous version required gawk)
+- Fixed a dialog string from being shown twice when adding a server to favorites via context menus
+
+### Changed
+- Use a more robust method for downloading mods when auto mod install is enabled
+
+## [5.1.1] 2024-03-18
+### Fixed
+- Hotfix for remote helper files not being fetched correctly
+
+## [5.1.0] 2024-03-18
+### Added
+- Make columns in the server browser user-resizable (affects Server Browser, My Servers, and Recent Servers)
+- Save dragged position of user-resized columns
+- Display ping to server in statusbar: by popular request, added the ability to visualize both distance to server and round-trip latency (ping), at the cost of a small calculation delay. Please leave feedback regarding whether this feature feels fast/responsive enough.
+
+### Fixed
+- Fixed a rare scenario in Auto Mod Install Mode where defunct mods (mods no longer available on Steam) would try to be downloaded if the user had previously downloaded the mod
+
+## [5.0.0] 2024-01-31
+### Added
+- Context switching: navigate to different pages using side buttons
+- Dynamic statusbar: updates metadata and server distance when selecting rows
+- Show server-side modlist and allow jumping to Steam Workshop pages to browse, and list whether mod is currently installed
+- Print debug logs in-app (Help > Show debug log)
+- Functionality to change API keys in-app (used when revoking old API keys)
+- Print atomic mod sizes when listing installed mods
+- Dialogs show direct links to API key management URLs when changing API keys
+- Toggle dry-run mode directly from server browser
+- Extensive keybindings for fully controlling the application without the mouse
+- Extensive pre-boot sanity checks
+- Keybinding help dialog in main menu
+- Right-click context menus in server browsers/mod list: add/remove from favorites, show server-side mods, delete mod, copy server IP to clipboard
+
+### Changed
+- Utilize GTK bindings and MVC paradigm for UI creation and data flow
+- Filter servers dynamically from within server browser
+- Performance and security improvements to DZGUI helper files
+
+### Fixed
+- First-time setup dialogs respawning repeatedly in certain scenarios
+- Issues with Steam client switching to the wrong page when using auto-mod install
+- Set text input module correctly when launching on Steam Deck
+- Separate current/total player count and use proper integer sort method in table
+
+## [4.1.1] 2023-12-18
+### Fixed
+
+- News marquee not showing
+
+## [4.1.0] 2023-12-17
+
+This update adds support for DayZ servers running on a local area network. To connect or add to your server list, supply the server IP and query port in the format IP:PORT.
+
+Support for Steam Deck Game Mode has also been restored, with a new dialog format that allows for virtual keyboard input. This should allow you to enter text in form fields by activating the Steam button + X. In addition, you can unlock the mouse and keyboard input when launching DZGUI through Steam by using an internal binding provided by Steam Deck: long-press the three dots button on the right of the device for three seconds to toggle the input state. This allows you to use mouse and keyboard-style bindings on Game Mode and vice versa.
+
+### Added
+- Virtual keyboard support for text entry fields on Steam Deck Game Mode
+- Validate and connect to LAN server IPs
+
+## [4.0.4] 2023-12-23
+### Fixed
+- Enforce version check for Python versions before 3.10
+
+## [4.0.3] 2023-11-22
+### Fixed
+- Query helper: backwards compatibility for pre-2021 versions of Python 3
+
+## [4.0.2] 2023-11-22
+### Fixed
+- Query helper not loading: fixed a remote link pointing to the wrong destination and added a checksum verification to ensure file is present
+
+## [4.0.1] 2023-11-22
+### Fixed
+- Emergency hotfix to remove build artifacts leaking into main script: if you updated DZGUI from 3.3.18 to 4.0.0 between 2023-11-22 15:00:02 and 2023-11-22 15:03:37 GMT, there is a small chance it will be unable to launch correctly. If so, please follow the instructions on the manual to reinstall.
+
+## [4.0.0] 2023-11-22
+
+Hello players, this is a major version update which overhauls many of DZGUI's underlying systems to improve responsiveness of the application and make menus more intuitive to interact with. It should be considerably more difficult, if not impossible, to inadvertently crash a dialog, and nested dialogs should behave in a more expected fashion, such as when going back and forth between menus or changing options dynamically within a given menu.
+
+In addition, with this update we are querying servers directly. The net benefit of this is that results will returned faster, bootup is faster, and it also paves the way for future features like connecting to servers on a LAN. The Battlemetrics API is now entirely optional and can be skipped during the setup process. However, if you have already set up a BM API key, you can continue using it if you want to query or add servers by ID instead of IP.
+
+As part of this change, version 4.0.0 introduces the ability to connect to or add servers to your list based on either ID or IP. Previously, you could only connect by IP and add by IP, but now you can connect by IP/ID or add by IP/ID. If you choose the ID method, this will be translated into an IP seamlessly in the background. Similarly, favorite servers are now stored using the full IP rather than the ID. Due to the variety of systems and methods for connecting to servers, the application was carrying around and converting server IPs, IDs, and other formats back and forth, creating unnecessary complexity. By normalizing everything to an IP basis, maintainability should be more consistent. When upgrading to this version, your old favorites lists will be updated automatically to the new IP method. Note that as a result of this change, we must purge old history lists ("Recent Servers"), but everything else should carry over as before.
+
+If you encounter any problems with this new release or with the migration of configs, please do not hesitate to submit a bug report.
+
+Attention Fedora 38 users: problems with upstream GNOME packages causing crashes have been reported to GNOME development and a fix has been issued. You have the choice of compiling the zenity package
+from source or waiting until the latest version is merged into Fedora's package manager.
+
+### Added
+- Change in game name: dynamically change your profile name via the Advanced Options menu
+- Connect by ID: supply a Battlemetrics ID to connect to a server; this can be used in lieu of the IP
+- Add by IP: supply a standard IP to add a server to your list; this can be used as a more direct way of saving servers
+- Filter by 1PP and 3PP in the server browser
+- Save connected server to favorites: prior to connecting, asks the user if they want to save this server for future use
+- Generate additional output when generating system logs
+
+### Fixed
+- Rare cases where the keyword filter would not filter server results correctly
+- Handling of dialog exit signals: made it much more difficult to crash the application in rare cases when spamming input or returning from menus
+- Update menus in place: when toggling options in the Advanced Options menu, displays the current state/mode of the option for better readability into what option is currently enabled
+- More intuitive menu navigation: dialog setup and teardown is more responsive and follows expected flows when inside of nested menus
+- Message formatting: fold long messages inside of popup dialogs for proper word wrapping regardless of screen type
+- Fixed a rare case where dialogs would spawn twice during first-time setup
+- Properly remain inside of menus when looping where it would make sense to do so : e.g., Delete Servers list, Advanced Options
+
+### Changed
+- Query servers directly to reduce API hops: initial bootup and subsequent server queries should be considerably faster
+- Store complete IP:Port instead of server IDs
+- Make Battlemetrics API key optional: this is only used for the 'Connect by ID' and 'Add server by ID' methods and is not required. If you prefer, you can simply connect/add by IP.
+- Prevent the application from launching in Game Mode on Steam Deck: Steam Deck's kiosk mode has problems sending keyboard input to third party applications. To prevent unintended usage, DZGUI now warns the user to launch the app in Desktop Mode if they attempt to use it from Game Mode. Adding DZGUI as a Non-Steam Game does work on desktop PCs, but is not recommended due to the way Steam handles subshells. For best results, launch DZGUI directly via the script/applications menu (PC) or via the desktop icon (Steam Deck).
+- Omit null servers from list: servers that time out or send an empty response are now omitted entirely from the My Servers list, as they will not return meaningful metadata unless they are online.
+  The My Servers list thus shows online and accessible servers
+
+## [3.3.0] 2023-05-16
+### Added
+- Fetch more inclusive global "players in-game" count
+- List mod directory on installed mods list
+- Detect default Flatpak Steam path
+- Dark mode/light mode theme to help file
+- Alpha-sort My Servers list
+- Add description of how to enable hidden folders on GTK2/3
+- Initial logging framework
+
+### Changed
+- Test for wmctrl when enabling full auto mod installation
+- Steam Deck: block toggling full auto mod installation due to extra dependencies needed
+- First-time setup: sudo escalation when checking system map count for the first time
+
+### Fixed
+- Steam Deck: non-ASCII delimiter causing setup menu to despawn on some devices
+- Don't add items in My Servers multiple times to array when the list of favorites is paginated
+- Trigger progress dialogs sooner and in sequence to reduce appearance of visual lag
+- First-time setup: break out of dialogs correctly when user backs out
+- First-time setup: break out of automatic path discovery when user specifies a path manually
+- More portable interpreter invocation
+- Properly size down window resolution when returning from server browser
+
+## [3.2.10] 2023-05-11
+### Fixed
+- Return from lockfile function if first-time setup has not been run
+- Sanitize inputs when using file picker
+- Require both wmctrl and xdotool
+
+## [3.2.9] 2023-05-10
+### Changed
+- Reword button to "Choose path manually" instead of "Retry"
+
+## [3.2.7] 2023-05-10
+### Changed
+- Better sudo escalation within zenity dialogs if vm map count is too small
+
+## [3.2.6] 2023-05-10
+### Fixed
+- Don't parse Flatpak symlinks when setting up default Steam path
+
+## [3.2.5] 2023-05-07
+### Fixed
+- Require sudo when checking vm map count
+
+## [3.2.4] 2023-03-01
+### Fixed
+- BM API returning stale query port and preventing fetching modlist
+
+## [3.2.3] 2023-02-17
+### Fixed
+- sysctl map count value not being loaded immediately after setting
+- Application terminating when user declines to update map count value
+- Erroneous stderror output when flatpak is not installed
+
+## [3.2.0] 2023-01-19
+### Added
+- Support Flatpak version of Steam
+
+## [3.1.8] 2023-01-18
+### Fixed
+- Progress window blocking rest of window stack
+- Bug when updating old mods if automod set to ON
+
+## [3.1.7] 2023-01-06
+### Fixed
+- Hotfix for xdotool repeating input
+
+## [3.1.6] 2023-01-01
+### Changed
+- Tick low pop servers by default
+
+## [3.1.5] 2023-01-01
+### Fixed
+- Validate BM key on initial setup
+- Fix history menu not parsing query ports correctly
+### Changed
+- More permissive Steam client discovery for tiling WMs
+
+## [3.1.4] 2022-12-10
+### Fixed
+- Issue #43: Hotfix for workspace-driven WMs
+
+## [3.1.3] 2022-12-06
+### Fixed
+- Explicitly require Python 3
+
+## [3.1.1-2] 2022-12-03
+### Fixed
+- Fix lockfile path
+
+## [3.1.0] 2022-12-03
+### Added
+- Recent connect history
+- Simple, OS-agnostic automod installation
+- Track local mod versions
+- Force update local mods option
+- Added python to dependencies
+- File-picker driven path discovery on initial setup
+### Dropped
+- Headless mod installation
+- Drop server ID field requirement on initial setup
+### Changed
+- Clean up main menu options
+- Enforce Steam API key on initial setup
+- More accurate path discovery on initial setup
+- Add thousands separator to player counts in server browser
+### Fixed
+- Initial setup dialog causing early crash
+- Improved error handling on initial setup to avoid malformed config files
+- Delete server menu not clearing when returning to main menu
+- Handle whitelist deletion when only one entry present
+- Include path to drives under /run in path discovery
+- Use Steam-safe local zenity version
+
+## [3.0.7] 2022-11-25
+### Fixed
+- Hotfix for server reporting multiple versions of same mod
+
+## [3.0.6] 2022-11-09
+### Changed
+- More verbose logs
+
+## [3.0.5] 2022-10-27
+### Fixed
+- Properly create .desktop file on desktop PCs
+
+## [3.0.3-4] 2022-10-16
+### Fixed
+- Steam Deck path discovery on first-time setup
+
+## [3.0.2] 2022-10-12
+### Fixed
+- Size of certain popups on Steam Deck
+
+## [3.0.1] 2022-10-12
+### Fixed
+- Initial popup size on Steam Deck
+
+## [3.0.0] 2022-10-12
+### Added
+- Foreground progress of manual mod subscriptions
+- Automatic mod helper through steamcmd
+- Forum link
+- Enforce Steam API
+### Dropped
+- Stop retrieving extra metadata from BM
+### Changed
+- Reorder main menu
+- More verbose error messages
+- Better abstraction of URLs
+### Fixed
+- Width and text of some popups on Steam Deck
+
+## [2.7.2] 2022-10-07
+### Fixed
+- Fix internal URL
+
+## [2.7.1] 2022-10-05
+### Fixed
+- Game launch not kicking off after symlink creation
+
+## [2.7.0] 2022-10-04
+### Added
+- Server browser and geolocation algorithm
+- More verbose error codes
+- Additional progress bar setup and destruction throughout the application
+- Additional API response validation
+### Fixed
+- Encapsulate title strings to prevent leaky arguments in title bars
+- Remove erroneous slow boot process if first-time setup was already complete
+- Delete server list not emptying when returning to main menu
+### Changed
+- Group main menu entries in advance of future functionality
+- Better abstraction of paths
+- Clarification of certain options and errors
+
+## [2.6.3] 2022-10-02
+### Fixed
+- Hotfix for connect-to-fav not getting modlist
+
+## [2.6.2] 2022-10-02
+### Fixed
+- Hotfix for BM API returning malformed publishedfileids
+
+## [2.6.1] 2022-09-25
+### Fixed
+- Freedesktop shortcut errors
+
+## [2.6.0] 2022-09-05
+### Added
+- Connect by IP method
+
+## [2.5.1] 2022-08-17
+### Fixed
+- Hotfix for malformed paths during first-time setup
+
+## [2.5.0] 2022-08-16
+### Added
+- Lockfile: prevent concurrent instances of DZGUI from being opened
+
+### Changed
+- Faster path discovery on first-time setup
+
+### Fixed
+- Symlink collision on servers with many mods
+- API response pagination for large server lists
+
+## [2.4.1] 2022-08-09
+### Fixed
+- Hotfix for progress bar breaking table when >9 servers in list
+
+## [2.4.0] 2022-08-07
+### Added
+- Delete server command added to main menu
+- Write log to file for bug reports
+- Prompt to permanently increase map count size
+- Dependency check for Steam
+- Cover artwork
+- News backend for OTA updates
+- Clean up stale symlinks when checking mods
+
+### Fixed
+- Minify long mod launch params for servers with launch params breaking the upper limit
+- Port DZTUI method of handling legacy symlinks
+- Prevent user from entering invalid data on first-time setup
+- Prompt to re-run first-time setup if config is malformed
+- Better handling of field output from table
+- Better Steam Deck detection and handling
+- Prevent garbage in error messages
+- Miscellaneous backend improvements
+
+### Changed
+- Enforce download when switching branches
+
+## [2.3.2] 2022-08-04
+### Fixed
+Set branch flag to 'stable' if no config file present
+
+## [2.3.1] 2022-08-04
+### Fixed
+- Improved error handling of first-time setup fields
+- Interpolate config file values for debug, branch when writing file
+
+### Changed
+- Prompt user to restart first-time setup if broken config is found
+
+## [2.3.0] 2022-07-18
+### Added
+- Numbered mod links in browser
+- Admonition to upgrade versions for bug fixes
+- Toggle branch between stable/testing
+
+### Fixed
+- Hotfix for fav server select on main menu
+
+## [2.2.1] 2022-07-17
+### Fixed
+- Hotfix for upstream API returning malformed modlists
+- Handle servers with no mods
+- Fix dialog window depending on browser exit
+- Remove stray newlines in config file
+
+## [2.2.0] 2022-06-22
+### Added
+- Toggle debug mode in-app
+
+## [2.1.0] 2022-06-19
+### Changed
+- Updated link to new documentation
+
+## [2.0.3] 2022-06-17
+### Fixed
+- Safer expansion of originating script path
+
+## [2.0.2] 2022-06-16
+### Fixed
+- Remove enforced runtime check of workshop path
+
+## [2.0.2] 2022-06-16
+### Fixed
+- Expansion of Steam path prefix when default path was found
+
+## [2.0.1] 2022-06-16
+### Fixed
+- Regenerate mod links file in browser when clicking dialog
+- Reset whitelist when canceling one-shot (fav) mode
+
+## [2.0.0] 2022-06-15
+### Added
+- Attempt to find DayZ path and write to config on first launch
+- Merge existing config values into new config format when upgrading version
+- Dynamically detect Steam Deck and set launch parameters
+- Add "gametime" column to server list
+- One-shot mode to open mod links in browser if using desktop
+- Add favorite server from main menu
+- Update favorite server changes in real time
+- Add link to help pages from main menu
+- Add link to changelog from main menu
+### Changed
+- Don't require duplication of fav server in whitelist
+- More permissive truncation of long server names (50 char limit)
+- Render mod list as a scrollable menu
+- Reword errors for greater verbosity
+- Initial support of granular error handling for API response codes
+- Move extended path variables out of user config
+### Fixed
+- Check if mod dir is sane before listing mods
+- Prevent favorite server launch if none set
+- Reset server list to entire whitelist if canceling out of fav connect
+- Do not load table on empty API response and warn user
+- Suppress stderr cruft in logs and use logger instead
+
+## [1.2.1] 2022-06-12
+### Fixed
+- Print the entire changelog
+- Add confirmation dialog before run
+
+## [1.2.0] 2022-06-12
+### Changed
+- Mod validation process now uses faster, single-pass API query
+- Improved logger output when setting fav server
+
+### Added
+- In-app changelog
+
+## [1.1.2] 2022-06-08
+### Fixed
+- Fix array used for mod concatenation; fetch post-sanitized list of mods
+
+## [1.1.1] 2022-06-05
+### Fixed
+- Stricter regex to parse upstream version number
+
+## [1.1.0] 2022-06-05
+### Added
+- Main menu: fav server label on header
+- Main menu: add servers by ID directly into config file
+- Main menu: link to report a bug
+- Main menu: quick connect to fav server
+- Connect: mod compatibility check
+- Connect: mod download prompt
+- Connect: mod auto symlinks
+- New version download prompt
+- Additional visualization of progress/menus
+### Fixed
+- Menu recursion when navigating backwards
+### Changed
+- Reduced ping timeout interval

CODE_OF_CONDUCT.md

@@ -0,0 +1,34 @@
+# Preamble
+This project is free and open source software (FOSS) that is improved upon through the collaborative efforts of its community.
+
+To foster a collegial and productive atmosphere, all interactions with this project and its members shall be subject to these standards.
+
+"Members" refers to all project maintainers, contributors, developers, and end-users.
+Bear in mind that members may come from different countries, age groups, and backgrounds, and have differing experience levels.
+
+# Standards
+- Do not engage in antagonistic, offensive, discriminatory, threatening, or inflammatory behavior or trolling towards other members under any circumstances.
+- Engage in professional communication and stay on topic. Keep banter and jokes to a minimum, as they are liable to be misconstrued.
+- Do not post offensive or inflammatory off-site content, or content violating the above standards or the terms of service of this site.
+- Do not post spam. The site operator implements anti-spam measures that may lead to your account being revoked.
+- While this project relates to the DayZ computer game, it is not a forum for non-technical discussion about the game, or a place to post unsolicited links.
+- Do not use images, emoji reactions, or other non-verbal gags as justification for skirting the above standards.
+
+# Off-site content
+From time to time, it may be necessary to include off-site reference material or links. Use discretion when selecting this content and provide
+the minimum necessary for a technical discussion of the matter. Do not willfully include content that violates the above standards.
+
+# Enforcement
+Violations of the above standards will be subject to moderation decisions.
+
+Project maintainers reserve the right to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned with these standards, and will communicate reasons for moderation decisions when appropriate.
+
+Depending on the nature of the violation, or if the violation is not corrected after a warning has been issued, the user may be permanently barred from further interaction with the project.
+
+# Technical support
+This project is free software, but this does not imply a guarantee of free, unlimited tech support and troubleshooting in perpetuity.
+The software is provided as-is, and no warranty is made as to its fitness for a given purpose or that it is free from defects.
+
+Project members volunteer their time. Do not disparage other members when they attempt to assist you.
+Be aware that if you cannot provide enough information when filing a ticket, this may lead to the ticket being closed as non-actionable.

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/dzgui-devel/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/dzgui-devel/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.

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,127 +1,34 @@
-# DZTUI
+## What this is
+DZGUI allows you to connect to both official and modded/community DayZ servers on Linux and provides a graphical interface for doing so.
 
-A TUI pseudo-browser for listing heads-up information on DayZ community servers, fetching and synchronizing mods, and connecting to these servers automatically without manually setting launch 
-parameters.
+This overcomes certain limitations in the Linux client and helps prepare the game to launch by providing features like:
 
-![Alt text](example.png)
+- Search for and display server metadata in a table (server name, player count, ping, queue size, current gametime, distance, IP)
+- Add/delete/manage favorite servers by IP or ID
+- Quick-connect to favorite/recent servers
+- Find and prepare mods being requested by servers (choose from manual or automatic installation)
+- Bulk delete/update local mods
+- Concatenate launch options to pass to Steam
+- Connect to mod-enabled LAN servers
 
-## Dependencies:
+## Design philosophy
 
-- `jq`
-- `column` version with support for the `-o` flag  (part of `util-linux`)
-- `steam` 
+DZGUI follows a specific set of guidelines, enumerated below:
 
-## Preparation
+- 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
 
-1. Update the sysctl `vm.max_map_count` value (see https://www.protondb.com/app/221100)
-2. Enable the Steam Beta branch (Steam > Settings > Account > Beta participation)
-3. Enable as your compatibility tool for the game Proton Experimental, 6.3-8, or later--or repacks based on these
+## Setup and usage
 
-## Configuration
+Refer to the documentation for installation and setup instructions:
 
-User settings are configured at the top of the file in the "CONFIG" section. They are listed below in order of appearance in the file. This step is mandatory. Once the values have been correctly filled in, everything else should work by itself. The file comes with some default values for you for reference.
-
-Read this carefully. The tool will prompt you if keys are configured incorrectly, but preparing your config correctly will save you time and help you understand how to modify it in the future.
-
-Ensure that you preserve quotation marks around key values.
-
-### Basic configuration
-
-|Key|Meaning|
-| ------ | ------ |
-|steam_path|Used as a prefix to simplify interpolation of the `workshop_dir` and `game_dir` keys. If both the `workshop_dir` and `game_dir` path reside under the same install point, you need only set the key `steam_path` with the root directory of the Steam install. If you have the game installed in a path separate from the mods (multiple drives, etc.), you can safely ignore the `steam_path` variable and replace the `steam_path` prefix in the two variables below with their explicit paths.
-|workshop_dir|The path to Steam workshop content (mods). Always ends in `steamapps/content/221100`.|
-|game_dir|The path to the DayZ installation. Always ends in `steamapps/common/DayZ`.|
-|key|Your unique API key; you must register for a free API key at https://www.battlemetrics.com/account/register?after=%2Fdevelopers|
-|whitelist|A comma-separated list of server IDs you want to browse; look through https://www.battlemetrics.com/servers/dayz and select the ones you like. The server ID is the string of numbers at the end of the URL, e.g., https://www.battlemetrics.com/servers/dayz/12269772 = 12269772|
-|fav|The server ID of a single server you want to flag as your "favorite" -- a default server to fast connect to when using the `f` keybinding. This value is optional and can be left blank. Note: if using a favorite server, you must include this ID in both the `whitelist` value and in the `fav` value. E.g., if `333` is your favorite server: `whitelist="111,222,333"` and `fav="333"`. Your favorite server will be listed with an arrow next to it in the table. The API enforces a sorting algorithm on requests instead of returning them in serial order, so the favorite server may not always appear in the same place in the list. |
-|name|Some servers require a profile name; this can be any name of your choice. By default, it is set for you as "player". This value is optional and can be left blank.|
-|separator|Used to separate fields in the table; can be a single character of your choice. This value is optional and can be left blank if you prefer simple tab justification.|
-|ping|If set to 1, each of the servers is pinged once before showing the results and a time column is added; if you do not need this option, you can set it to 0 to greatly speed up load time.|
-|debug|If set to 1, performs a "dry-run" connection and prints the launch parameters that would have been used instead of actually connecting to a server, provided no critical errors occur with mod setup. Doesn't quit, so can be used to perform multiple dry-runs in sequence.|
-
-## Advanced configuration: automation with steamcmd
-
-NOTE: This feature is experimental and is still being improved upon.
-
-The advanced configuration is used in conjunction with the basic configuration settings above, but modifies mod downloading behavior. Note: requires installation of `steamcmd`. This is found in the "STEAMCMD Config" section of the file.
-
-See https://developer.valvesoftware.com/wiki/SteamCMD for additional details.
-
-|Key|Meaning|
-| ------ | ------ |
-|auto_install_mods|if set to 1, uses steamcmd to automatically stage mods without manual subscription necessary|
-|steam_cmd_user|the name of the local system user that invokes steamcmd (recommended user is `steam`)|
-|steam_username|the login handle of the real steam account that owns DayZ (this is required for mods; you cannot anonymously download mods without a license)|
-|staging_dir|the intermediate path to stage downloaded mods to before moving them to the real user's `workshop_dir`. `/tmp` is used by default (see explanation below). 
-
-### Some explanation of how steamcmd works follows:
-
-`steamcmd` is chiefly designed for updating content on game servers. As such, it is shipped as a command-line application and is designed to be run by a user isolated from the rest of the system. It allows for programmatic login to a Steam account and fetching/updating content in a headless fashion. While this can be done anonymously for downloading game server content, to download mods tied to an actual game, you need the game license (i.e. own the game). This means you must log in to retrieve mods.
-
-Valve recommends creating an isolated user called `steam` that is used to invoke `steamcmd` and fetch content. This is a reasonable suggestion and makes sense for a server context in particular. Once logged in, `steamcmd` by design stores and hashes the login credentials to uniquely identify the user and obviate further manual password entry from the same account. After prompting for a password (and 2FA code, where applicable), it won't ask for them again unless the hash is removed or the login user is changed.
-
-You must create the `steam` user (or some other user of your choice) on the local system, and install `steamcmd` from your repositories or download the upstream binary.
-
-For our purposes, isolating the user still seems like a good idea, but this introduces a challenge: how to fetch the content as the user `steam` and then make it available to the real user in the least kludgy manner possible? Obviously, if the users are isolated from each other, the `steam` user shouldn't be allowed to wantonly write files to the real user's space, and vice versa, the real user shouldn't be able to go into the `steam` user's space.
-
-I initially thought making use of a common/shared directory that both users have group permissions to would be good: the `steam` user could fetch the mods, then move them to this common directory, which is set to recursively inherit permissions. The real user then grabs the content out of there and puts it in their real mod path. This seemed overengineered, though, and you have to mess about with group permissions  and umasks, and would a user create a totally clean directory for this purpose, as I did, or just set their `$HOME`? It seemed rife with problems. Another alternative here would be to use access control lists (ACL), but, again,  this just seemed like overkill, and I didn't like the idea of users wantonly moving files in and out of some unspecified directory, especially if someone chose to set this as an important directory path.
-
-Eventually, I chose something more streamlined: 
-
-1. We use `sudo` to perform a one-time invocation of `steamcmd` as the `steam` user (`sudo -u $steamcmd_user ...`)
-2. steamcmd fetches the mods as a concatenated list in one go, and writes them to `/tmp` (`+force_install_dir $staging_dir`). `/tmp` seemed like the ideal choice because, by design, all users can see this directory, and it uses the sticky bit, so it's painless to change ownership of the incoming files to the real user and move them out. Lastly, `/tmp` is the de facto place for ephemeral files, so there is no worry about destructively changing files if the write operation is malformed for some reason--although it is unlikely to be. Note that `steamcmd` does not have great error handling or provide correct return codes even if the wrong credentials are supplied, and likes to write a `steamapps`directory (albeit empty) into the destination directory when failing. Taking this into account, `/tmp` seemed like a good place.
-3. `sudo` is used to change ownership of the incoming files back to the real user and its effective group id (`sudo chown -R $USER:$gid $staging_dir/steamapps`)
-4. The individual mod ID directories are copied out of `/tmp` to the real mod path.
-4. Once finished, the directory leftovers are removed from `/tmp` (`rm -r $staging_dir/steamapps`). The `steamapps` root may contain some files we don't want to conflict with the real workshop path, so we just take the mods, not the whole directory stack. Later invocations of `steamcmd` may fail if there is some detritus in `steamapps`, so it needs to be removed.
-
-There are other ways of solving this, but in terms of skipping group and user management and keeping things fast and simple, this seems reasonable. At most, the user will be asked to input their Stream credentials once and never again until the hash is revoked, and their password (sudo) once. In addition, mod downloading stops becoming a recurring need once it's been done for a few servers.
-
-Obviously, those credentials go through `steamcmd` directly to Valve and not through this script. See the function `auto_mod_download()` to see the exact command being used.
-
-## Usage:
-
-Run `dztui` and it will populate the table with server info for the server IDs you selected. The column at left shows keybindings. Enter the number of a server and push Return to attempt to connect to it. The connection process checks your installed mods against the server's and will warn you if any are missing. Servers are listed in descending order of player count.
-
-- Enter `f` to connect to your usual server (the one you marked as favorite above) without having to look through the list.
-- Enter `l` to print the list of your installed mods.
-- Enter `q` to quit.
-
-Under a normal configuration, if mods are missing, links to their Workshop pages will be shown as a list, and you must open these manually and click "Subscribe" in the Steam client and wait for them to download.
-
-If using the advanced configuration, mods will be auto-downloaded with `steamcmd` in a batch.
-
-Once mods are finished downloading, you can attempt to reconnect. The mods will be checked for compability again and if the local and remote mod list matches, symlinks to the installed workshop content will be created in the DayZ path.
-
-Lastly, the launch options and mod list will be concatenated and used to launch the game and connect to the destination server. The tool exits upon a successful connection attempt. Use the `debug` configuration key if you encounter problems and want to see what launch parameters would have been used. This can be useful for manual testing or seeing what mods are on certain servers. 
-
-## Known Issues/Possible Pitfalls:
-
-- Ubuntu's `column` package may be too old to support setting field separators correctly. (TODO: add separate section detailing how to install and compile package)
-- The ping attempt is only made once as a fast check with no retries.
-- It goes without saying, but you need to have a sufficiently wide enough terminal window to justify the text correctly.
-- There is no pagination, so if there are more servers than lines in your terminal, you are going to have to scroll up.
-- Servers don't verbosely report the version of mods they are running, so other than checking that the mod exists, we can't easily compare version differences. This means you may get booted on connect if your mod is not up to date. (Shouldn't happen due to Steam updates, but it's theoretically possible if a server is pegged to some older version). If that happens, you could manually install the desired version and reconnect.
-- The server protocol enforces a maximum length of 64 characters, so server names should never exceed the acceptable width of the table, making truncation unneccessary.
-- This was not tested with Flatpak steam or Steam native runtime. If there is a particular method of invocation for those, submit an issue.
-- Official servers do not get indexed by server trackers in the usual manner, so this works only with custom servers. It might be possible to include a manifest of official servers in a future revision, however.
-- ~~In testing, at least one server behaved strangely despite the correct launch parameters being given and refused to start. (Investigating)~~ **Thanks to the user scandalouss for help in resolving this issue**
-- You may still encounter weird bugs from DayZ itself due to the unstable nature of the client. (E.g., "User is not connected to Steam" when loading into a map.)
-- Wasn't tested on esoteric terminal emulators or fancy configs. (Tested against urxvt)
-
-## Q&A
-
-Q. Why not use a custom server query API?
-
-A. It is technically feasible using A2S, but is complicated and offers little benefit other than further automation (no API registration) and slightly more granular control over the server info returned. Still, I would like to include that at some point through a helper file.
-
-Q. Why not allow browsing all servers in real time?
-
-A. It greatly complicates the scope. There are 10K+ servers that would have to be queried and some kind of manifest created, to say nothing of sorting, searching, pagination, etc. Having a simple heads-up list of your servers of interest should suffice for most use cases. I am thinking of rewriting this in curses as a fully-featured browser at some point, but we would have to see what improvements are made to the in-game browser and launcher to see if this is maintainable or even necessary in the first place.
-
-Q. What about adding the field «insert some field name here»?
-
-A. See above. "Number of players in queue" could be added to help decide whether to join a full server, but this requires a custom API.
+- [GitHub](https://aclist.github.io/dzgui/index.html)
+- [Mirror (Codeberg)](https://aclist.codeberg.page)
 
+![A screenshot of DZGUI](/images/example.png)
 
+## Attribution
 
+Geolocation records from [DB-IP](https://db-ip.com) under [CC 4.0 license](https://creativecommons.org/licenses/by/4.0/)

dztui.sh

@@ -1,324 +0,0 @@
-#!/bin/bash
-set -eo pipefail
-version=0.3.0
-release_url="https://raw.githubusercontent.com/aclist/dztui/main/dztui.sh"
-aid=221100
-game="dayz"
-workshop="https://steamcommunity.com/sharedfiles/filedetails/?id="
-api="https://api.battlemetrics.com/servers"
-
-#BEGIN CONFIG================
-steam_path="/path/to/steam"
-workshop_dir="$steam_path/steamapps/workshop/content/$aid"
-game_dir="$steam_path/steamapps/common/DayZ"
-key="APIKEY"
-whitelist="8039514,8789747,4363928,8199330,11359652,12862329"
-fav="8789747"
-name="player"
-separator="│"
-ping=1
-debug=0
-#END CONFIG================
-
-#STEAMCMD CONFIG===========
-auto_install_mods=0
-steamcmd_user="steam"
-steam_username="STEAMUSER"
-staging_dir="/tmp"
-#END STEAMCMD CONFIG=======
-
-declare -A deps
-deps=([awk]="5.1.1" [curl]="7.80.0" [jq]="1.6" [column]="2.37.2" [tr]="9.0" [comm]="9.0")
-max_range=$(awk -F, '{print NF}' <<< $whitelist)
-
-err(){
-	printf "[ERROR] %s\n" "$1"
-	return 1
-}
-version_check(){
-	upstream=$(curl -Ls "$release_url" | awk -F= 'NR==3 {print $2}')
-	printf "[INFO] Checking for new version\n"
-	if [[ ! $upstream == "$version" ]]; then
-		printf "[INFO] A newer version of DZTUI is available at:\n$release_url.\n" 
-		while true; do 
-			read -p "Continue anyway? [Y/n] " response
-			if [[ $response == "Y" ]]; then 
-			       break
-			elif [[ $response == "n" ]]; then
-			       exit_msg
-			else 
-			       :
-			fi
-		done
-	fi
-}
-depcheck(){
-	for dep in "${!deps[@]}"; do
-		command -v $dep 2>&1>/dev/null || (printf "[ERROR] Requires %s >= %s\n" $dep ${deps[$dep]} ; exit 1)
-	done
-}
-column_check(){
-	echo foo | column -o$'\t' &>/dev/null || err "column version >= 2.37.2 required"
-}
-varcheck(){
-	[[ -z $key ]] && (err "Missing API key")
-	[[ -z $whitelist ]] && (err "Missing server IDs")
-	[[ ! -d $workshop_dir ]] && (err "Malformed workshop path")
-	[[ ! -d $game_dir ]] && (err "Malformed game path")
-	[[ $whitelist =~ [[:space:]] ]] && (err "Separate whitelist values with commas")
-	IFS=,
-	[[ ! "${whitelist[*]}" =~ "${fav}" ]] && (err "Fav key value not in whitelist")
-	unset IFS
-}
-checks() {
-	depcheck
-	column_check
-	version_check
-	varcheck
-}
-check_ping(){
-	if [[ $ping -eq 1 ]]; then
-		ping_ip=$(echo -e "$i" | awk -F'\t' '{print $2}' | awk -F: '{print $1}')
-		ms=$(ping -c 1 "$ping_ip" | awk -Ftime= '/time=/ {print $2}')
-		[[ -z $ms ]] && ms="Timeout" || :
-		printf "%s\t%s\n" "$i" "$ms"
-	else
-		printf "%s\n" "$i"
-	fi
-}
-parse_json(){
-	list=$(jq -r '.data[] .attributes | "\(.name)\t\(.ip):\(.port)\t\(.players)/\(.maxPlayers)\t\(.status)\t\(.id)"')
-	readarray -t list <<< $list
-	for i in "${list[@]}"; do
-		check_ping
-	done
-}
-symlinks(){
-	for d in "$workshop_dir"/*; do
-		id=$(awk -F"= " '/publishedid/ {print $2}' "$d"/meta.cpp | awk -F\; '{print $1}')
-		mod=$(awk -F\" '/name/ {print $2}' "$d"/meta.cpp | sed -E 's/[^[:alpha:]0-9]+/_/g; s/^_|_$//g')
-		link="@$id-$mod"
-		[[ -h "$game_dir/$link" ]] && : || 
-			printf "[INFO] Creating symlink for $mod\n"
-			ln -fs "$d" "$game_dir/$link"
-	done
-}
-installed_mods(){
-	ls -1 "$workshop_dir"
-}
-
-list_mods(){
-	printf "Installed mods: "
-	for d in $(installed_mods); do
-		awk -F\" '/name/ {print $2}' "$workshop_dir"/$d/meta.cpp
-	done | sort | awk 'NR > 1 { printf(", ") } {printf("%s",$0)}'
-	printf "\n"
-}
-
-columnize(){
-       	column -t -s$'\t' -o$" $separator "
-}
-test_fav(){
-	if [[ -n $fav ]]; then
-		if [[ $(echo -e "${tabled[$i]}" | awk -F'\t' -v fav=$fav '$5 == fav') ]] ; then
-			printf "%s│▶%s\n" "$i" "${tabled[$i]}"
-		else
-			printf "%s│ %s\n" "$i" "${tabled[$i]}"
-		fi
-	else
-		printf "%s│ %s\n" "$i" "${tabled[$i]}"
-	fi
-}
-table(){
-	range=$((${#tabled[@]} - 1))
-	for ((i=0;i<="$range";i++)); do
-		test_fav
-	done 
-}
-concat_mods(){
-	readarray -t serv <<< "$remote_mods"
-	for i in "${serv[@]}"; do
-		id=$(awk -F"= " '/publishedid/ {print $2}' "$workshop_dir"/$i/meta.cpp | awk -F\; '{print $1}')
-		mod=$(awk -F\" '/name/ {print $2}' "$workshop_dir"/$i/meta.cpp | sed -E 's/[^[:alpha:]0-9]+/_/g; s/^_|_$//g')
-		link="@$id-$mod;"
-		echo -e "$link"
-	done | tr -d '\n' | perl -ple 'chop'
-}
-launch(){
-	mods=$(concat_mods)
-	ip=$(echo -e "${tabled[$sel]}" | awk -F'\t' '{print $2}')
-	printf "[INFO] Connecting to: $connecting_to\n"
-	if [[ $debug -eq 1 ]]; then
-		printf "[DEBUG] steam -applaunch $aid -connect=$ip -nolauncher -nosplash -skipintro \"-mod=$mods\"\n"
-	else
-		steam -applaunch $aid -connect=$ip -nolauncher -nosplash -skipintro -name=$name \"-mod=$mods\"
-		printf "Good luck out there. DZTUI $version\n"
-		exit
-	fi
-}
-launch_fav(){
-	if [[ -n $fav ]]; then
-		sorted_id=$fav
-		sel=$(table | awk -F'\t' -v fav=$fav '$5 == fav {print substr($1,1,1)}')
-		connect
-	else
-		printf "[INFO] No favorite set\n"
-	fi
-}
-manual_mod_install(){
-	printf "[ERROR] Missing mods. Open these links and subscribe to each one, then reconnect\n"
-	for i in $diff; do
-		printf "%s%s\n" "$workshop" $i
-	done
-}
-steamcmd_modlist(){
-	for i in $diff; do
-	printf "+workshop_download_item %s %s " $aid $i
-	done
-}
-move_files(){
-	sudo chown -R $USER:$gid "$staging_dir"/steamapps
-	cp -R "$staging_dir"/steamapps/workshop/content/$aid/* "$workshop_dir"
-	rm -r "$staging_dir"/steamapps
-}
-auto_mod_download(){
-	sudo su -c "steamcmd +force_install_dir $staging_dir +login $steam_username $(steamcmd_modlist) +quit" $steamcmd_user
-	[[ "$(ls -A $staging_dir/steamapps)" ]] && move_files || return 1
-}
-auto_mod_install(){
-	printf "[ERROR] Missing mods. Invoking steamcmd for user $steamcmd_user\n"
-	if [[ -z $steamcmd_user ]]; then 
-		err "steamcmd user value was empty. Reverting to manual mode"
-	elif
-		id $steamcmd_user &>/dev/null
-		[[ $? -eq 1 ]]; then
-		err "Invalid steamcmd user. Reverting to manual mode"
-	elif
-		command -v steamcmd &>/dev/null
-		[[ $? -eq 1 ]]; then
-		err "steamcmd not installed. See: https://developer.valvesoftware.com/wiki/SteamCMD"
-	else
-		printf "[INFO] Found steamcmd user. Downloading mods\n"
-		revert_msg="Something went wrong. Reverting to manual mode"
-		auto_mod_download
-		[[ $? -eq 0 ]] && printf "\n"; init_table || err "$revert_msg"
-	fi
-
-}
-failed_mod_check(){
-	[[ $auto_install_mods -eq 1 ]] && auto_mod_install || manual_mod_install
-}
-passed_mod_check(){
-	printf "[INFO] Mod check passed\n"
-	connecting_to=$(echo -e "${tabled[$sel]}" | awk -F'\t' '{print $1,$2}')
-	symlinks
-	launch
-
-}
-check_workshop(){
-	curl -Ls "$url${modlist[$i]}" | grep data-appid | awk -F\" '{print $8}'
-}
-validate_mods(){
-	url="https://steamcommunity.com/sharedfiles/filedetails/?id="
-	aid=221100
-	tput civis
-	newlist=()
-	readarray -t modlist <<< $remote_mods
-	for ((i=0;i<=${#modlist[@]};i++)); do
-		printf "[INFO] Verifying integrity of server modlist manifest [$i/${#modlist[@]}]\r"
-		[[ $(check_workshop) -eq $aid ]] && newlist+=("${modlist[$i]}") || :
-		sleep 2s
-	done
-	tput cnorm
-	printf "\n"
-}
-server_modlist(){
-	for i in "${newlist[@]}"; do
-		printf "$i\n"
-	done
-}
-compare(){
-	fetch_mods
-	validate_mods
-	diff=$(comm -23 <(server_modlist | sort) <(installed_mods | sort))
-}
-connect(){
-	compare
-	if [[ -n $diff ]]; then
-		failed_mod_check
-	else
-		passed_mod_check
-	fi
-}
-fetch_mods(){
-	remote_mods=$(curl -s "$api" -H "Authorization: Bearer "$key"" -G -d filter[ids][whitelist]="$sorted_id" -d "sort=-players" \
-	| jq -r '.data[] .attributes .details .modIds[]')
-}
-query_api(){
-	response=$(curl -s "$api" -H "Authorization: Bearer "$key"" -G -d "sort=-players" \
-		-d "filter[game]=$game" -d "filter[ids][whitelist]=$whitelist")
-	if [[ "$(jq -r 'keys[]' <<< $response)" == "errors" ]]; then
-		printf "[ERROR] %s: check API key\n" "$(jq -r '.errors[] .status' <<< $response)"
-		return 1
-	elif 
-		[[ -z "$(jq -r '.data[]' <<< $response)" ]]; then
-		printf "[ERROR] Check server ID\n"
-		return 1
-	fi
-}
-init_table(){
-	tput civis
-	printf "[INFO] Polling servers. Please wait.\r"
-	query_api
-	readarray -t tabled <<< $(parse_json <<< $response)
-	tput cnorm
-	tput cuu1
-	tput el
-	table | columnize
-}
-get_sorted_id(){
-	sorted_id=$(echo -e "${tabled[$sel]}" | awk -F'\t' '{print $5}')
-}
-menu(){
-	printf "\n"
-	printf "f$separator Launch favorite\n"
-	printf "l$separator List installed mods\n"
-	printf "r$separator Refresh\n"
-	printf "q$separator Quit\n"
-	printf "\n"
-}
-exit_msg(){
-	printf "DZTUI $version\n"
-	exit
-}
-forced_exit(){
-	tput cnorm
-	printf "\n"
-	exit_msg
-}
-main(){
-	checks
-	init_table
-	while true; do
-		menu
-		read -p "Selection: " sel
-		if [[ $sel =~ ^[0-9]+$ ]]; then
-			if [[ $sel -gt $max_range ]]; then
-				:
-			else
-				get_sorted_id
-				connect
-			fi
-		else
-			case $sel in
-				r) init_table ;;
-				f) launch_fav ;;
-				l) list_mods ;;
-				q) exit_msg ;;
-				*) : ;;
-			esac
-		fi
-	done
-}
-trap forced_exit INT
-main

helpers/lan

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+query_name(){
+    local ip="$1"
+    local port="$2"
+    local api="$HOME/.local/share/dzgui/helpers/query_v2.py"
+    python3 "$api" "$ip" "$port" test
+}
+
+scan(){
+    local ip="$1"
+    local port="$2"
+    local res=$(query_name "$ip" "$port")
+    [[ -z $res ]] && return 1
+    printf "%s\n" "${ip}:XXX:${port}"
+}
+
+get_netmask(){
+    ip r \
+        | awk '/default/ {print $3}' \
+        | uniq \
+        | awk -F. 'OFS="."{print $1,$2,$3}'
+}
+
+iter(){
+    _testping(){
+        ping -c1 -i 0.1 -w 1 "$1" 2>/dev/null 1>&2
+        [[ $? -eq 0 ]] && echo "$1"
+    }
+    export -f _testping
+    local mask=$(get_netmask)
+    # GNU parallel is not available OOTB on Steam Deck
+    for i in $(seq 1 255); do
+        echo "${mask}.${i}"
+    done | xargs -I {} -P 200 bash -c '_testping "{}"'
+}
+
+export -f scan
+export -f query_name
+
+DZG_LAN_PORT="$1"
+
+readarray -t ips < <(iter)
+for i in "${ips[@]}"; do
+    scan "$i" $DZG_LAN_PORT
+done

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/query.py

@@ -0,0 +1,51 @@
+import sys
+import a2s
+import math
+import json
+from a2s import dayzquery
+sys.path.append('a2s')
+
+def get_info(ip, qport):
+    try:
+        info = a2s.info((ip, int(qport)))
+
+        name = info.server_name
+        address = ip + ":" + str(info.port)
+        count = str(info.player_count) + "/" + str(info.max_players)
+        keywords = info.keywords
+        ping = (info.ping*1000)
+        ping = math.floor(ping)
+
+        res = {}
+
+        res['name'] = name
+        res['address'] = address
+        res['count'] = count
+        res['keywords'] = keywords
+        res['stat'] = "online"
+        res['qport'] = qport
+        res['ping'] = str(ping) + "ms"
+
+        j = json.dumps(res)
+
+        print(j)
+    except:
+        sys.exit(1)
+
+def get_rules(ip, qport):
+    try:
+        mods = dayzquery.dayz_rules((ip, int(qport))).mods
+        for k in mods:
+            print(k.workshop_id)
+    except:
+        sys.exit(1)
+
+ip = sys.argv[1]
+qport = sys.argv[2]
+mode = sys.argv[3]
+
+match mode:
+    case "info":
+        get_info(ip, qport)
+    case "rules":
+        get_rules(ip, qport)

helpers/query_v2.py

@@ -0,0 +1,85 @@
+import sys
+import a2s
+import math
+import json
+from a2s import dayzquery
+sys.path.append('a2s')
+
+def test_local(ip, qport):
+    try:
+        info = a2s.info((ip, int(qport)), 0.5)
+        name = info.server_name
+        print(name)
+    except:
+        sys.exit(1)
+
+def get_info(ip, qport):
+    try:
+        info = a2s.info((ip, int(qport)))
+
+        name = info.server_name
+        map = info.map_name
+        address = ip + ":" + qport
+        gameport = str(info.port)
+        players = info.player_count
+        max_players = info.max_players
+        keywords = info.keywords
+        ping = (info.ping*1000)
+        ping = math.floor(ping)
+
+        res = {}
+
+        res['name'] = name
+        res['map'] = map
+        res['gametype'] = keywords
+        res['players'] = players
+        res['max_players'] = max_players
+        res['addr'] = address
+        res['gameport'] = gameport
+        res['stat'] = "online"
+        res['qport'] = qport
+        res['ping'] = str(ping) + "ms"
+
+        j = json.dumps([res])
+
+        print(j)
+    except:
+        sys.exit(1)
+
+def get_rules(ip, qport):
+    try:
+        mods = dayzquery.dayz_rules((ip, int(qport))).mods
+        for k in mods:
+            print(k.workshop_id)
+    except:
+        sys.exit(1)
+
+def get_names(ip, qport):
+    try:
+        mods = dayzquery.dayz_rules((ip, int(qport))).mods
+        ids = []
+        names = []
+        for mod in mods:
+            names.append(mod.name)
+            ids.append(mod.workshop_id)
+        res = {}
+        res['names'] = names
+        res['ids'] = ids
+        j = json.dumps(res)
+        print(j)
+    except:
+        sys.exit(1)
+
+ip = sys.argv[1]
+qport = sys.argv[2]
+mode = sys.argv[3]
+
+match mode:
+    case "info":
+        get_info(ip, qport)
+    case "rules":
+        get_rules(ip, qport)
+    case "names":
+        get_names(ip, qport)
+    case "test":
+        test_local(ip, qport)

helpers/servers.py

@@ -0,0 +1,472 @@
+import json
+import math
+import os
+import re
+import socket
+import subprocess
+import sys
+import typing  # noqa
+
+from dataclasses import dataclass
+from urllib import request, parse
+from urllib.error import HTTPError
+from typing import Union
+
+sys.path.append("a2s")
+import a2s  # noqa
+from a2s import dayzquery  # noqa
+
+params = [
+    r"\nor\1\map\chernarusplus\nor\1\map\sakhal\nor\1\map\enoch\empty\1\nor\1\map\namalsk",  # noqa
+    r"\map\namalsk\empty\1",
+    r"\map\namalsk\noplayers\1",
+    r"\map\chernarusplus\empty\1",
+    r"\map\chernarusplus\noplayers\1",
+    r"\map\sakhal\empty\1",
+    r"\map\sakhal\noplayers\1",
+    r"\map\enoch\empty\1",
+    r"\map\enoch\noplayers\1",
+]
+
+
+class BmAPIError(Exception):
+    pass
+
+
+class BmIdError(Exception):
+    pass
+
+
+class InvalidIpError(Exception):
+    pass
+
+
+def get_netmask() -> str:
+    hostname = os.uname()[1]
+    i = socket.gethostbyname(hostname)
+    netmask = i.rsplit(".", 1)[0]
+    return netmask
+
+
+def test_ip(suffix: int, port: int) -> dict | None:
+    netmask = get_netmask()
+    hostname = f"{netmask}.{str(suffix)}"
+    ping = ["ping", "-c1", "-i", "0.1", "-w", "1"]
+    output = subprocess.run(ping + [hostname], capture_output=True)
+    if output.returncode == 0:
+        return query_direct(hostname, port)
+    return None
+
+
+def sanitize(name: str) -> str:
+    name = re.sub(r"\r", r"", name)
+    name = re.sub(r"\n", r"", name)
+    name = re.sub(r"\x01", r"", name)
+    name = re.sub(r"\ufeff", r"", name)
+    name = re.sub(r"(^!\s*)", r"-", name)
+    name = re.sub(r"(^-\s*)", r"", name)
+    name = re.sub(r"(^-)", r"", name)
+    name = re.sub(r"(^\s*)", r"", name)
+    name = re.sub(r"\t", "", name)
+    return name
+
+
+def parse_json(json: list) -> list:
+    """
+    Server metadata is underspecified and server operators
+    tend to insert random garbage in the headers. In case
+    sanitization failed, discard malformed rows rather than
+    aborting outright.
+    """
+    rows = []
+    for row in json:
+        try:
+            name = sanitize(row["name"])
+            if name == "":
+                continue
+        except KeyError:
+            continue
+
+        malformed = False
+        for key in [
+            "map",
+            "gametype",
+            "players",
+            "max_players",
+            "addr",
+            "gameport",
+        ]:
+            try:
+                row[key]
+            except KeyError:
+                malformed = True
+                break
+
+        if malformed is True:
+            continue
+
+        try:
+            r = row["gametype"].split(",")
+        except KeyError:
+            continue
+
+        if "no3rd" in r:
+            view = "1PP"
+        else:
+            view = "3PP"
+
+        if "external" in r:
+            provider = "Unoffic."
+        else:
+            provider = "Official"
+
+        if "mod" in r:
+            modded = True
+        else:
+            modded = False
+
+        try:
+            r = row["gametype"].split("lqs")
+            queue = r[1].split(",")[0]
+        except IndexError:
+            queue = 0
+
+        try:
+            test_time = re.search(r"[0-9]{2}:[0-9]{2}", row["gametype"])
+            if test_time:
+                time = test_time.group(0)
+            else:
+                time = "Unknown"
+        except AttributeError:
+            time = "Unknown"
+
+        try:
+            ip = row["addr"].split(":")[0] + ":" + str(row["gameport"])
+            qport = row["addr"].split(":")[1]
+        except IndexError:
+            continue
+
+        try:
+            ping = row["ping"]
+        except KeyError:
+            ping = 9999
+
+        mapname = row["map"].lower()
+        players = row["players"]
+        max_players = row["max_players"]
+        raw = [
+            name,
+            mapname,
+            view,
+            time,
+            int(players),
+            int(max_players),
+            int(queue),
+            ip,
+            int(qport),
+            ping,
+            provider,
+            modded,
+        ]
+        rows.append(raw)
+    return rows
+
+
+def query_direct(ip: str, qport: int, TIMEOUT: float=3.0) -> dict | None:
+    try:
+        info = a2s.info((ip, qport), TIMEOUT)
+
+        name = info.server_name
+        mapname = info.map_name
+        address = ip + ":" + str(qport)
+        gameport = str(info.port)
+        players = info.player_count
+        max_players = info.max_players
+        keywords = info.keywords
+
+        try:
+            ping = info.ping
+            ping = math.floor(info.ping * 1000)
+        except AttributeError:
+            ping = 9999
+
+        res = {}
+        res["name"] = name
+        res["map"] = mapname
+        res["gametype"] = keywords
+        res["players"] = players
+        res["max_players"] = max_players
+        res["addr"] = address
+        res["gameport"] = gameport
+        res["ping"] = ping
+        return res
+    except TimeoutError:
+        return None
+    except KeyError:
+        return None
+
+
+@dataclass(slots=True, frozen=True)
+class Res:
+    status: int
+    parsed: bool
+    json: Union[str, None]
+
+
+@dataclass(slots=True, frozen=True)
+class Ping:
+    addr: str
+    iteration: int
+    ping: int
+
+
+@dataclass(slots=True, frozen=True)
+class Details:
+    data: Union[list, None]
+    description: str
+    success: 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 Prereqs(False, 0, None, None)
+
+    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:
+    default_str = "None provided"
+
+    try:
+        info = a2s.info((ip, qport))
+    except TimeoutError:
+        return Details(None, default_str, False)
+    try:
+        rules = dayzquery.dayz_rules((ip, int(qport)))
+    except TimeoutError:
+        return Details(None, default_str, False)
+
+    try:
+        keywords = info.keywords.split(",")
+    except AttributeError:
+        return Details(None, default_str, False)
+
+    battleye = "Disabled"
+    if "battleye" in keywords:
+        battleye = "Enabled"
+
+    day_accel = 0.0
+    night_accel = 0.0
+    for keyword in keywords:
+        if "etm" in keyword:
+            day_accel = float(keyword.lstrip("etm"))
+            day_accel = float(f"{day_accel:g}")
+        if "entm" in keywords:
+            night_accel = float(keyword.lstrip("entm"))
+            night_accel = float(f"{night_accel:g}")
+
+    try:
+        password = info.password_protected
+        if password is False:
+            password = "Disabled"
+        else:
+            password = "Enabled"
+    except AttributeError:
+        password = "-"
+
+    try:
+        vac = info.vac_enabled
+        if vac is False:
+            vac = "Disabled"
+        else:
+            vac = "Enabled"
+    except AttributeError:
+        vac = "-"
+
+    try:
+        version = info.version
+    except AttributeError:
+        version = "-"
+
+    try:
+        dlc = rules.dlc_flags
+        if dlc == 0:
+            dlc = "None"
+        if dlc == 2:
+            dlc = "Frostline"
+    except AttributeError:
+        dlc = "not specified"
+
+    try:
+        platform = rules.platform
+        if platform == "win":
+            platform = "Windows"
+        if platform == "?":
+            platform = "Linux"
+    except AttributeError:
+        platform = "not specified"
+
+    try:
+        description = rules.description.strip()
+        if description == "":
+            description = default_str
+    except AttributeError:
+        description = default_str
+
+    rows = [
+        ["Battleye", battleye],
+        ["Daytime acceleration", f"{day_accel}x"],
+        ["DLC", dlc],
+        ["Night-time acceleration", f"{night_accel}x"],
+        ["Password", password],
+        ["Platform", platform],
+        ["Valve Anti-Cheat", vac],
+        ["Version", version],
+    ]
+
+    return Details(rows, description, True)
+
+
+def ping(iteration: int, row: list) -> Ping:
+    addr = row[7]
+    qport = row[8]
+
+    res = None
+
+    if row[9] != 9999:
+        return Ping(addr, iteration, row[9])
+
+    try:
+        ip = addr.split(":")[0]
+    except IndexError:
+        ping = 9999
+
+    try:
+        res = query_direct(ip, qport, 0.5)
+    except Exception:
+        pass
+
+    if res is None:
+        ping = 9999
+    else:
+        ping = res["ping"]
+
+    return Ping(addr, iteration, ping)
+
+
+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" + fr"\{appid}" + param,
+        "limit": LIMIT,
+        "key": key,
+    }
+    par = parse.urlencode(payload)
+    url = f"{url}{par}"
+
+    status = 200
+    parsed = True
+    data = None
+
+    try:
+        with request.urlopen(url) as response:
+            if response.status != 200:
+                status = response.status
+            try:
+                parsed = True
+                data = json.load(response)
+            except json.decoder.JSONDecodeError:
+                parsed = False
+                data = None
+    except HTTPError:
+        status = 403
+        parsed = False
+        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/sums.md5

@@ -0,0 +1,2 @@
+e7f3b25223ac4dfd5e30a0b55bb3ff6c  ips.csv
+b038fdb8f655798207bd28de3a004706  latlon

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;
+}

helpers/vdf2json.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+
+from shlex import shlex
+
+def vdf2json(stream):
+
+    """
+    Read a Steam vdf file and return a string in json format
+    """
+
+    def _istr(ident, string):
+        return (ident * '  ') + 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'
+def main():
+    """
+    Read Steam vdf and write json compatible conversion
+    """
+    import sys
+    import argparse
+
+    parser = argparse.ArgumentParser(prog='vdf2json', description=main.__doc__)
+    parser.add_argument('-i', '--input',
+                        default=sys.stdin,
+                        type=argparse.FileType('r'),
+                        help='input vdf file (stdin if not specified)')
+    parser.add_argument('-o', '--output',
+                        default=sys.stdout,
+                        type=argparse.FileType('w'),
+                        help='output json file (stdout if not specified)')
+
+    args = parser.parse_args()
+    args.output.write(vdf2json(args.input))
+
+if __name__ == '__main__':
+    main()

install.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+get_response_code(){
+    local url="$1"
+    curl -Ls -I -o /dev/null -w "%{http_code}" "$url"
+}
+abort(){
+    printf "Remote resource not available. Try again later.\n"
+    exit 1
+}
+fetch(){
+    local file="dzgui.sh"
+    local author="aclist"
+    local repo="dztui"
+    local branch="dzgui"
+    local url
+    local res
+    gh_url="https://raw.githubusercontent.com/$author/$repo/$branch/$file"
+    cb_url="https://codeberg.org/$author/$repo/raw/branch/$branch/$file"
+
+    url="$gh_url"
+    printf "Checking the remote resource at '%s'\n" "$url"
+    res=$(get_response_code "$url")
+    if [[ $res -ne 200 ]]; then
+        url="$cb_url"
+        printf "Checking the remote resource at '%s'\n" "$url"
+        res=$(get_response_code "$url")
+        if [[ $res -ne 200 ]]; then
+            abort
+        fi
+    fi
+
+    curl -L "$url" > dzgui.sh
+    chmod +x dzgui.sh
+    xdg_file="$HOME/.local/share/applications/dzgui.desktop"
+    share="$HOME/.local/share/dzgui"
+    [[ -f $xdg_file ]] && rm $xdg_file
+    [[ -d $share ]] && rm -rf "$share"
+    ./dzgui.sh
+}
+
+fetch