Merge pull request #468 from aclist/fix/wizard-config-exit

fix: write config later in install wizard

.github/workflows/mirror.yml

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

CHANGELOG.md

@@ -1,5 +1,10 @@
-## Added
+# Changelog
+
+## [7.0.0] Unreleased
+### Added
 - Setup wizard
+- Uninstall wizard
+- Descriptive details panel to certain error dialogs
 - Changelog text wrapping and formatting
 - Changelog ships with source
 - Documentation ships with source
@@ -21,6 +26,7 @@
 - Set favorite server from tables
 - Detailed/copyable trace in critical error dialogs
 - Visual icons
+- Unset favorite server button
 - Integrated server notebook
 - Propagate width changes to all tables
 - Remember tree position in menus
@@ -34,12 +40,26 @@
 - Early load alerts button
 - Preconnect dialog
 - Preconnect warnings/failsafes like filesize
+- Save filters per server context between sessions
+- Preboot progress dialog
+- Choose to jump into splash screen instead of server
+- Collapsible connection panel
+- Play offline (load mods directly)
+- Generate Steam shortcuts and cover art
+- Warn user if background downloads are disabled
+- Dynamic copy button
+- Update map count (-u flag)
+- Filter button tooltips
+- Expand/collapse changelog versions
+- Support local light/dark mode changes on system theme
 
-
-## Changed
+### Changed
 - Conform to PEP 440 versioning for beta versions
+- Enforce fullscreen mode on Steam Deck
 - Reduce padding on keys button
 - Boldface breadcrumbs
+- Changed some dialog error messages from popups to popovers
+- Changed how filter buttons are packed in sidebar
 - Bold labels inside frames
 - Sidebar buttons do not steal focus
 - Copy IP copies IP:queryport only instead of IP:gameport:queryport, mimics syntax needed by add by ip method
@@ -49,26 +69,815 @@
 - Suppress log messages from imported modules
 - Embed Workshop link in Options menu
 - Disable overlay scrollbars on server tables
+- Reduce size of geolocation DB on disk (~100MB)
+- Enable LAN page Empty/Full filters on first run of app
+- Propagate subscribed mods to Steam client
+- Make j/k keys in context menus follow same wraparound logic as down arrow/up arrow
 
-## Dropped
-- Debug mode
+### Dropped
+- Battlemetrics API support
+- Unused metadata from system log files
 - Branch switching
 - Manual mod install mode (describe rationale)
 - Force update mods
 
-## Fixed
+### Fixed
 - Longstanding issue with left clicks not registering as tree selection changes after spamming keyboard input
+- In-game time field missing certain ranges of time at night
+- Wrap long entries in changelog
+- Certain server descriptions with special characters not rendering correctly
 - Center server title text on server dialogs
 - Rare segfaults when changing maps (threading)
 - Moved dialogs out of threads
+- History table not being in lock-step with state file
+- Current keyword filter not being applied when refreshing table
 
-## Unreleased
+### Unreleased
 - Load offline mods
-- Choose to jump into splash screen instead of server
 - Local documentation
 - Raw debug command in context menu
 
-## Developer-facing
+### Developer-facing
 - Add pyproject.toml file
 - Show deprecation warnings
 - Options -> Dev page
+
+## [6.0.5] 2026-05-17
+### Changed
+- Update symlink hash logic to align with DZGUI 7 beta
+- Update A2S helper to latest commit
+
+## [6.0.4] 2026-04-13
+### Fixed
+- Update A2S module checksums to support servers with missing description field
+
+## [6.0.3] 2026-04-12
+### Fixed
+- Use GLibUnix namespace where available when setting up SIGINT callback
+
+## [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

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Introduction
+
+Thank you for your interest in DZGUI!
+
+This guide goes over development conventions and best practices for contributors.
+If you are a developer, you can skip to the end.
+
+# Requesting help
+
+If you encounter a problem with DZGUI, you can submit tickets on the GitHub
+[issue tracker](https://github.com/aclist/dztui/issues) under the
+`troubleshooting` tag.
+
+# How can I help the project?
+
+There are several ways to help this project.
+1. Report bugs that you find
+2. Request features that you would like
+3. Contribute features and fixes to the codebase
+4. Contribute documentation to the project
+
+Before making any contribution, please read the `CODE_OF_CONDUCT.md` and act
+accordingly.
+
+## Submitting a ticket
+
+Navigate to the GitHub [issue tracker](https://github.com/aclist/dztui/issues).
+From there, follow the onscreen prompts. You will be asked questions such as:
+
+- What version are you using?
+- What distribution are you using?
+- What is the issue that you found?
+- How can we reproduce the issue?
+
+You can also attach screenshots, logs, or other data that can help us.
+
+## Requesting a feature
+
+You can also request features via the same issue tracker. It is good practice to
+first search for your idea to see if a similar one has already been posted.
+If not, open a ticket where you describe your feature and its possible benefits.
+
+Please note that this is a community project, so it takes time for us to develop
+features. Putting in a feature request does not mean that it will be implemented,
+but we will do our best to support as many cool ideas as possible.
+
+## Contributing code or documentation
+
+If you would like to 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 the `dzgui7` (development) branch.
+
+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 `dzgui7`. After sufficient changes are consolidated into a new release,
+this branch will be tagged to a certain point in time and a binary release published.
+
+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.
+
+Please see DEVELOPERS.md for further details.
+
+## License applicability to contributions
+
+Code contributed to this repository becomes subject to the terms of the GPL license defined in the LICENSE file at the project root.

DEVELOPERS.md

@@ -1,18 +1,30 @@
 # TODO: link to here from sphinx docs
 
-# Setting up precommit hooks
-pre-commit install
+## Installing from source
 
-# Fetching submodules
+### Fetch submodules
 git submodule update --recursive --init
 
-# Installing dev dependencies
-uv pip install -e .[dev]
+### Install with dev dependencies
+uv pip install -e '.[dev]'
 
-# Building documentation
+This includes all dependencies for building, linting, testing, and checking in code.
+If you optionally want to install only a subset of dev tools, replace 'dev' with the following flag:
+
+build: package release deps
+docs: documentation tools
+lint: code linting, fixing, and type checking
+test: unit and integration tests
+
+## Miscellaneous
+
+### Setting up precommit hooks
+pre-commit install
+
+### Building documentation
 sphinx-build -M html source build -a
 
-# Building standalone DZGUI release binaries
-1. Run `./scripts/dl_pyapp.sh`
+### Building standalone release binaries
+1. Set up the build target: `rustup target add x86_64-unknown-linux-musl`
 2. Run `python3 scripts/release.py`
-3. Generate a release and tag against the bundled `dzgui` executable
+3. Generate a release and tag against the resulting tarfile generated in `dist`

LICENSE

@@ -1,8 +1,3 @@
-Additional licenses to git submodules not explicitly shipped with the source code:
-python-a2s: https://raw.githubusercontent.com/Yepoleb/python-a2s/refs/heads/master/LICENSE
-dayzquery: https://raw.githubusercontent.com/Yepoleb/dayzquery/refs/heads/master/LICENSE
-
-
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 

README.md

@@ -24,13 +24,8 @@ Please refer to the documentation for installation and setup instructions:
 
 Geolocation records from [DB-IP](https://db-ip.com) under [CC 4.0 license](https://creativecommons.org/licenses/by/4.0/)
 
-This tool uses [python-a2s](https://github.com/Yepoleb/python-a2s) and [dayzquery](https://github.com/Yepoleb/dayzquery) as submodules; licenses for these submodules can be found in the LICENSES file
-of the project root.
-
-Both the geolocation records and submodules listed above are not shipped with the source code, but are retrieved and assembled at runtime.
-
-Finally, executable versions of DZGUI shipped as release binaries are thin wrappers around the Python interpreter, and also retrieve and assemble the above dependencies at runtime on the end-user's
-machine, rather than using pre-compiled source code. Users wishing to review these dependencies can inspect the 'pyproject.toml' manifest in the project root.
+Executable versions of DZGUI published as release binaries ship with various runtime dependencies and the Python interpreter built in.
+Users wishing to review the licenses to these components can inspect the `LICENSE` file located in the release tarball.
 
 ## Disclaimer
 

docs/licenses/PyGObject/COPYING

@@ -0,0 +1,502 @@
+		  GNU LESSER GENERAL PUBLIC LICENSE
+		       Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+     51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+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 this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+		  GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+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
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser 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 Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+			    NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "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
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY 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
+LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+           How to Apply These Terms to Your New Libraries
+
+  If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change.  You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey 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 library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!

docs/licenses/Python/LICENSE

@@ -0,0 +1,48 @@
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+--------------------------------------------
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+("PSF"), and the Individual or Organization ("Licensee") accessing and
+otherwise using this software ("Python") in source or binary form and
+its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
+license to reproduce, analyze, test, perform and/or display publicly,
+prepare derivative works, distribute, and otherwise use Python
+alone or in any derivative version, provided, however, that PSF's
+License Agreement and PSF's notice of copyright, i.e., "Copyright (c)
+2001, 2002, 2003, 2004 Python Software Foundation; All Rights Reserved"
+are retained in Python alone or in any derivative version prepared
+by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS"
+basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between PSF and
+Licensee.  This License Agreement does not grant permission to use PSF
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.

docs/licenses/dayzquery/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Gabriel Huber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/licenses/packaging/LICENSE

@@ -0,0 +1,176 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+

docs/licenses/psutil/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2009, Jay Loden, Dave Daeschler, Giampaolo Rodola
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name of the psutil authors nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

docs/licenses/python-a2s/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Gabriel Huber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/licenses/requests/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

docs/licenses/vdf/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Rossen Georgiev <rossen@rgp.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/source/conf.py

@@ -36,5 +36,5 @@ html_show_copyright = False
 html_show_sourcelink = False
 
 today_fmt = "%Y-%m-%d"
-release = "7.x.x"
-version = "7.x.x"
+release = "6.x.x - 7.x.x"
+version = "6.x.x - 7.x.x"

docs/source/dzgui6.rst

@@ -0,0 +1,110 @@
+Installation (DZGUI 6 legacy)
+==================
+
+Basic runtime dependencies
+---------------------------------
+
+If not already installed, the below can be found in your system’s package manager.
+
+If any dependencies are missing when the application starts, it will warn you, so you need not take any preemptive measures here.
+
+- curl
+- jq
+- steam
+- wmctrl or xdotool
+- zenity
+
+.. note::
+    All dependencies are installed out of the box on Steam Deck.
+
+UI dependencies (Python and PyGObject)
+---------------------------------------
+.. important::
+    As of version 6.0.0, you must have a valid Python 3.13 and matching PyGObject environment.
+    Depending on your distribution, this may require additional manual intervention.
+
+Arch Linux (vanilla variants)
+^^^^^^^^^^^^^^^^^^^^^^
+You will need the ``python3.13`` package, if it is not already installed.
+
+Install the following build dependencies:
+
+.. code:: console
+
+   sudo pacman -S cmake gcc pkgconf python-cairo
+
+.. include:: venv.rst
+
+CachyOS (Arch)
+^^^^^^^^^^^^^^^^^^^^^^^
+Refer to the build instructions for Arch Linux first.
+The ``python3.13`` package is not available on CachyOS, so it is recommended to
+use ``uv`` to manage Python versions.
+
+.. code:: console
+
+   sudo pacman -S uv
+
+.. include:: venv.rst
+
+Manjaro 26 (Arch)
+^^^^^^^^^^^^^^^^^^^^^^^
+If Python 3.13 is not already available out of the box, refer to the build instructions for :ref:`Arch Linux (vanilla variants)`.
+
+Debian 13 variants
+^^^^^^^^^^^^^^^^^^^^^^^
+Python 3.13 and PyGObject are available out of the box. No additional steps are necessary.
+You can proceed to the :ref:`Installscript`.
+
+Fedora 43 variants
+^^^^^^^^^^^^^^^^^^^^^^^
+Fedora 43 ships with a newer version of Python (3.14), so you must set up Python 3.13 in its own
+virtual environment (venv) to prevent it from conflicting with the system package.
+
+Install the following build dependencies:
+
+.. code:: console
+
+    sudo dnf install cairo cairo-devel cairo-gobject-devel gcc python3.13 python3.13-devel
+
+.. include:: venv.rst
+
+Ubuntu 24 variants
+^^^^^^^^^^^^^^^^^^^^^^
+Ubuntu ships with an older version of Python (3.12). You must install additional dependencies.
+Add the PPA below to add Python 3.13 to your sources:
+
+.. code:: console
+
+    sudo add-apt-repository ppa:deadsnakes/ppa
+
+Install the following build dependencies:
+
+.. code:: console
+
+    sudo apt install python3.13 python3.13-venv python3.13-dev build-essential python3-gi-cairo pkg-config libgirepository-2.0-dev libcairo2-dev
+
+.. include:: venv.rst
+
+Installscript
+-----------------------
+
+Invoke the command below from a terminal. This script fetches the main DZGUI script from the repository,
+makes it executable, and launches DZGUI's first-time setup. After running this installscript, you will
+have the file ``dzgui.sh`` wherever you invoked the command.
+
+.. code:: console
+
+    curl -s "https://codeberg.org/aclist/dztui/raw/branch/dzgui/install.sh" | bash
+
+nixOS installation
+----------------------
+Two packages are independently maintained by other contributors. Each takes a slightly different approach.
+nixOS packages are standalone and do not require cloning the git repository.
+
+- https://github.com/lelgenio/dzgui-nix
+- https://github.com/jiriks74/dzgui.flake
+
+Next steps
+---------------
+Proceed to the :doc:`setup` section for setup instructions.

docs/source/dzgui7.rst

@@ -0,0 +1,33 @@
+Installation (DZGUI 7 beta)
+==================
+
+In order to make the first-time setup experience easier for end-users, DZGUI 7 no longer requires
+the tool to be installed from source code into a working Python environment. All necessary dependencies and the
+runtime environment are built-in.
+
+Turnkey installer
+------------------------
+
+- Visit the project's `Releases page <https://github.com/aclist/dztui/releases/latest>`_.
+- Extract the DZGUI tarball from the top of the **Assets** list.
+- From a terminal, run the command ``./dzgui`` or double click on the extracted file in
+  a file explorer.
+- Once the setup wizard opens, follow the steps at the bottom of this page.
+
+UI dependencies (Python and PyGObject)
+---------------------------------------
+On most major distributions, GObject introspection libraries should be available by default.
+
+If you receive an error about a missing ``libgirepository-2.0`` dependency, install it via your system's package manager.
+
+On Debian-based distributions (Ubuntu, etc.), this package is not explicitly installed on the system.
+You can install it via the following set of commands:
+
+.. code:: console
+
+   sudo apt update
+   sudo apt install libgirepository-2.0-0
+
+Next steps
+---------------
+Proceed to the :doc:`setup` section for setup instructions.

docs/source/installation.rst

@@ -1,110 +1,28 @@
 Installation
 ==================
 
-Basic runtime dependencies
----------------------------------
+As of this writing, you have a choice of two DZGUI versions:
 
-If not already installed, the below can be found in your system’s package manager.
+- DZGUI 6: Legacy stable version, more complicated to install
+- DZGUI 7: Unstable beta version, much easier to install
 
-If any dependencies are missing when the application starts, it will warn you, so you need not take any preemptive measures here.
+DZGUI 6
+--------------------
+This version is no longer receiving feature updates, but will receive security updates until it is replaced by DZGUI 7.
 
-- curl
-- jq
-- steam
-- wmctrl or xdotool
-- zenity
+DZGUI 6 must be installed from the source code and has many more package dependencies and prerequisites for it to function correctly.
+If you are looking for a one-click, self-contained installer, use :ref:`DZGUI 7` instead.
 
-.. note::
-    All dependencies are installed out of the box on Steam Deck.
+To install **DZGUI 6**, visit :doc:`dzgui6`.
 
-UI dependencies (Python and PyGObject)
----------------------------------------
-.. important::
-    As of version 6.0.0, you must have a valid Python 3.13 and matching PyGObject environment.
-    Depending on your distribution, this may require additional manual intervention.
 
-Arch Linux (vanilla variants)
-^^^^^^^^^^^^^^^^^^^^^^
-You will need the ``python3.13`` package, if it is not already installed.
+DZGUI 7
+--------------------
+This version is currently in beta testing and has all of the features found in DZGUI 6, but may be unstable.
 
-Install the following build dependencies:
+DZGUI 7 has an all-in-one installer and setup wizard, and many new features not found in DZGUI 6.
+However, this codebase is newer and is provided as a pre-release beta candidate.
 
-.. code:: console
+If you want the simplest installer and don't mind experiencing the occasional bug, use this version.
 
-   sudo pacman -S cmake gcc pkgconf python-cairo
-
-.. include:: venv.rst
-
-CachyOS (Arch)
-^^^^^^^^^^^^^^^^^^^^^^^
-Refer to the build instructions for Arch Linux first.
-The ``python3.13`` package is not available on CachyOS, so it is recommended to
-use ``uv`` to manage Python versions.
-
-.. code:: console
-
-   sudo pacman -S uv
-
-.. include:: venv.rst
-
-Manjaro 26 (Arch)
-^^^^^^^^^^^^^^^^^^^^^^^
-If Python 3.13 is not already available out of the box, refer to the build instructions for :ref:`Arch Linux (vanilla variants)`.
-
-Debian 13 variants
-^^^^^^^^^^^^^^^^^^^^^^^
-Python 3.13 and PyGObject are available out of the box. No additional steps are necessary.
-You can proceed to the :ref:`Installscript`.
-
-Fedora 43 variants
-^^^^^^^^^^^^^^^^^^^^^^^
-Fedora 43 ships with a newer version of Python (3.14), so you must set up Python 3.13 in its own
-virtual environment (venv) to prevent it from conflicting with the system package.
-
-Install the following build dependencies:
-
-.. code:: console
-
-    sudo dnf install cairo cairo-devel cairo-gobject-devel gcc python3.13 python3.13-devel
-
-.. include:: venv.rst
-
-Ubuntu 24 variants
-^^^^^^^^^^^^^^^^^^^^^^
-Ubuntu ships with an older version of Python (3.12). You must install additional dependencies.
-Add the PPA below to add Python 3.13 to your sources:
-
-.. code:: console
-
-    sudo add-apt-repository ppa:deadsnakes/ppa
-
-Install the following build dependencies:
-
-.. code:: console
-
-    sudo apt install python3.13 python3.13-venv python3.13-dev build-essential python3-gi-cairo pkg-config libgirepository-2.0-dev libcairo2-dev
-
-.. include:: venv.rst
-
-Installscript
------------------------
-
-Invoke the command below from a terminal. This script fetches the main DZGUI script from the repository,
-makes it executable, and launches DZGUI's first-time setup. After running this installscript, you will
-have the file ``dzgui.sh`` wherever you invoked the command.
-
-.. code:: console
-
-    curl -s "https://codeberg.org/aclist/dztui/raw/branch/dzgui/install.sh" | bash
-
-nixOS installation
-----------------------
-Two packages are independently maintained by other contributors. Each takes a slightly different approach.
-nixOS packages are standalone and do not require cloning the git repository.
-
-- https://github.com/lelgenio/dzgui-nix
-- https://github.com/jiriks74/dzgui.flake
-
-Next steps
----------------
-Proceed to the next section for setup instructions.
+To install **DZGUI 7**, visit :doc:`dzgui7`.

docs/source/kb.rst

@@ -3,16 +3,26 @@ Knowledge Base
 
 .. _DZG-001:
 
-DZG-001: Periodically getting dropped from servers, or servers appear unreachable
+DZG-001: Timeouts occur while trying to query a specific server
 ------------------------------------------------------------------------------------
-It is a longstanding issue in DayZ that the game opens a large number of connections when querying servers and/or while connected to servers.
-This can result in excess traffic on the user's PC which, depending on how much headroom your network has, can lead to getting dropped, unresponsiveness, or a timeout.
+The leading cause of specific servers periodically timing out is local network configuration.
 
-If you are on Wi-Fi, try switching to a wired connection and see if the problem resolves itself. If it does, your wireless router settings do not have enough headroom for max simultaneous connections. Use a wired connection, or update your network settings to a more permissive setup.
+Many third-party DayZ servers use a server rental/hosting provider with DDoS protection.
+This can cause responses from servers to originate from a server other than the one originally queried.
 
-Bohemia has acknowledged this issue going back 10+ years and stated that DayZ has a heavy impact on the network, but there is as yet no proposed solution on the DayZ side.
+Consumer-grade routers are likely to drop this traffic as invalid due to how they handle NAT (network address translation).
+By contrast, wireless routers and enterprise-grade routers may be less likely to have this issue.
 
-This issue is frequently seen on Steam Deck, due to the tendency for users to use it in an untethered Wi-Fi setup.
+If you find that a specific server is unresponsive for you when it shouldn't be, add a port forwarding rule to your router's settings for
+the server's query port.
+
+In addition, a uniform packet size is expected. If your router's MTU setting differs from the default of 1,500,
+it could lead to incoming responses being discarded (see warning below).
+
+
+.. important::
+   Ensure that MTU (maximum tranmission unit) on your network is set to the standard size of 1,500 bytes.
+   If your network preferences or router have "jumbo" frames enabled, packets may be dropped, causing server queries to time out.
 
 .. _DZG-002:
 
@@ -34,7 +44,7 @@ DZG-004: On Steam Deck, some mods in the Workshop show a black screen when DZGUI
 ---------------------------------------------------------------------------------------------------------
 This is a bug in the Steam client that is being tracked at Valve's Steam for Linux issue tracker here: https://github.com/ValveSoftware/steam-for-linux/issues/9598.
 
-To resolve this issue, manually intervene in the Steam client by selecting a different context (e.g., Store, Library), waiting for it to load, then navigating back to the Workshop context. This should 
+To resolve this issue, manually intervene in the Steam client by selecting a different context (e.g., Store, Library), waiting for it to load, then navigating back to the Workshop context. This should
 clear the blockage and allow the contents to render.
 
 .. _DZG-005:
@@ -75,3 +85,28 @@ There is some misconception that a Steam Web API key could be used to gain infor
 A Steam Web API key is the most strict way of getting authentic, reliable, and consistent server information in a zero-trust model.
 
 You are responsible for the creation, storage, management, and revocation of your Web API key.
+
+DZG-008: Periodically getting dropped from servers while connected
+-------------------------------------------------------------------
+In some cases, DayZ opens a large number of connections while connected to servers.
+
+If your network does not have enough headroom or has settings departing from defaults, this may lead to getting dropped from servers,
+unresponsiveness, or a timeout.
+
+If you are on Wi-Fi, try switching to a wired connection and see if the problem resolves itself. Consumer Wi-Fi routers
+tend to have less headroom for simultaneous connections than their wired counterparts.
+
+DZG-009: Floating dialogs appear maximized on tiling window managers
+-------------------------------------------------------------------
+
+The main DZGUI window and its child dialogs are expected to be rendered as floating by your window manager.
+DZGUI sends window manager hints to this effect, but tiling window managers designed to bisect the screen into quadrants (e.g., i3 window manager)
+may try to always launch applications in fullscreen.
+
+To resolve this, set specific exclusions or window hints in your WM's configuration file.
+For example, for i3, add the following to your `XDG_CONFIG_HOME/i3/config` file (defaults to `$HOME/.config/i3/config`):
+
+.. code:: console
+
+    for_window [instance="DZGUI"] floating enable, move position center
+    for_window [instance="DZGUI - Dialog"] floating enable, move position center

docs/source/setup.rst

@@ -4,7 +4,7 @@ Setup
 DayZ license
 -----------------
 
-Prepare a Steam account with a DayZ license (i.e., own the game). From Steam's right-click menu for the game options, under ``Compatibility``, enable a Proton version ≥ ``6.8`` (or use Proton 
+Prepare a Steam account with a DayZ license (i.e., own the game). From Steam's right-click menu for the game options, under ``Compatibility``, enable a Proton version ≥ ``6.8`` (or use Proton
 Experimental for the latest version).
 
 As of this writing, any recent version of Proton should work, and it is encouraged to use the most recent one.
@@ -33,20 +33,10 @@ Once configured, you can insert this key in the app when launching it for the fi
 
 Battlemetrics API key
 ^^^^^^^^^^^^^^^^^^^^^^
-**This step is optional, but recommended**. Using this key lets you also connect to and query servers by their shorthand ID instead of by IP.
+.. warning::
 
-Register for an API key at `BattleMetrics <https://www.battlemetrics.com/account/register?after=%2Fdevelopers>`_ (free).
-
-From the ``Personal Access Tokens area``, select ``New Token``.
-
-Give the token any name in the field at the top.
-
-Leave **all options unchecked** and scroll to the bottom. Select ``Create Token``.
-
-Once configured, you can insert this key in the app when launching it for the first time (optional), or later on when using the connect/query by ID methods in the app.
-
-.. tip::
-    Each server has a unique ID. This is the string of numbers at the end of the URL. For example, in the URL ``https://www.battlemetrics.com/servers/dayz/8039514``, the ID is ``8039514``.
+    This feature is no longer supported in DZGUI. Battlemetrics has switched to a paid service.
+    Battlemetrics queries are expected to fail in DZGUI 6. In DZGUI 7, this feature has been removed entirely.
 
 Next steps
 --------------

docs/source/steam.rst

@@ -1,6 +1,10 @@
 Steam integration
 ====================
 
+.. note::
+
+   In :doc:`DZGUI 7 <dzgui7>`, Steam shortcut creation and cover art setup are handled automatically during setup. You can skip this step unless you are using DZGUI 6.
+
 DZGUI can be added to Steam as a "non-Steam game" in order to facilitate integration with Steam Deck or desktop environments.
 
 First, launch Steam in the **Large** (default) view.
@@ -74,7 +78,7 @@ The final result will create box art looking like the above.
    :scale: 100%
    :alt: Adding a non-Steam game
 
-Next, right-click the DZGUI entry in your Library and select **Properties** to open the properties dialog. Next to the **Shortcut** field, you will see a small square box which represents the game’s 
+Next, right-click the DZGUI entry in your Library and select **Properties** to open the properties dialog. Next to the **Shortcut** field, you will see a small square box which represents the game’s
 icon. Click this to open a file explorer, navigate to ``$HOME/.local/share/dzgui``, and select ``icon.png``. This will add a small icon to the list view.
 
 Finally, after you launch DZGUI for the first time, you should quit the application and return to the Library view. Select the **Recent Games** dropdown on the right-hand side.

dzgui/api/acf.py

@@ -0,0 +1,119 @@
+import logging
+import re
+
+from collections.abc import Iterator
+from pathlib import Path
+from typing import Any
+from warnings import deprecated
+
+from dzgui.const.constants import APP_NAME
+
+logger = logging.getLogger(APP_NAME)
+
+
+class ACF:
+    def __init__(self, file: Path) -> None:
+        super().__init__()
+
+        self.dict: dict[str, Any]
+        self.load(file)
+
+    def as_dict(self) -> dict[str, Any]:
+        return self.dict
+
+    def load(self, file: Path) -> None:
+        delimiter = r"\t\t"
+        lines = []
+        # TODO: illegal file handling
+        with open(file, "r", encoding="utf-8") as f:
+            for line in f:
+                line = line.strip()
+                if not line:
+                    continue
+                els = re.split(delimiter, line, maxsplit=1)
+                lines.append(els)
+        self.dict = self.parse(iter(lines))
+
+    @classmethod
+    def enquote(cls, s: str) -> str:
+        return f'"{s}"'
+
+    @classmethod
+    def dequote(cls, s: str) -> str:
+        return s.rstrip('"').lstrip('"')
+
+    def parse(self, lines: Iterator[list[str]]) -> dict[str, str]:
+        acf: dict[str, Any] = {}
+        try:
+            while True:
+                line = next(lines)
+                if len(line) == 1:
+                    key = line[0]
+                    if key == "{":
+                        continue
+                        return acf
+                    elif key == "}":
+                        return acf
+                    else:
+                        key = self.dequote(key)
+                        acf[key] = self.parse(lines)
+                elif len(line) == 2:
+                    k, v = line
+                    k = self.dequote(k)
+                    v = self.dequote(v)
+                    try:
+                        n = list(acf.keys())[-1]
+                        acf[n][k] = v
+                    except Exception:
+                        acf[k] = v
+        except StopIteration:
+            return acf
+
+    def get_allows_downloads(self) -> int | None:
+        try:
+            # TODO: consider coercing strs to ints on initial import
+            flag = int(self.dict["AppState"]["AllowOtherDownloadsWhileRunning"])
+            return flag
+        except Exception as e:
+            logger.critical(e)
+            return None
+
+
+@deprecated(
+    "Serializing workshop files is no longer supported, use dzgui.api.steam.unsubscribe"
+)
+class WorkshopACF(ACF):
+    def __init__(self, file: Path) -> None:
+        super().__init__(file)
+
+    def unpack(self, d: dict, lines: list[Any] = []) -> str:
+        t1 = "AppWorkshop"
+        t2 = ("WorkshopItemsInstalled", "WorkshopItemDetails")
+        for k, v in d.items():
+            if type(v) is dict:
+                if k in t1:
+                    self.indent = 0
+                elif k in t2:
+                    self.indent = 1
+                else:
+                    self.indent = 2
+                pref = "\t" * self.indent
+                lines.append(pref + self.enquote(k))
+                lines.append(pref + "{")
+                self.unpack(v, lines)
+                lines.append(pref + "}")
+            else:
+                pref = "\t" * (self.indent + 1)
+                lines.append(pref + self.enquote(k) + "\t\t" + self.enquote(v))
+        s = ""
+        for line in lines:
+            s += line + "\n"
+        return s
+
+    def to_file(self, file: Path) -> None:
+        s = self.unpack(self.dict)
+        file.write_text(s)
+
+    def delete(self, modid: int) -> None:
+        del self.dict["AppWorkshop"]["WorkshopItemsInstalled"][modid]
+        del self.dict["AppWorkshop"]["WorkshopItemDetails"][modid]

dzgui/api/bm.py

@@ -1,40 +0,0 @@
-import logging
-import requests
-from typing import Any, Optional, TYPE_CHECKING
-
-from dzgui.const.constants import APP_NAME
-from dzgui.const.endpoints import BM_SERVERS
-
-logger = logging.getLogger(APP_NAME)
-
-if TYPE_CHECKING:
-    from dzgui.api.servers import Record
-
-
-def get_attributes(key: str, uid: int) -> Any:
-    # TODO: handle if key is not set
-    # TODO: tests for malformed IDs/values
-
-    hdr = {"Authorization": "Bearer " + key}
-    payload: dict[str, str] = {
-        "filter[game]": "dayz",
-        "sort": "-players",
-        "filter[ids][whitelist]": str(uid),
-    }
-    res = requests.get(BM_SERVERS, params=payload, headers=hdr)
-    res.raise_for_status()
-    j = res.json()["data"][0]["attributes"]
-    return j
-
-
-def map_id_to_record(key: str, uid: int) -> Optional["Record"]:
-    from dzgui.api.servers import Record
-
-    try:
-        record = get_attributes(key, uid)
-        ip = record["ip"]
-        port = int(record["port"])
-        qport = int(record["portQuery"])
-        return Record(ip, port, qport)
-    except Exception:
-        return None

dzgui/api/mods.py

@@ -1,18 +1,18 @@
 import hashlib
 import logging
-import shlex
+import re
 
 from concurrent.futures import wait
 from concurrent.futures import ThreadPoolExecutor
 from dataclasses import dataclass
 from pathlib import Path
 
-import dzgui.api.pefile as PeFile
+from dzgui.api.steam import get_app_path
 from dzgui.api.servers import get_rules, fqip_to_record
 from dzgui.const.constants import (
     APP_NAME,
     APPID_DAYZ,
-    LIBRARYFOLDERS_PATH,
+    DAYZ_COMMUNITY_ROOT,
     WORKSHOP_PATH,
 )
 
@@ -39,7 +39,7 @@ def get_local_mod_ids(steam_path: Path) -> list[int]:
 
 
 def get_local_mod_path(steam_path: Path) -> Path:
-    p = PeFile.get_app_path(steam_path / Path(LIBRARYFOLDERS_PATH), APPID_DAYZ)
+    p = get_app_path(steam_path, APPID_DAYZ)
     workshop_path = p / WORKSHOP_PATH
     return workshop_path
 
@@ -49,34 +49,33 @@ def get_local_mods(workshop_path: Path) -> list[Path]:
     return mods
 
 
-def parse_meta(file: Path) -> ModMeta | None:
-    mod = file / "meta.cpp"
-    if mod.exists() is False:
+def is_mission(path: Path) -> bool:
+    # TODO: parse integrity of other files
+    parent = path.parent.name
+    if parent != DAYZ_COMMUNITY_ROOT:
+        return False
+    file = path / "init.c"
+    return file.exists()
+
+
+def tokenize(mod: Path) -> dict[str, Any] | None:
+    file = mod.joinpath("meta.cpp")
+    delimiter = r"\s*=\s*"
+    modmeta = {}
+    try:
+        with open(file, "r", encoding="utf-8") as f:
+            for line in f:
+                line = line.strip().rstrip(";")
+                if not line:
+                    continue
+                els = re.split(delimiter, line, maxsplit=1)
+                if len(els) == 2:
+                    key, value = els
+                    modmeta[key.strip()] = value.strip('"')
+        return modmeta
+    except Exception as e:
+        logger.critical(e)
         return None
-    with open(file / "meta.cpp", "r") as f:
-        st = f.read()
-        lex = shlex.shlex(st)
-        lex.whitespace += "=;"
-        v = []
-        while True:
-            tok = lex.get_token()
-            if not tok:
-                break
-            if tok == "protocol" or tok == "publishedid":
-                ntok = lex.get_token()
-            elif tok == "timestamp":
-                # NOTE: some malformed .NET tick conversions result in numbers < 0
-                ntok = lex.get_token()
-                if ntok == "-":
-                    ntok += str(lex.get_token())
-            elif tok == "name":
-                ntok = lex.get_token()
-                if ntok is not None:
-                    ntok = ntok.split('"')[1]
-            if ntok is not None:
-                v.append(ntok)
-        meta = ModMeta(*v)
-        return meta
 
 
 def get_mod_size(path: Path) -> float:
@@ -87,49 +86,66 @@ def get_mod_size(path: Path) -> float:
     return size
 
 
-def get_delimited_mods(steam_path: Path) -> list[Any]:
-    workshop_path = get_local_mod_path(steam_path)
-    mods = get_local_mods(workshop_path)
+def get_custom_mods(path: Path) -> list[Any]:
+    # TODO: rename this function for clarity ("get local vs. get custom")
+    mods = get_local_mods(path)
+    # TODO: error handling
+    return parse_mods(mods, use_custom=True)
+
+
+def parse_mods(mods: list[Path], use_custom: bool = False) -> list[Any]:
     clean = []
     for mod in mods:
         mod_dir = mod.name
-        symlink = _hash(mod_dir)
-        # FIXME: malformed .cpp files could break this
-        # mention that mods may be downloading
-        meta = parse_meta(mod)
+        symlink = _hash(mod_dir, use_custom)
+        meta = tokenize(mod)
         if meta is None:
             continue
         size = get_mod_size(mod)
         # NOTE: final col is cell renderer highlight toggle
-        clean.append([meta.name, symlink, mod_dir, size, False])
+        clean.append([meta["name"], symlink, mod_dir, size, False])
     clean.sort(key=lambda row: str(row[0]).casefold())
     return clean
 
 
+def get_delimited_mods(steam_path: Path) -> list[Any]:
+    workshop_path = get_local_mod_path(steam_path)
+    mods = get_local_mods(workshop_path)
+    return parse_mods(mods)
+
+
 def get_missing_mods(local: list, remote: list) -> list:
     return [mod for mod in remote if mod not in local]
 
 
-def _hash(uid: str) -> str:
+def _hash(uid: str, use_custom: bool = False) -> str:
     md5 = hashlib.md5()
     md5.update(uid.encode("ascii"))
-    return "@" + md5.hexdigest()[:8]
+    prefix = "@C" if use_custom else "@"
+    return prefix + md5.hexdigest()[:8]
 
 
-def remove_stale_signatures(config: Path, versions: Path) -> None:
+def remove_stale_signatures(
+    config: Path, versions: Path, ids: list[int] | None = None
+) -> None:
     if versions.is_file() is False:
         logger.warning("Creating new version signatures file")
         versions.touch()
         return
+
     path = lookup(config, Preferences.DEFAULT)
     steam_path = Path(path)
-    ids = get_local_mod_ids(steam_path)
+    if ids is None:
+        local_ids = get_local_mod_ids(steam_path)
+
     with open(versions, "r") as f:
         lines = f.readlines()
-    for line in lines:
-        uid = int(line.split(",")[0])
-        if uid not in ids:
-            lines.remove(line)
+
+    if ids is None:
+        lines = [line for line in lines if int(line.split(",")[0]) in local_ids]
+    else:
+        lines = [line for line in lines if int(line.split(",")[0]) not in ids]
+
     with open(versions, "w") as f:
         for line in lines:
             f.write(line)

dzgui/api/pefile.py

@@ -1,4 +1,3 @@
-import json
 import struct
 
 from dataclasses import dataclass
@@ -12,9 +11,8 @@ from dzgui.const.constants import (
     APPNAME_DAYZ,
     APPNAME_DAYZ_EXP,
     DAYZ_BINARY,
-    LIBRARYFOLDERS_PATH,
 )
-from dzgui.api.steam import vdf2json
+from dzgui.api.steam import get_app_path
 
 # https://learn.microsoft.com/en-us/windows/win32/debug/pe-format
 endian = "<"
@@ -257,25 +255,6 @@ class PeFileError(Exception):
 
     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) -> FileVersion:
     # https://learn.microsoft.com/en-us/windows/win32/api/verrsrc/ns-verrsrc-vs_fixedfileinfo
     minor = struct.unpack("<L", data.read(4))[0] >> 16 & 0xFFFF
@@ -419,43 +398,16 @@ def get_pefile_path(steam_path: Path, appid: int) -> Path:
     name = identifier[appid]
     binary = DAYZ_BINARY
 
-    app_path = get_app_path(steam_path / LIBRARYFOLDERS_PATH, appid)
+    app_path = get_app_path(steam_path, appid)
     pe_path = app_path / f"steamapps/common/{name}/{binary}"
     return pe_path
 
 
-def get_app_path(folders_path: Path, appid: int) -> Path:
-    app_path = None
-
-    try:
-        j = json.loads(vdf2json(folders_path))
-    except Exception:
-        raise VDFLoadError("Failed to parse libraryfolders")
-
-    for obj in j["libraryfolders"]:
-        if str(appid) in j["libraryfolders"][obj]["apps"]:
-            app_path = j["libraryfolders"][obj]["path"]
-            if Path(app_path).exists():
-                break
-
-    if app_path is None:
-        raise AppNotInstalledError(
-            f"Failed to find a libraryfolder for the appid {appid}"
-        )
-    if Path(app_path).exists() is False:
-        raise AppMovedError(
-            f"The location '{app_path}' pointed to by '{appid}' no longer exists and may have been changed on the disk."
-        )
-
-    return Path(app_path)
-
-
 def get_pretty_version(steam_path: Path, appid: int) -> str | None:
     try:
         pe_file_path = get_pefile_path(steam_path, appid)
         vers = get_dayz_version(pe_file_path)
         dayz_version = dayz_version_to_str(vers)
         return dayz_version
-    except Exception as e:
-        print(e)
+    except Exception:
         return None

dzgui/api/probe.py

@@ -41,21 +41,6 @@ def test_ipdb() -> bool:
         return False
 
 
-def test_bm_api(key: str) -> bool:
-    payload: dict[str, str] = {
-        "filter[game]": "dayz",
-    }
-    hdr = {"Authorization": "Bearer " + key}
-    try:
-        res = requests.get(
-            endpoints.BM_SERVERS, params=payload, headers=hdr, timeout=REQUEST_TIMEOUT
-        )
-        return is_remote_up(res)
-    except Exception as e:
-        logger.critical(e)
-        return False
-
-
 def is_remote_up(res: "Response") -> bool:
     if res.status_code == 200:
         return True

dzgui/api/servers.py

@@ -11,9 +11,9 @@ import threading
 from dataclasses import dataclass
 from typing import Any, Optional, TYPE_CHECKING, Union
 
-from dzgui.api.bm import map_id_to_record
 from dzgui.const.constants import APP_NAME, REQUEST_TIMEOUT
 from dzgui.const.endpoints import STEAM_SERVERS
+from dzgui.util.format import format_exception
 from dzgui.util import strings
 
 import a2s
@@ -61,6 +61,8 @@ class Details:
 
 @dataclass(slots=True)
 class Record:
+    # TODO: investigate whether this enum is still being used;
+    # can this be frozen?
     """
     The gameport field is manipulated by the RowType.CONN_BY_IP method
     """
@@ -106,7 +108,7 @@ class A2SInfo:
 
 def get_netmask() -> str:
     hostname = os.uname()[1]
-    i = socket.gethostbyname(hostname)
+    i = socket.gethostbyname(f"{hostname}.local")
     netmask = i.rsplit(".", 1)[0]
     return netmask
 
@@ -270,8 +272,9 @@ def source_info_to_dict(ip: str, qport: int, info: "SourceInfo") -> dict[str, An
         res["ping"] = ping
         return res
     except Exception as e:
-        # TODO: generalized function
-        logger.critical(f"{type(e).__name__}: {e} ({ip}:{qport})")
+        msg = format_exception(e)
+        msg += f" ({ip}:{qport})"
+        logger.critical(msg)
         raise e
 
 
@@ -285,13 +288,14 @@ def query_direct(ip: str, qport: int, timeout: float = 3.0) -> dict[str, Any] |
 
 
 def get_details(record: Record) -> Details:
+    # TODO: consolidate try/except statements
     ip = record.ip
     qport = record.qport
     default_str = strings.none_provided
 
     try:
         info = a2s.info((ip, qport))
-    except TimeoutError:
+    except (TimeoutError, a2s.exceptions.BrokenMessageError):
         return Details(None, default_str, False)
     try:
         rules = dayzquery.dayz_rules((ip, qport))
@@ -342,10 +346,15 @@ def get_details(record: Record) -> Details:
 
     try:
         dlc = rules.dlc_flags
-        if dlc == 0:
-            dlc = strings.none
-        if dlc == 2:
-            dlc = strings.dlc_frostline
+        match dlc:
+            case 0:
+                dlc = strings.dlc_none
+            case 2:
+                dlc = strings.dlc_frostline
+            case 3:
+                dlc = strings.dlc_badlands
+            case _:
+                dlc = strings.unspecified
     except AttributeError:
         dlc = strings.unspecified
 
@@ -472,15 +481,6 @@ def query_by_ip(addr: str) -> A2SInfo:
         return A2SInfo(Record("0", 0, 0), None)
     return query_by_record(record, update_gameport=True)
 
-def query_by_id(server_id: int, key: str) -> A2SInfo:
-    """
-    Used with numeric Battlemetrics IDs
-    """
-    record = map_id_to_record(key, server_id)
-    if record is None:
-        return A2SInfo(Record("0", 0, 0), None)
-    return query_by_record(record)
-
 
 def query_by_record(record: Record, update_gameport: bool = False) -> A2SInfo:
     try:
@@ -508,6 +508,10 @@ def fqip_to_record(addr: str) -> Optional[Record]:
     return Record(r[0], int(r[1]), int(r[2]))
 
 
+def record_to_fqip(record: Record) -> str:
+    return f"{record.ip}:{record.gameport}:{record.qport}"
+
+
 def response_to_fqip(res: dict) -> str:
     ip = res["addr"].split(":")[0]
     gameport = res["gameport"]

dzgui/api/shortcuts.py

@@ -0,0 +1,197 @@
+import binascii
+import ctypes
+import logging
+import shutil
+import vdf  # type: ignore
+
+from dataclasses import dataclass
+from importlib import resources
+from pathlib import Path
+from typing import Any
+
+from dzgui.api.steam import find_user_id_32
+from dzgui.const.constants import APP_NAME, APP_NAME_LOWER, IMAGES_PATH
+from dzgui.util.dirs import copy_dzgui_to_xdg_data
+from dzgui.util.strings import unknown
+
+logger = logging.getLogger(APP_NAME)
+
+
+@dataclass(slots=True, frozen=True)
+class ShortcutMetadata:
+    appname: str
+    appid: int
+    exe_path: str
+    start_dir: str
+    icon: str
+
+
+class Shortcuts:
+    def __init__(self, steam_path: Path) -> None:
+        self.user_config_path: Path
+        self.shortcuts_path = self.find_shortcuts_path(steam_path)
+        self._load_shortcuts(self.shortcuts_path)
+
+    @classmethod
+    def gen_bpid(cls, uid: str) -> int:
+        u = uid.encode()
+        encoded = binascii.crc32(u)
+        return encoded | 0x80000000
+
+    @classmethod
+    def gen_signed_appid(cls, appid: int) -> int:
+        return ctypes.c_int(appid).value
+
+    @classmethod
+    def gen_exe_uid(cls, appname: str, exe: Path) -> str:
+        wrapped_exe = f'"{exe}"'
+        return appname + wrapped_exe
+
+    def find_appname_by_unsigned_id(self, appid: int) -> str:
+        # NOTE: bitmask signed int back to 32-bit CRC
+        # varying client versions treat case sensitivity differently
+        try:
+            for key in self.shortcuts["shortcuts"].keys():
+                if self.shortcuts["shortcuts"][key]["appid"] & 0xFFFFFFFF == appid:
+                    try:
+                        return str(self.shortcuts["shortcuts"][key]["appname"])
+                    except Exception as e:
+                        logger.debug(e)
+                    try:
+                        return str(self.shortcuts["shortcuts"][key]["AppName"])
+                    except Exception as e:
+                        logger.debug(e)
+                    return unknown
+        except Exception as e:
+            logger.debug(e)
+        return unknown
+
+    def get_shortcuts(self) -> Any:
+        return self.shortcuts
+
+    def _load_shortcuts(self, path: Path) -> None:
+        try:
+            with open(path, "rb") as f:
+                shortcuts = vdf.binary_load(f)
+            self.shortcuts = shortcuts
+            logger.debug("Loaded shortcuts file")
+        except Exception as e:
+            logger.critical(e)
+            raise e
+
+    def find_shortcuts_path(self, steam_path: Path) -> Path:
+        uid = find_user_id_32(steam_path)
+        self.user_config_path = steam_path.joinpath(f"userdata/{uid}/config")
+        return self.user_config_path.joinpath("shortcuts.vdf")
+
+    def add_shortcut(
+        self, appname: str, start_dir: Path, exe_path: Path, icon: Path
+    ) -> None:
+        uid = self.gen_exe_uid(appname, exe_path)
+        self.bpid = self.gen_bpid(uid)
+        self.signed_appid = self.gen_signed_appid(self.bpid)
+
+        meta = ShortcutMetadata(
+            appname, self.signed_appid, str(exe_path), str(start_dir), str(icon)
+        )
+        entry = self._create_entry(meta)
+        self._insert_at_last_index(entry)
+
+    def add_grid_images(self, images: Path) -> None:
+        """
+        {BPID}_hero.png: hero (splash)
+        {BPID}p.ping: portrait boxart in library
+        {BPID}_logo.png: logo overlay on top of hero
+        {BPID}.png: legacy Big Picture/landscape image
+        """
+
+        grid_path = self.user_config_path.joinpath("grid")
+        for img in ("_hero", "p", "_logo"):
+            filename = str(self.bpid) + img
+            dest = grid_path.joinpath(filename).with_suffix(".png")
+            b = images.joinpath(img).with_suffix(".png").read_bytes()
+            dest.write_bytes(b)
+
+        # NOTE: legacy Big Picture header
+        b = images.joinpath("_hero.png").read_bytes()
+        dest = grid_path.joinpath(str(self.bpid)).with_suffix(".png")
+        dest.write_bytes(b)
+
+    def _insert_at_last_index(self, entry: dict[str, Any]) -> None:
+        try:
+            last = list(self.shortcuts["shortcuts"].keys())[-1]
+            n = int(last) + 1
+        except Exception:
+            n = 0
+        self.shortcuts["shortcuts"][str(n)] = entry
+
+    @classmethod
+    def _create_entry(cls, meta: ShortcutMetadata) -> dict[str, Any]:
+        """
+        https://developer.valvesoftware.com/wiki/Add_Non-Steam_Game
+        https://developer.valvesoftware.com/wiki/Steam_Library_Shortcuts
+
+        Key case is not internally consistent and varies between client versions
+        Most keys use Pascal case, but some do not
+
+        appid: signed int CRC
+        Exe: absolute path to the executable, must be wrapped in literal quotes
+        StartDir: directory the executable starts in, generally the parent
+        """
+
+        NEW_ENTRY: dict[str, Any] = {}
+        NEW_ENTRY["appid"] = meta.appid
+        NEW_ENTRY["AppName"] = meta.appname
+        NEW_ENTRY["Exe"] = f'"{meta.exe_path}"'
+        NEW_ENTRY["StartDir"] = f"{meta.start_dir}"
+        NEW_ENTRY["icon"] = meta.icon
+        NEW_ENTRY["ShortcutPath"] = ""
+        NEW_ENTRY["LaunchOptions"] = ""
+        NEW_ENTRY["IsHidden"] = 0
+        NEW_ENTRY["AllowDesktopConfig"] = 1
+        NEW_ENTRY["AllowOverlay"] = 1
+        NEW_ENTRY["OpenVR"] = 0
+        NEW_ENTRY["Devkit"] = 0
+        NEW_ENTRY["DevkitGameID"] = ""
+        NEW_ENTRY["DevkitOverrideAppID"] = 0
+        NEW_ENTRY["LastPlayTime"] = 0
+        NEW_ENTRY["FlatpakAppID"] = ""
+        NEW_ENTRY["sortas"] = ""
+        NEW_ENTRY["tags"] = {}
+        return NEW_ENTRY
+
+    def delete_shortcut(self, start_path: Path) -> None:
+        shortcuts = self.shortcuts["shortcuts"]
+        for s in shortcuts:
+            if shortcuts[s]["StartDir"] == str(start_path):
+                del shortcuts[s]
+                break
+        self.save_shortcuts()
+
+    def save_shortcuts(self) -> None:
+        try:
+            backup = self.shortcuts_path.with_suffix(".vdf.bak")
+            shutil.copy(self.shortcuts_path, backup)
+            with open(self.shortcuts_path, "wb") as f:
+                vdf.binary_dump(self.shortcuts, f)
+        except Exception as e:
+            logger.critical(e)
+
+
+def add_steam_shortcut(steam_path: Path, exe_path: Path) -> None:
+    try:
+        start_dir = exe_path.parent
+
+        traversable = resources.files(APP_NAME_LOWER).joinpath(IMAGES_PATH)
+        images = Path(str(traversable))
+        icon = images.joinpath("icon.png")
+
+        shortcuts = Shortcuts(Path(steam_path))
+        shortcuts.add_shortcut(APP_NAME, start_dir, exe_path, icon)
+        shortcuts.save_shortcuts()
+        shortcuts.add_grid_images(images)
+
+        copy_dzgui_to_xdg_data(exe_path)
+        logger.debug("Finished creating Steam shortcut")
+    except Exception as e:
+        logger.critical(e)

dzgui/api/steam.py

@@ -1,29 +1,60 @@
-import json
 import logging
 import os
+import psutil
 import requests
 import subprocess
+import vdf  # type: ignore
 
-from shlex import shlex
 from pathlib import Path
+from typing import Any, Union
+from warnings import deprecated
 
+from dzgui.api.acf import ACF
 from dzgui.init.prereqs import has_steam_client
 from dzgui.const.constants import (
+    APPID_DAYZ,
+    APPID_DAYZ_EXP,
     APP_NAME,
+    DAYZ_BINARY,
+    DAYZ_LAUNCHER,
     DEBIAN_STEAM_PATH,
     DEFAULT_STEAM_PATH,
     FLATPAK_STEAM_PATH,
+    LIBRARYFOLDERS_PATH,
     UBUNTU_STEAM_PATH,
+    REQUEST_TIMEOUT,
     VDF_PATH,
 )
-from dzgui.const.endpoints import STEAM_PUBLISHED_FILES
+from dzgui.const.endpoints import (
+    APP_DETAILS,
+    SUB_ENDPOINT,
+    STEAM_PUBLISHED_FILES,
+    UNSUB_ENDPOINT,
+)
 from dzgui.strings import wizard
 from dzgui.util.bash import concat_bash_args
 
-
 logger = logging.getLogger(APP_NAME)
 
 
+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 get_steam_paths() -> list[tuple[Path, str]]:
     paths = []
     if has_steam_client():
@@ -53,7 +84,8 @@ def get_steam_paths() -> list[tuple[Path, str]]:
 
 
 def concat_mods(mods: list[str]) -> str:
-    from dzgui.util.symlink import _hash
+    # TODO: circular import workaround
+    from dzgui.api.mods import _hash
 
     hashes = []
     for mod in mods:
@@ -68,31 +100,21 @@ def get_local_signatures(version_file: Path) -> dict[str, int]:
     for line in lines:
         data = line.split(",")
         _id = data[0]
-        _hash = int(data[1])
-        hashes[_id] = _hash
+        mod_hash = int(data[1])
+        hashes[_id] = mod_hash
     return hashes
 
 
-def enqueue_mod(mod: str, appid: int) -> None:
-    args = [
-        "steam",
-        f"steam://url/CommunityFilePage/{mod}+workshop_download_item",
-        str(appid),
-        mod,
-    ]
-    subprocess.Popen(["/usr/bin/env", "bash", *args])
-
-
 def get_needs_update(
     version_file: Path, remote_hashes: list[tuple[str, str, int, int]]
 ) -> list[tuple[str, str, int, int]]:
-    local_hashes = get_local_signatures(version_file)
+    local_stamps = get_local_signatures(version_file)
     needs_update: list[tuple[str, str, int, int]] = []
-    for title, _id, _hash, size in remote_hashes:
-        if _id not in local_hashes:
-            needs_update.append((title, _id, _hash, size))
-        elif _hash != local_hashes[_id]:
-            needs_update.append((title, _id, _hash, size))
+    for title, _id, stamp, size in remote_hashes:
+        if _id not in local_stamps:
+            needs_update.append((title, _id, stamp, size))
+        elif stamp != local_stamps[_id]:
+            needs_update.append((title, _id, stamp, size))
         else:
             continue
     return needs_update
@@ -118,6 +140,9 @@ def get_remote_signatures(mods: list[str]) -> list[tuple[str, str, int, int]]:
     j = r.json()
     rows = j["response"]["publishedfiledetails"]
     for row in rows:
+        # NOTE: not a valid published file
+        if row["result"] == 9:
+            continue
         title = str(row["title"])
         _id = str(row["publishedfileid"])
         time = int(row["time_updated"])
@@ -126,6 +151,25 @@ def get_remote_signatures(mods: list[str]) -> list[tuple[str, str, int, int]]:
     return hashes
 
 
+def connect_debug(
+    client: str, addr: str, appid: int, name: str, mods: list[str]
+) -> str:
+    concat = concat_mods(mods)
+    client_args = concat_bash_args(client)
+    params = [
+        "-applaunch",
+        str(appid),
+        f"-connect={addr}",
+        "-nolauncher",
+        "-nosplash",
+        "-skipintro",
+        f"-name={name}",
+        f"-mod={concat}",
+    ]
+    client_args.extend(params)
+    return " ".join(client_args)
+
+
 # TODO: set config to name=user, use official server and no mods,
 # ensure that formatted string is identical to fixture with same hash
 def connect(client: str, addr: str, appid: int, name: str, mods: list[str]) -> int:
@@ -146,69 +190,266 @@ def connect(client: str, addr: str, appid: int, name: str, mods: list[str]) -> i
     return proc.returncode
 
 
+def load_to_menu(client: str, appid: int, name: str, mods: list[str]) -> int:
+    """Loads to the menu screen with the selected mods; used for AFK/pre-joining"""
+    concat = concat_mods(mods)
+    client_args = concat_bash_args(client)
+    params = [
+        "-applaunch",
+        str(appid),
+        "-nolauncher",
+        "-nosplash",
+        "-skipintro",
+        f"-name={name}",
+        f"-mod={concat}",
+    ]
+    proc = subprocess.run([*client_args, *params])
+    return proc.returncode
+
+
+def launch_offline(
+    client: str, appid: int, name: str, mods: list[str], mission: str
+) -> int:
+    """Launch offline with specific mods/missions"""
+    symlinks = ";".join(mods)
+    client_args = concat_bash_args(client)
+    params = [
+        "-applaunch",
+        str(appid),
+        "-nolauncher",
+        "-nosplash",
+        "-skipintro",
+        f"-name={name}",
+        f"-mod={symlinks}",
+    ]
+    if len(mission) > 0:
+        arg = f"-mission={mission}"
+        params.append(arg)
+    proc = subprocess.run([*client_args, *params])
+    return proc.returncode
+
+
+def find_loginusers(path: Path) -> Path:
+    return path / "config" / "loginusers.vdf"
+
+
 def find_user_id(path: Path) -> str | None:
-    resolved_path = path / "config" / "loginusers.vdf"
+    resolved_path = find_loginusers(path)
     try:
-        vdf = vdf2json(resolved_path)
-        j = json.loads(vdf)
-        for user in j["users"]:
-            if j["users"][user]["MostRecent"] == "1":
-                return str(user)
-        return None
+        with open(resolved_path, "r") as f:
+            v = vdf.load(f)
+            users = v["users"]
+            # NOTE: beta client: /package/beta
+            last_user = str(next(iter(users)))
+            if len(users) == 1:
+                return last_user
+            last_stamp = int(users[last_user]["Timestamp"])
+            for user in users:
+                stamp = int(users[user]["Timestamp"])
+                if stamp > last_stamp:
+                    last_stamp = stamp
+                    last_user = user
+            return last_user
     except Exception as e:
-        logger.warn(e)
+        logger.debug(e)
         return None
 
 
-def vdf2json(path: Path) -> str:
-    def _istr(indent: int, string: str) -> str:
-        return (indent * "  ") + string
-
-    jbuf = "{\n"
-    indent = 1
-
-    with open(path, "r") as f:
-        st = f.read()
-    lex = shlex(st)
-
-    while True:
-        tok = lex.get_token()
-        if not tok:
-            return jbuf + "}\n"
-        if tok == "}":
-            indent -= 1
-            jbuf += _istr(indent, "}")
-            ntok = lex.get_token()
-            if ntok is not None:
-                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:
-                if ntok is not None:
-                    jbuf += _istr(indent, tok + ": " + ntok)
-                    ntok = lex.get_token()
-                    if ntok is not None:
-                        lex.push_token(ntok)
-                    if ntok != "}":
-                        jbuf += ","
-                    jbuf += "\n"
+def find_user_id_32(path: Path) -> int:
+    uid = find_user_id(path)
+    if uid is None:
+        raise ValueError("Failed to parse a valid Steam32 ID")
+    return int(uid) & 0xFFFFFFFF
 
 
-def gen_shortcut() -> None:
-    # TODO:
-    """
-    during setup, prompt user to select matching user id from loginusers
-    show user account name, select outer steam id
-    steam/userdata/<steamid_32>/config/shortcuts.vdf
-    """
-    # STEAMID_MAGIC = 76561197960265728
-    # STEAMID_64 - STEAMID_MAGIC = STEAMID32
-    # or get right-most 32 bits
-    # STEAMID_64 & 0xFFFFFFFF
-    pass
+def update_workshop(key: str, mod: int, endpoint: str) -> None:
+    payload: dict[str, Union[int, str]] = {
+        "publishedfileid": mod,
+        "appid": APPID_DAYZ,
+        "key": key,
+        "list_type": 1,
+        "notify_client": 1,
+    }
+    try:
+        res = requests.post(endpoint, params=payload, timeout=REQUEST_TIMEOUT)
+        res.raise_for_status()
+    except Exception as e:
+        logger.critical(e)
+
+
+def subscribe(key: str, mod: int) -> None:
+    update_workshop(key, mod, SUB_ENDPOINT)
+
+
+def unsubscribe(key: str, mod: int) -> None:
+    update_workshop(key, mod, UNSUB_ENDPOINT)
+
+
+@deprecated("Use subscribe()")
+def enqueue_mod(client: str, mod: str, appid: int) -> None:
+    client_args = concat_bash_args(client)
+    subprocess.Popen([*client_args, "+workshop_download_item", str(appid), mod])
+
+
+@deprecated("Cf. https://github.com/ValveSoftware/steam-for-linux/issues/9672")
+def get_registry() -> Any | None:
+    home = os.getenv("HOME")
+    try:
+        with open(f"{home}/.steam/registry.vdf") as f:
+            registry = vdf.load(f)
+        return registry
+    except Exception as e:
+        logger.critical(e)
+        return None
+
+
+def _is_dayz_running() -> bool:
+    registry = get_registry()
+    if registry is None:
+        return False
+    apps = registry["Registry"]["HKCU"]["Software"]["Valve"]["Steam"]["apps"].items()
+    for app in apps:
+        k, v = app
+        if k in (APPID_DAYZ, APPID_DAYZ_EXP):
+            try:
+                state = v["Running"]
+                # NOTE: 0 denotes False
+                return bool(int(state))
+            except Exception as e:
+                logger.critical(e)
+                return False
+    return False
+
+
+def _get_running_app() -> int | None:
+    registry = get_registry()
+    if registry is None:
+        return None
+    try:
+        return int(
+            registry["Registry"]["HKCU"]["Software"]["Valve"]["Steam"]["RunningAppID"]
+        )
+    except Exception:
+        return None
+
+
+def get_running_app() -> int | None:
+    PROC_NAME = "steam"
+    SUBPROC_NAME = "reaper"
+    FLAG = "AppId"
+    # NOTE: may cause conflicts if multiple apps are running
+    try:
+        for proc in psutil.process_iter():
+            if proc.name() == PROC_NAME:
+                subprocs = proc.children()
+                filtered = (proc for proc in subprocs if proc.name() == SUBPROC_NAME)
+                try:
+                    proc = next(filtered)
+                except StopIteration:
+                    return None
+                args = proc.cmdline()
+                appid = (row for row in args if FLAG in row)
+                try:
+                    return int(next(appid).split("=")[1])
+                except StopIteration:
+                    return None
+    except Exception as e:
+        logger.debug(e)
+    return None
+
+
+def get_app_allows_downloads(path: Path, appid: int) -> bool:
+    try:
+        root_path = get_app_path(path, appid)
+        acf = root_path.joinpath(f"steamapps/appmanifest_{appid}.acf")
+        flag = ACF(acf).get_allows_downloads()
+    except AppNotInstalledError:
+        flag = 0
+    match flag:
+        # NOTE: adheres to global client setting
+        case 0:
+            return get_client_allows_downloads(path)
+        # NOTE: always allow
+        case 1:
+            return True
+        # NOTE: never allow
+        case 2:
+            return False
+        # NOTE: no other known values at this time, fallback (assume permits)
+        case _:
+            return True
+
+
+def get_config(path: Path) -> Path:
+    return path.joinpath("config/config.vdf")
+
+
+def get_client_allows_downloads(path: Path) -> bool:
+    config = get_config(path)
+    try:
+        with open(config) as f:
+            settings = vdf.load(f)
+            # NOTE: "1" denotes "allow"
+            allow = bool(
+                int(
+                    settings["InstallConfigStore"]["Software"]["Valve"]["Steam"][
+                        "AllowDownloadsDuringGameplay"
+                    ]
+                )
+            )
+            return allow
+    except Exception as e:
+        logger.critical(e)
+        return True
+
+
+def is_dayz_running() -> bool:
+    """Subprocesses spawned from Steam will not show up in regular process tree"""
+    procs = []
+    substring = [DAYZ_BINARY, DAYZ_LAUNCHER]
+    for proc in psutil.process_iter():
+        try:
+            procs.append(proc.cmdline())
+        except Exception as e:
+            logger.warning(e)
+            continue
+    return any(s in item for sublist in procs for item in sublist for s in substring)
+
+
+def get_app_path(folders_path: Path, appid: int) -> Path:
+    app_path = None
+
+    try:
+        with open(folders_path / LIBRARYFOLDERS_PATH) as f:
+            folders = vdf.load(f)
+    except Exception:
+        raise VDFLoadError("Failed to parse libraryfolders")
+
+    for obj in folders["libraryfolders"]:
+        if str(appid) in folders["libraryfolders"][obj]["apps"]:
+            app_path = folders["libraryfolders"][obj]["path"]
+            if Path(app_path).exists():
+                break
+
+    if app_path is None:
+        raise AppNotInstalledError(
+            f"Failed to find a libraryfolder for the appid {appid}"
+        )
+    if Path(app_path).exists() is False:
+        raise AppMovedError(
+            f"The location '{app_path}' pointed to by '{appid}' no longer exists and may have been changed on the disk."
+        )
+
+    return Path(app_path)
+
+
+def get_app_name(appid: int) -> str | None:
+    payload = {"appids": [appid]}
+    res = requests.get(APP_DETAILS, params=payload)
+    if res.status_code != 200:
+        return None
+    try:
+        return str(res.json()[str(appid)]["data"]["name"])
+    except Exception as e:
+        logger.debug(e)
+        return None

dzgui/app_init.py

@@ -0,0 +1,158 @@
+import logging
+import os
+import shutil
+from typing import TYPE_CHECKING
+
+
+from dzgui.const.constants import APP_NAME
+from dzgui.const.enum import Preferences
+from dzgui.config.query import lookup
+from dzgui.config.userprefs import UserPrefs
+from dzgui.config.xdg import get_xdg_paths, parse_filepaths
+from dzgui.init.migrate import (
+    has_new_config,
+    copy_state_files,
+    migrate_cols_file,
+)
+from dzgui.init.flock import lock_acquire
+from dzgui.init.prereqs import has_steam_client
+from dzgui.strings import boot
+
+from dzgui.util.deck import is_steam_deck, is_game_mode
+from dzgui.util.dirs import make_parents
+from dzgui.util.localize import set_locale
+from dzgui.util.map_count import test_map_count
+from dzgui.util.redact import RedactionFilter, REDACTION_PATTERNS
+from dzgui.util.strings import init
+
+from dzgui.views.base import App
+from dzgui.views.dialogs.boot import BootWindow
+from dzgui.views.dialogs.early_alert import EarlyAlertDialog
+from dzgui.views.dialogs.wizard import SetupWizard
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+logger = logging.getLogger(APP_NAME)
+
+# TODO: profile load time
+
+
+def setup_logger(log_path: "Path") -> None:
+    # TODO: put in consts?
+    _format = (
+        "%(asctime)s␞%(levelname)s␞%(filename)s::%(funcName)s::%(lineno)s␞%(message)s"
+    )
+
+    fh = logging.FileHandler(log_path)
+    formatter = logging.Formatter(_format)
+    fh.setFormatter(formatter)
+    fh.setLevel(logging.DEBUG)
+
+    _filter = RedactionFilter(patterns=REDACTION_PATTERNS)
+    fh.addFilter(_filter)
+
+    logger.setLevel(logging.DEBUG)
+    logger.addHandler(fh)
+
+
+def copy_bare_configs(config: "Path", resolution: "Path") -> tuple[bool, bool]:
+    # NOTE: temporary workaround for #375
+    conf = "config.json"
+    state = [
+        "dzg.history",
+        "dzg.versions",
+        "dzg.res.json",
+        "dzg.filters.json",
+        "dzg.columns.json",
+        "dzg.notes.json",
+        "ips.csv",
+        ".month",
+    ]
+    config_changed = False
+    state_changed = False
+    if config.parent.exists() is False:
+        new_file = config
+        old_file = config.parent.parent / conf
+        if old_file.is_file():
+            try:
+                make_parents(new_file)
+                shutil.copy(old_file, new_file)
+                config_changed = True
+            except Exception as e:
+                logger.critical(e)
+    if resolution.parent.exists() is False:
+        state_path = resolution.parent
+        for state_file in state:
+            old_file = state_path.parent / state_file
+            if old_file.is_file():
+                try:
+                    new_file = state_path / state_file
+                    make_parents(new_file)
+                    shutil.copy(old_file, new_file)
+                    state_changed = True
+                except Exception as e:
+                    logger.critical(e)
+    return (config_changed, state_changed)
+
+
+def load_gui(version: str, is_debug: bool) -> None:
+    lock = lock_acquire()  # noqa
+
+    set_locale()
+    # NOTE: consider aborting this check if steam deck
+    xdg_paths = get_xdg_paths()
+    XDG = parse_filepaths(xdg_paths)
+
+    copy_bare_configs(XDG.config, XDG.resolution)
+
+    if XDG.resolution.parent.is_dir() is False:
+        make_parents(XDG.resolution)
+
+    if XDG.debug.is_file() is False:
+        make_parents(XDG.debug)
+
+    _is_steam_deck = is_steam_deck()
+    _is_game_mode = is_game_mode() if _is_steam_deck else False
+    if _is_game_mode:
+        # NOTE: this may no longer be necessary on newer versions of SteamOS
+        del os.environ["GTK_IM_MODULE"]
+
+    if has_new_config(XDG.config) is False:
+        test_map_count()
+        migrate_cols_file(XDG.columns)
+        copy_state_files(xdg_paths["XDG_STATE_HOME"])
+        # TODO: add logging inside wizard
+        wizard = SetupWizard(_is_steam_deck, XDG)
+
+        if not wizard.is_setup_complete():
+            return
+
+    setup_logger(XDG.debug)
+    with open(XDG.debug, "w") as f:
+        f.truncate(0)
+
+    if _is_steam_deck is False:
+        # TODO: sudo escalation dialog
+        # count = get_map_count()
+        # TODO: move into module
+        if has_steam_client() is False:
+            EarlyAlertDialog(init.requires_steam)
+
+    bootwin = BootWindow(XDG, version)
+    local_coords, latest_release = bootwin.get_results()
+
+    use_miles = lookup(XDG.config, Preferences.DIST)
+    prefs = UserPrefs(
+        is_steam_deck=_is_steam_deck,
+        is_game_mode=_is_game_mode,
+        is_debug=is_debug,
+        coords=local_coords,
+        version=version,
+        paths=XDG,
+        latest_release=latest_release,
+        use_miles=use_miles,
+    )
+    print(boot.all_ok)
+    app = App(prefs)
+    app.run(None)

dzgui/config/convert.py

@@ -3,6 +3,8 @@ import shlex
 from pathlib import Path
 from typing import Any
 
+from dzgui.const.boilerplate import config_boilerplate
+
 
 """
 Convert legacy dztuirc to config.json
@@ -40,6 +42,7 @@ def rc2json(file: Path) -> str:
 
     toggles = ["fullscreen"]
     deprecated = [
+        "api_key",
         "staging_dir",
         "src_path",
         "steam_path",
@@ -64,8 +67,6 @@ def rc2json(file: Path) -> str:
                 value = str2bool(ntok)
         elif tok == "preferred_client":
             tok = "client"
-        elif tok == "api_key":
-            tok = "bm_api"
         elif tok == "ip_list":
             while True:
                 ntok = lex.get_token()
@@ -89,4 +90,8 @@ def rc2json(file: Path) -> str:
     keys["ip_list"] = ips
     keys["use_miles"] = False
     keys["start_tab"] = 0
+    # NOTE: workaround for DZGUI 6 logic (see #375)
+    for key in config_boilerplate.keys():
+        if key not in keys:
+            keys[key] = config_boilerplate[key]
     return json.dumps(keys, indent=2)

dzgui/config/freedesktop.py

@@ -1,18 +1,43 @@
+import stat
 import textwrap
+
 from pathlib import Path
 
+from dzgui.util.dirs import copy_dzgui_to_xdg_data, find_icon_resource, make_parents
+
+
+def get_share_path(exe_path: Path) -> Path:
+    return exe_path.parent.parent
+
+
+def write_desktop_file(exe_path: Path) -> Path:
+    icon = find_icon_resource()
 
-def write_desktop_file(share_path: Path) -> None:
     template = f"""\
     [Desktop Entry]
     Version=1.0
     Type=Application
     Terminal=false
-    Exec={share_path}/launch.sh
+    Exec={exe_path}
     Name=DZGUI
-    Comment=dzgui
-    Icon={share_path}/dzgui
+    Comment=DayZ server browser and mod manager
+    Icon={icon}
     Categories=Game"""
 
-    file = share_path / "dzgui.desktop"
-    file.write_text(textwrap.dedent(template))
+    copy_dzgui_to_xdg_data(exe_path)
+
+    share_path = get_share_path(exe_path)
+    desktop_file = share_path.joinpath("applications/dzgui.desktop")
+    make_parents(desktop_file)
+    desktop_file.write_text(textwrap.dedent(template))
+    desktop_file.chmod(desktop_file.stat().st_mode | stat.S_IEXEC)
+    return desktop_file
+
+
+def write_desktop_shortcut(desktop_file: Path) -> None:
+    # NOTE: necessarily depends on the above (UI blocks creation without XDG entry first)
+    link = Path.home().joinpath("Desktop/dzgui.desktop")
+    make_parents(link)
+    if link.exists():
+        link.unlink()
+    link.symlink_to(desktop_file)

dzgui/config/ipdb.py

@@ -23,40 +23,36 @@ def find_download_url(url: str) -> str | None:
 
 
 def get_ipdb(ips_path: Path) -> None:
-    url = find_download_url(DB_IP)
-    if url is None:
-        return
-
-    date = find_date(url)
-    month_file = ips_path.parent / ".month"
-    if ips_path.exists() and month_file.exists():
-        old_date = month_file.read_text().rstrip("\n")
-        if old_date == date:
-            logger.info(f"IP DB date matches: {date}")
+    try:
+        url = find_download_url(DB_IP)
+        if url is None:
             return
 
-    # TODO: log additional output
-    logger.info(f"Fetching IPDB for {date} from {url}")
-    try:
+        date = find_date(url)
+        month_file = ips_path.parent / ".month"
+        if ips_path.exists() and month_file.exists():
+            old_date = month_file.read_text().rstrip("\n")
+            if old_date == date:
+                logger.info(f"IP DB date matches: {date}")
+                return
+
+        # TODO: log additional output
+        logger.info(f"Fetching IPDB for {date} from {url}")
         tmp = serialize(url)
-    except Exception as e:
-        logger.critical(e)
-        return
+        logger.info(f"Extracting {tmp}")
+        unzip(tmp, ips_path)
 
-    logger.info(f"Extracting {tmp}")
-    unzip(tmp, ips_path)
-
-    logger.info("Stripping IPv6 records")
-    try:
+        logger.info("Stripping IPv6 records")
         strip_ipv6(ips_path)
+
+        with open(month_file, "w") as f:
+            f.write(date)
+        logger.info(f"Wrote {date} to {month_file}")
     except Exception as e:
+        # NOTE: in the event of failure, geolocation calc is simply not performed
         logger.critical(e)
         return
 
-    with open(month_file, "w") as f:
-        f.write(date)
-    logger.info(f"Wrote {date} to {month_file}")
-
 
 def find_date(url: str) -> str:
     date = re.sub(r"(dbip-city-lite-)(.*)(.csv.gz)", r"\2", url)
@@ -81,19 +77,34 @@ def serialize(url: str) -> Path:
     return tmp
 
 
-# TODO: optimize this function
-# consider using grep
-# cf. grep -vE "^[a-z0-9]{4}:" | grep -v "::" > "$ip_file"
 def strip_ipv6(path: Path) -> None:
-    ips = []
-    with open(path, "r") as f:
-        s = f.read()
+    """Can be IO intensive and cause visual lag on UI frames
+    running in the main thread even when run in its own thread;
+    lines are batched into memory-manageable chunks to reduce
+    disk writes. Raw file can be 8M+ records long, so it is
+    not read into memory at once.
 
-    reg = r"^\d{1,3}\..*"
-    ips = re.findall(reg, s, re.MULTILINE)
-    assert ips[0].split(",")[0] == "0.0.0.0"
-    assert ips[-1].split(",")[0] == "224.0.0.0"
-
-    with open(path, "w") as f:
-        for ip in ips:
-            f.write(ip + "\n")
+    Relative size is reduced by ~100MB by pruning unwanted columns
+    """
+    # NOTE: "^::," is the boundary line between IPv4 and IPv6
+    # NOTE: deprecated regex matching (slower by 5s)
+    # reg = r"^\d{1,3}\..*"
+    alt_path = path.parent.joinpath("ips_stripped.csv")
+    merged = ""
+    its = 0
+    with open(path, "r") as f, open(alt_path, "w") as out:
+        for line in f:
+            els = line.split(",")
+            if "." not in els[0]:
+                break
+            final = ",".join([els[0], els[1], els[-2], els[-1]])
+            merged += final
+            its += 1
+            if its == 500:
+                out.write(merged)
+                its = 0
+                merged = ""
+        if its > 0:
+            out.write(merged)
+    path.unlink()
+    alt_path.rename(path)

dzgui/config/xdg.py

@@ -17,6 +17,8 @@ class Xdg:
     system: Path
     debug: Path
     ips: Path
+    filters: Path
+    shortcut: Path
 
 
 def is_writeable(path_str: str) -> bool:
@@ -28,9 +30,9 @@ def is_writeable(path_str: str) -> bool:
     if not path.exists():
         try:
             path.mkdir(parents=True)
+            path.unlink()
         except OSError:
             return False
-        path.unlink()
         return True
 
     try:
@@ -54,20 +56,19 @@ def get_xdg_paths() -> dict:
 
     resolved_paths = {}
     for path in xdg_paths:
-        rp = os.environ.get(path)
-        if rp is not None and is_writeable(rp):
-            resolved_paths[path] = Path(rp)
+        real_path = os.environ.get(path)
+        if real_path is not None and is_writeable(real_path):
+            new_path = Path(real_path)
         else:
-            resolved_paths[path] = xdg_paths[path] / APP_NAME_LOWER
+            new_path = xdg_paths[path]
+        resolved_paths[path] = new_path / APP_NAME_LOWER
     return resolved_paths
 
 
 def parse_filepaths(xdg: dict) -> Xdg:
-    # cache = xdg["XDG_CACHE_HOME"]
-    # data = xdg["XDG_DATA_HOME"]
-
     config = xdg["XDG_CONFIG_HOME"]
     state = xdg["XDG_STATE_HOME"]
+    share = xdg["XDG_DATA_HOME"]
 
     config = config / "config.json"
 
@@ -80,6 +81,9 @@ def parse_filepaths(xdg: dict) -> Xdg:
     history = state / "dzg.history"
     versions = state / "dzg.versions"
     ips = state / "ips.csv"
+    filters = state / "dzg.filters.json"
+
+    shortcut = share / APP_NAME_LOWER
 
     return Xdg(
         config,
@@ -91,4 +95,6 @@ def parse_filepaths(xdg: dict) -> Xdg:
         system,
         debug,
         ips,
+        filters,
+        shortcut,
     )

dzgui/const/boilerplate.py

@@ -2,7 +2,6 @@
 Generic defaults used when initializing a config file from scratch
 """
 config_boilerplate = {
-    "bm_api": "",
     "fav_server": "",
     "fav_label": "",
     "name": "",

dzgui/const/constants.py

@@ -4,12 +4,15 @@ UDP_PORT = 27016
 VM_FILE = "/proc/sys/vm/max_map_count"
 MIN_COUNT = 1048576
 
+API_RATE_LIMIT = 1
+CLIENT_RATE_LIMIT = 3
 REQUEST_TIMEOUT = 10
 
 APPNAME_DAYZ = "DayZ"
 APPNAME_DAYZ_EXP = "DayZ Exp"
 APPNAME_DAYZ_EXP_HUMAN = "DayZ Experimental"
 DAYZ_BINARY = "DayZ_x64.exe"
+DAYZ_LAUNCHER = "DayZLauncher.exe"
 
 LIBRARYFOLDERS_PATH = "steamapps/libraryfolders.vdf"
 WORKSHOP_PATH = "steamapps/workshop/content/" + str(APPID_DAYZ)
@@ -27,11 +30,20 @@ BETA_REPO = "testing"
 APP_NAME = "DZGUI"
 APP_NAME_LOWER = "dzgui"
 APP_NAME_ABBR = "dzg"
+GTK_APP_ID = "io.github.aclist.dzgui"
 
+HEX_GREEN = "#32CD32"
 HEX_RED = "#FF0000"
 HEX_ORANGE = "#FFAC1C"
 
+# FIXME: normalize icon names
+CARET_DOWN = "go-down-symbolic"
+CARET_UP = "go-up-symbolic"
 CLIPBOARD = "edit-copy-symbolic"
+CLOSE = "window-close-symbolic"
+FOLDER = "folder-symbolic"
+EDIT_DELETE = "edit-delete-symbolic"
+ERROR = "dialog-error-symbolic"
 HELP_BUBBLE = "help-about-symbolic"
 INPUT_KEYBOARD = "input-keyboard-symbolic"
 LIST_ADD = "list-add-symbolic"
@@ -40,7 +52,6 @@ SEARCH_ICON = "system-search-symbolic"
 STEAM_ICON = "steam_tray_mono"
 VIEW_CONCEAL = "view-conceal-symbolic"
 VIEW_REVEAL = "view-reveal-symbolic"
-ERROR = "dialog-error-symbolic"
 WARNING = "dialog-warning-symbolic"
 WEB_BROWSER = "web-browser-symbolic"
 
@@ -64,7 +75,9 @@ LEGACY_IPS_PATH = ".local/share/dzgui/helpers/ips.csv"
 DEBUG_LOG = f"{APP_NAME}_DEBUG.LOG"
 SYSTEM_LOG = f"{APP_NAME}_SYSTEM.LOG"
 CHANGELOG_PATH = "data/CHANGELOG.md"
-HERO_PATH = "data/images/hero.png"
+IMAGES_PATH = "data/images"
+
+HERO_PATH = "data/images/_hero.png"
 CSS_PATH = "data/app.css"
 VDF_PATH = "steamapps/libraryfolders.vdf"
 DEFAULT_STEAM_PATH = ".local/share/Steam"
@@ -76,4 +89,11 @@ LOG_FILTERS = ("CRITICAL", "WARNING", "INFO", "DEBUG")
 
 TMP_PATH = "/tmp"
 TMP_TARBALL = "/tmp/dzgui.tar.gz"
-TMP_EXE = "/tmp/dzgui"
+TMP_EXE = "/tmp/dzgui/dzgui"
+
+DAYZ_COMMUNITY_ROOT = "Missions"
+
+GIO_SETTINGS_INTERFACE = "org.gnome.desktop.interface"
+GIO_SETTINGS_PROP = "color-scheme"
+GIO_SETTINGS_KEY = "gtk-application-prefer-dark-theme"
+GIO_SETTINGS_VAL = "prefer-dark"

dzgui/const/endpoints.py

@@ -1,7 +1,12 @@
 # internal
-STEAM_PUBLISHED_FILES = "https://api.steampowered.com/ISteamRemoteStorage/GetPublishedFileDetails/v1/?format=json"
-STEAM_SERVERS = "https://api.steampowered.com/IGameServersService/GetServerList/v1/?"
-BM_SERVERS = "https://api.battlemetrics.com/servers?"
+STEAM_PUBLISHED_FILES = (
+    "https://api.steampowered.com/ISteamRemoteStorage/GetPublishedFileDetails/v1"
+)
+STEAM_SERVERS = "https://api.steampowered.com/IGameServersService/GetServerList/v1"
+SUB_ENDPOINT = "https://api.steampowered.com/IPublishedFileService/Subscribe/v1"
+UNSUB_ENDPOINT = "https://api.steampowered.com/IPublishedFileService/Unsubscribe/v1"
+APP_DETAILS = "https://store.steampowered.com/api/appdetails?"
+
 GITHUB = "https://github.com/aclist"
 GITHUB_RELEASES = "https://api.github.com/repos/aclist/dztui/releases/latest"
 CODEBERG_RELEASES = "https://codeberg.org/api/v1/repos/aclist/dzgui/releases/latest"
@@ -21,5 +26,3 @@ GITHUB_ISSUES = "https://github.com/aclist/dzgui/issues"
 FORUM = "https://old.reddit.com/r/dzgui"
 SPONSORS = "https://github.com/sponsors/aclist"
 STEAM_API_SETUP = "https://steamcommunity.com/dev/apikey"
-BM_API_SETUP = "https://www.battlemetrics.com/developers"
-BM_BROWSE = "https://www.battlemetrics.com/servers/dayz"

dzgui/const/enum.py

@@ -61,9 +61,6 @@ class Preferences(EnumWithAttrs):
     STEAM = {
         "key": "steam_api",
     }
-    BM = {
-        "key": "bm_api",
-    }
     CLIENT = {
         "key": "client",
     }
@@ -76,12 +73,6 @@ class Preferences(EnumWithAttrs):
     NAME = {
         "key": "name",
     }
-    INSTALL = {
-        "key": "auto_install",
-    }
-    DEBUG = {
-        "key": "debug",
-    }
     DEFAULT = {
         "key": "default_steam_path",
     }
@@ -94,15 +85,13 @@ class Preferences(EnumWithAttrs):
     IP_LIST = {
         "key": "ip_list",
     }
-    BRANCH = {
-        "key": "branch",
-    }
     START_TAB = {
         "key": "start_tab",
     }
 
 
 class NotebookPage(EnumWithAttrs):
+    OFFLINE = {"crumbs": strings.crumbs.offline, "statusbar": True}
     CHANGELOG = {"crumbs": strings.crumbs.changelog, "statusbar": True}
     DEVELOPERS = {"crumbs": strings.crumbs.developers, "statusbar": False}
     HELP = {"crumbs": strings.crumbs._help, "statusbar": True}
@@ -167,7 +156,7 @@ class ContextMenu(EnumWithAttrs):
     COPY_LOG_CLIPBOARD = {"label": strings.copy_log}
     COPY_SERVER_IP = {"label": strings.copy_ip}
     COPY_SERVER_NAME = {"label": strings.copy_name}
-    DELETE_MOD = {"label": strings.delete_mod}
+    UNSUB_MOD = {"label": strings.unsub_mod}
     OPEN_WORKSHOP = {"label": strings.open_workshop}
     REFRESH_PLAYERS = {"label": strings.refresh_players}
     REMOVE_HISTORY = {"label": strings.remove_history}
@@ -183,7 +172,8 @@ class ContextMenuGroup(Enum):
     """
 
     SERVER_MOD = (ContextMenu.OPEN_WORKSHOP,)
-    MOD = (ContextMenu.OPEN_WORKSHOP, ContextMenu.DELETE_MOD)
+    MOD = (ContextMenu.OPEN_WORKSHOP, ContextMenu.UNSUB_MOD)
+    MOD_OFFLINE = (None,)
     LOG = (ContextMenu.COPY_LOG_CLIPBOARD,)
     SERVER_BROWSER = (
         ContextMenu.CONNECT,
@@ -248,9 +238,9 @@ class ModButton(EnumWithAttrs):
         "label": strings.mod_panel.unhighlight_stale,
         "tooltip": strings.mod_panel.unhighlight_stale_tooltip,
     }
-    DELETE_SELECTED = {
-        "label": strings.mod_panel.delete_selected,
-        "tooltip": strings.mod_panel.delete_selected_tooltip,
+    UNSUB_SELECTED = {
+        "label": strings.mod_panel.unsub_selected,
+        "tooltip": strings.mod_panel.unsub_selected_tooltip,
     }
     SELECT_STALE = {
         "label": strings.mod_panel.select_stale,

dzgui/controllers/emitter.py

@@ -8,10 +8,13 @@ from gi.repository import Gdk, GObject  # noqa E402
 
 if TYPE_CHECKING:
     from dzgui.const.enum import NotebookPage, ServerTab
+    from dzgui.model.model_factory import FastInsertListStore
+    from dzgui.views.pages.offline import FolderHBox
 
 
 # TODO: if servers fail to load, may leave dangling widgets waiting for a signal
 
+
 class Emitter(GObject.GObject):
     def __init__(self) -> None:
         super().__init__()
@@ -78,8 +81,8 @@ class Emitter(GObject.GObject):
     def distcalc_started(self) -> None:
         pass
 
-    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=(bool,))
-    def mod_page_toggled(self, state: bool) -> None:
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=(bool, int))
+    def mod_page_toggled(self, state: bool, mods: int) -> None:
         pass
 
     @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=(bool,))
@@ -142,6 +145,10 @@ class Emitter(GObject.GObject):
     def api_change_failed(self) -> None:
         pass
 
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=())
+    def api_change_successful(self) -> None:
+        pass
+
     @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=())
     def already_saved_server(self) -> None:
         pass
@@ -150,3 +157,26 @@ class Emitter(GObject.GObject):
     def keyword_set(self, keyword: str) -> None:
         pass
 
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=())
+    def lan_page_initialized(self) -> None:
+        pass
+
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=(object, str))
+    def custom_mods_loaded(self, store: "FastInsertListStore", folder: str) -> None:
+        pass
+
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=(object,))
+    def custom_mods_unloaded(self, widget: "FolderHBox") -> None:
+        pass
+
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=(str, bool))
+    def custom_mission_loaded(self, folder: str, is_valid: bool) -> None:
+        pass
+
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=())
+    def invalid_custom_mods(self) -> None:
+        pass
+
+    @GObject.Signal(flags=GObject.SignalFlags.RUN_LAST, arg_types=())
+    def all_mods_synched(self) -> None:
+        pass

dzgui/controllers/mc.py

@@ -20,11 +20,10 @@ from dzgui.controllers.emitter import Emitter
 from dzgui.managers.config import ConfigManager
 from dzgui.managers.connection import ConnectionManager
 from dzgui.managers.contextmenu import ContextMenuManager
-from dzgui.managers.mods import ModManager
 from dzgui.managers.notes import NoteManager
 from dzgui.model.servers import ServerModelManager
 from dzgui.util.diag import write_diagnostic
-from dzgui.util.format import format_player_count
+from dzgui.util.format import format_exception, format_player_count
 from dzgui.util.open_links import open_user_workshop, open_workshop_page
 from dzgui.views.dialogs.filepicker import FilePicker
 from dzgui.views.dialogs.generic import ExceptionDialog
@@ -47,12 +46,13 @@ if TYPE_CHECKING:
     from dzgui.views.components.filter_panel import FilterPanel
     from dzgui.views.components.right_panel import RightPanel
     from dzgui.views.components.statusbar import Statusbar
+    from dzgui.views.pages.offline import OfflineLoader
     from dzgui.views.pages.options import Options
     from dzgui.views.pages.preconnect import PreConnectionAssistant
     from dzgui.views.pages.servers import ServerNotebook
     from dzgui.views.trees.tree_log import LogTreeView
     from dzgui.views.trees.tree_menu import MenuTreeView
-    from dzgui.views.trees.tree_mods import ModTreeView
+    from dzgui.views.trees.tree_mods import ModTreeView, OfflineModTreeView
     from dzgui.views.trees.tree_servers import ServerTreeView
 
 
@@ -72,6 +72,7 @@ class AppNavigation:
     filters: "FilterPanel"
     preconnect: "PreConnectionAssistant"
     options: "Options"
+    offline_loader: "OfflineLoader"
 
 
 class Controller(GObject.GObject):
@@ -84,11 +85,9 @@ class Controller(GObject.GObject):
         self.emitter = Emitter()
         self.emitter.connect("map_selection_changed", self._on_map_selection_changed)
         self.emitter.connect("check_toggled", self._on_check_toggled)
-        self.emitter.connect("servers_loaded_init", self._on_servers_loaded_init)
 
         # NOTE: suppress requests until entire UI is loaded
         self.loaded = False
-        self.pending_jobs = 1
 
         self.exit_event = threading.Event()
         self.cancel_event = threading.Event()
@@ -115,9 +114,6 @@ class Controller(GObject.GObject):
     def query_config(self, key: Preferences) -> Any:
         return self.config_man.lookup(key)
 
-    def is_auto_install(self) -> bool:
-        return bool(self.query_config(Preferences.INSTALL))
-
     def suppress_signal(
         self, owner: Any, child: Any, func_name: str, state: bool
     ) -> None:
@@ -203,7 +199,9 @@ class Controller(GObject.GObject):
                 try:
                     # TODO: where to put config file check
                     self.mediator.grid.notebook.settings.populate_settings()
-                except Exception:
+                except Exception as e:
+                    msg = format_exception(e)
+                    logger.critical(msg)
                     return
             case ButtonType.MODS:
                 self.load_mods()
@@ -219,19 +217,29 @@ class Controller(GObject.GObject):
         open_user_workshop(uid, client)
 
     def load_mods(self) -> None:
-        self.mod_man = ModManager(self)
+        self.mediator.modtreeview.load_mods()
 
     def uncolorize_mods(self) -> None:
-        self.mod_man.uncolorize_mods()
+        mod_man = self.mediator.modtreeview.get_mod_man()
+        mod_man.uncolorize_mods()
 
     def highlight_stale(self) -> None:
-        self.mod_man.highlight_stale()
+        mod_man = self.mediator.modtreeview.get_mod_man()
+        mod_man.highlight_stale()
 
     def toggle_mod_selection(self, state: bool) -> None:
-        self.mod_man.toggle_mod_selection(state)
+        mod_man = self.mediator.modtreeview.get_mod_man()
+        mod_man.toggle_mod_selection(state)
 
-    def delete_mods(self) -> None:
-        self.mod_man.delete_mods()
+    def unsub_mods(
+        self, treeview: Union["ModTreeView", "OfflineModTreeView", None] = None
+    ) -> None:
+        if treeview is None:
+            view = self.mediator.modtreeview
+        else:
+            view = treeview
+        mod_man = view.get_mod_man()
+        mod_man.unsub_mods()
 
     def get_mod_store(self) -> Gtk.TreeModel | None:
         return self.mediator.modtreeview.get_model()
@@ -255,10 +263,27 @@ class Controller(GObject.GObject):
             self.open_page(NotebookPage.LOG)
         except Exception as e:
             dialog = ExceptionDialog(self, str(e))
+            dialog.show_all()
             dialog.run()
 
     def select_colorized(self) -> None:
-        self.mod_man.select_colorized()
+        mod_man = self.mediator.modtreeview.get_mod_man()
+        mod_man.select_colorized()
+
+    def get_all_tree_filters(self) -> dict[str, dict[str, bool]]:
+        servers = self.get_servers()
+        all_filters: dict[str, dict[str, bool]] = {}
+        trees = (
+            servers.get_browser(),
+            servers.get_saved(),
+            servers.get_recent(),
+            servers.get_lan(),
+        )
+        for tree in trees:
+            enum = str(tree.get_enum())
+            filters = tree.get_filter_man().get_filters()
+            all_filters[enum] = filters
+        return all_filters
 
     def get_filter_man(self) -> "FilterManager":
         """Each ServerTreeView has an atomic FilterManager"""
@@ -272,10 +297,11 @@ class Controller(GObject.GObject):
                 write_diagnostic(self.prefs.paths.config, file)
             except Exception as e:
                 dialog = ExceptionDialog(self, str(e))
+                dialog.show_all()
                 dialog.run()
 
-    def update_api_key(self, key: Preferences, text: str) -> None:
-        self.config_man.update_api_key(key, text)
+    def update_steam_api_key(self, text: str) -> None:
+        self.config_man.update_steam_api_key(text)
 
     def set_resolution(self, window: "OuterWindow") -> None:
         self.config_man.set_resolution(window)
@@ -303,8 +329,22 @@ class Controller(GObject.GObject):
             self.emitter.emit("servers_loaded", tv.get_enum())
             return
         self.mediator.statusbar.set_by_context(tv.get_enum(), "")
+        self.mediator.filters.button_grid.block_toggles(True)
+        self.populate_filter_prefs()
+        self.mediator.filters.button_grid.block_toggles(False)
+        self.emitter.emit("lan_page_initialized")
         ServerModelManager(self, tv).load()
 
+    def populate_filter_prefs(self) -> None:
+        tv = self.get_active_treeview()
+        filters = self.config_man.get_filters(tv)
+        if filters is None:
+            return
+        filter_man = self.get_filter_man()
+        for filt, state in filters.items():
+            filter_man.set_filter(filt, state)
+        self.mediator.filters.set_filters(filters)
+
     def get_dist_cache(self) -> dict[str, "Haversine"]:
         return self.dist_cache
 
@@ -319,16 +359,7 @@ class Controller(GObject.GObject):
         filter_man = self.get_filter_man()
         return filter_man.get_filters()
 
-    # TODO: rename
-    def _on_servers_loaded_init(self, emitter: "Emitter") -> None:
-        """Triggered after servers load but prior to maps loading"""
-        # FIXME: wipe maps store when changing tabs if model is none
-        # e.g. select recent, toggle map, then select lan -> not wiped
-        tv = self.get_active_treeview()
-        if tv.loaded is False:
-            return
-        store = self.get_map_store()
-        self.emitter.emit("load_maps", store)
+    # FIXME: wipe maps store when changing tabs if model is none
 
     def has_server_model(self) -> bool:
         treeview = self.get_active_treeview()
@@ -369,6 +400,9 @@ class Controller(GObject.GObject):
     def get_menu(self) -> "MenuTreeView":
         return self.mediator.menu
 
+    def unset_fav(self) -> None:
+        self.config_man.unset_fav()
+
     def has_favorites(self) -> bool:
         favs = self.config_man.get_favorites()
         if len(favs) < 1:
@@ -380,7 +414,7 @@ class Controller(GObject.GObject):
 
     def add_by_str(self, addr: str) -> None:
         saved_tree = self.get_servers().get_saved()
-        ServerModelManager(self, saved_tree).add_by_str(addr)
+        ServerModelManager(self, saved_tree).add_by_ip(addr)
 
     def add_by_record(self, record: "Record") -> None:
         saved_tree = self.get_servers().get_saved()
@@ -390,9 +424,12 @@ class Controller(GObject.GObject):
         saved_tree = self.get_servers().get_saved()
         ServerModelManager(self, saved_tree).remove_by_record(record)
 
-    def add_to_history(self, record: dict[str, Any]) -> None:
+    def add_to_history(self, row: dict[str, Any], record: "Record") -> None:
         tv = self.get_servers().get_recent()
-        ServerModelManager(self, tv).add_to_history(record)
+        ServerModelManager(self, tv).add_to_history((row, record))
+
+    # def append_to_history(self, record: "Record") -> None:
+    #     self.config_man.append_to_history_file(record)
 
     def remove_from_history(self, record: "Record") -> None:
         # NOTE: remove action is only possible from history tree context menu,
@@ -401,14 +438,8 @@ class Controller(GObject.GObject):
         ServerModelManager(self, tv).remove_from_history(record)
 
     def connect_by_str(self, addr: str) -> None:
-        if addr.isdigit():
-            config_man = self.get_config_man()
-            key = config_man.lookup(Preferences.BM)
-            self.connection_man = ConnectionManager(self)
-            self.connection_man.connect_by_id(int(addr), key)
-        else:
-            self.connection_man = ConnectionManager(self)
-            self.connection_man.connect_by_ip(addr)
+        self.connection_man = ConnectionManager(self)
+        self.connection_man.connect_by_ip(addr)
 
     def connect_by_record(self, record: "Record") -> None:
         self.connection_man = ConnectionManager(self)
@@ -429,6 +460,9 @@ class Controller(GObject.GObject):
         open_workshop_page(mod, cmd)
 
     def has_note(self) -> bool:
+        # TODO: get record string, store in memory
+        # get note by record, get is in favs, etc. store as a block
+        # this is only used by context mixin
         note = self.get_note()
         if len(note) > 0:
             return True
@@ -443,11 +477,13 @@ class Controller(GObject.GObject):
         return self.notes_man.get_note(record)
 
     def add_note(self, note: str) -> None:
+        # TODO: record should be cached upon creation of dialog
         tv = self.get_active_treeview()
         record = tv.get_record_string()
         self.notes_man.add_note(record, note)
 
     def delete_note(self) -> None:
+        # TODO: record should be cached upon creation of dialog
         tv = self.get_active_treeview()
         record = tv.get_record_string()
         self.notes_man.delete_note(record)
@@ -487,10 +523,17 @@ class Controller(GObject.GObject):
 
     def set_start_tab(self) -> None:
         ind = self.config_man.get_start_tab()
+        logger.info(f"Setting start tab to index {ind}")
         self.get_servers().notebook.set_current_page(ind)
 
-    def update_and_connect(self, raise_window: bool) -> None:
-        self.connection_man.update_and_connect(raise_window)
+    def get_debug_args(self) -> str:
+        return self.connection_man.get_debug_args()
+
+    def update_and_load_to_menu(self) -> None:
+        self.connection_man.update_and_connect(menu_only=True)
+
+    def update_and_connect(self) -> None:
+        self.connection_man.update_and_connect()
 
     def update_status(self) -> None:
         self.mediator.preconnect.mark_finished()
@@ -500,3 +543,17 @@ class Controller(GObject.GObject):
 
     def present_window(self) -> None:
         self.mediator.window.present_with_time(Gdk.CURRENT_TIME)
+
+    def is_cancel_pending(self) -> bool:
+        if self.get_exit_event().is_set():
+            return True
+        if self.get_cancel_event().is_set():
+            self.clear_cancel_event()
+            return True
+        return False
+
+    def open_offline(self) -> None:
+        self.open_page(NotebookPage.OFFLINE)
+        mod_man = self.mediator.modtreeview.get_mod_man()
+        store = mod_man.store
+        self.mediator.offline_loader.populate(store)

dzgui/data/CHANGELOG.md

@@ -1,5 +1,10 @@
-## Added
+# Changelog
+
+## [7.0.0] Unreleased
+### Added
 - Setup wizard
+- Uninstall wizard
+- Descriptive details panel to certain error dialogs
 - Changelog text wrapping and formatting
 - Changelog ships with source
 - Documentation ships with source
@@ -21,6 +26,7 @@
 - Set favorite server from tables
 - Detailed/copyable trace in critical error dialogs
 - Visual icons
+- Unset favorite server button
 - Integrated server notebook
 - Propagate width changes to all tables
 - Remember tree position in menus
@@ -34,12 +40,26 @@
 - Early load alerts button
 - Preconnect dialog
 - Preconnect warnings/failsafes like filesize
+- Save filters per server context between sessions
+- Preboot progress dialog
+- Choose to jump into splash screen instead of server
+- Collapsible connection panel
+- Play offline (load mods directly)
+- Generate Steam shortcuts and cover art
+- Warn user if background downloads are disabled
+- Dynamic copy button
+- Update map count (-u flag)
+- Filter button tooltips
+- Expand/collapse changelog versions
+- Support local light/dark mode changes on system theme
 
-
-## Changed
+### Changed
 - Conform to PEP 440 versioning for beta versions
+- Enforce fullscreen mode on Steam Deck
 - Reduce padding on keys button
 - Boldface breadcrumbs
+- Changed some dialog error messages from popups to popovers
+- Changed how filter buttons are packed in sidebar
 - Bold labels inside frames
 - Sidebar buttons do not steal focus
 - Copy IP copies IP:queryport only instead of IP:gameport:queryport, mimics syntax needed by add by ip method
@@ -49,26 +69,815 @@
 - Suppress log messages from imported modules
 - Embed Workshop link in Options menu
 - Disable overlay scrollbars on server tables
+- Reduce size of geolocation DB on disk (~100MB)
+- Enable LAN page Empty/Full filters on first run of app
+- Propagate subscribed mods to Steam client
+- Make j/k keys in context menus follow same wraparound logic as down arrow/up arrow
 
-## Dropped
-- Debug mode
+### Dropped
+- Battlemetrics API support
+- Unused metadata from system log files
 - Branch switching
 - Manual mod install mode (describe rationale)
 - Force update mods
 
-## Fixed
+### Fixed
 - Longstanding issue with left clicks not registering as tree selection changes after spamming keyboard input
+- In-game time field missing certain ranges of time at night
+- Wrap long entries in changelog
+- Certain server descriptions with special characters not rendering correctly
 - Center server title text on server dialogs
 - Rare segfaults when changing maps (threading)
 - Moved dialogs out of threads
+- History table not being in lock-step with state file
+- Current keyword filter not being applied when refreshing table
 
-## Unreleased
+### Unreleased
 - Load offline mods
-- Choose to jump into splash screen instead of server
 - Local documentation
 - Raw debug command in context menu
 
-## Developer-facing
+### Developer-facing
 - Add pyproject.toml file
 - Show deprecation warnings
 - Options -> Dev page
+
+## [6.0.5] 2026-05-17
+### Changed
+- Update symlink hash logic to align with DZGUI 7 beta
+- Update A2S helper to latest commit
+
+## [6.0.4] 2026-04-13
+### Fixed
+- Update A2S module checksums to support servers with missing description field
+
+## [6.0.3] 2026-04-12
+### Fixed
+- Use GLibUnix namespace where available when setting up SIGINT callback
+
+## [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

dzgui/init/coords.py

@@ -13,11 +13,6 @@ logger = logging.getLogger(APP_NAME)
 def get_local_coords(path: "Path") -> Coords | None:
     try:
         my_ip = get_local_ip()
-    except Exception as e:
-        logger.warn(e)
-        return None
-
-    try:
         return get_coords(path, my_ip)
     except Exception as e:
         logger.warn(e)

dzgui/init/dayz.py

@@ -1,14 +1,12 @@
 import logging
-import sys
 
 from pathlib import Path
 
+from dzgui.api.steam import get_app_path
 from dzgui.config.query import lookup
-from dzgui.const.constants import APPID_DAYZ, APP_NAME, LIBRARYFOLDERS_PATH
+from dzgui.const.constants import APPID_DAYZ, APP_NAME
 from dzgui.const.enum import Preferences
-from dzgui.views.dialogs.early_alert import EarlyAlertDialog
 
-import dzgui.api.pefile as PeFile
 
 logger = logging.getLogger(APP_NAME)
 
@@ -16,8 +14,7 @@ logger = logging.getLogger(APP_NAME)
 def is_dayz_installed(config: Path) -> None:
     try:
         path = lookup(config, Preferences.DEFAULT)
-        PeFile.get_app_path(Path(path) / LIBRARYFOLDERS_PATH, APPID_DAYZ)
+        get_app_path(Path(path), APPID_DAYZ)
     except Exception as e:
         logger.critical(e)
-        EarlyAlertDialog(str(e))
-        sys.exit(1)
+        raise e

dzgui/init/libgi.py

@@ -0,0 +1,50 @@
+import platform
+import sys
+
+from ctypes.util import find_library
+from warnings import deprecated
+
+LIB = "libgirepository-2.0"
+
+
+@deprecated("currently unused")
+def is_debian() -> bool:
+    """
+    cf.
+
+    NAME="Debian GNU/Linux"
+    ID=debian
+
+    NAME="Ubuntu"
+    ID=ubuntu
+    ID_LIKE=debian
+
+    NAME="Linux Mint"
+    ID=linuxmint
+    ID_LIKE="ubuntu debian"
+
+    NAME="Pop!_OS"
+    ID=pop
+    ID_LIKE="ubuntu debian"
+    """
+    release = platform.freedesktop_os_release()
+    strings = ["ubuntu debian", "debian"]
+    try:
+        self_id = release["ID"]
+        if self_id == "debian":
+            return True
+        id_like = release["ID_LIKE"]
+        return id_like in strings
+    except Exception:
+        return False
+
+
+def has_libgi() -> bool:
+    return bool(find_library("girepository-2.0"))
+
+
+def test_libgi_missing() -> None:
+    msg = f"System is missing the required library '{LIB}'. Install it via your system package manager."
+    if has_libgi() is False:
+        print(msg)
+        sys.exit(1)

dzgui/init/migrate.py

@@ -1,33 +1,45 @@
+import json
 import shutil
 
 from pathlib import Path
+from typing import Any
 from dzgui.const.constants import LEGACY_CONFIG_PATH, LEGACY_COLS_PATH, LEGACY_IPS_PATH
 from dzgui.config.convert import rc2json
 from dzgui.util._json import read_json, write_json
 
 
-def migrate_legacy_conf(config: Path) -> None:
+def migrate_legacy_conf(config: Path) -> Any:
     old_conf = Path.home() / LEGACY_CONFIG_PATH
     j = rc2json(old_conf)
-    config.parent.mkdir(parents=True, exist_ok=True)
-    config.write_text(j)
+    return json.loads(j)
 
 
 def has_new_config(config: Path) -> bool:
     return config.exists()
 
 
-def migrate_cols_file(res: Path) -> None:
-    # NOTE: dzg.columns.json is API 7 spec
-    old_res = Path.home() / LEGACY_COLS_PATH
-    if old_res.is_file():
-        j = read_json(old_res)
-        cols = j["cols"]
-        if "View" in cols:
-            return
+def convert_cols_file(res: Path) -> Any | None:
+    j = read_json(res)
+    cols = j["cols"]
+    # NOTE: implies prior conversion
+    if "View" in cols:
+        return None
+    # NOTE: user may not have changed these widths in API 6
+    try:
         cols["View"] = cols.pop("Perspective")
         cols["Max"] = cols.pop("Maximum")
-        write_json(j, res)
+    except Exception:
+        pass
+    return j
+
+
+def migrate_cols_file(res: Path) -> None:
+    # NOTE: filename "dzg.columns.json" is API 7 spec
+    old_res = Path.home() / LEGACY_COLS_PATH
+    if old_res.is_file():
+        j = convert_cols_file(old_res)
+        if j is not None:
+            write_json(j, res)
 
 
 def copy_state_files(state_path: Path) -> None:

dzgui/init/proc.py

@@ -1,11 +1,10 @@
 import psutil
 import subprocess
 import shutil
-
-from warnings import deprecated
+import logging
 
 from dzgui.const.constants import (
-    DAYZ_BINARY,
+    APP_NAME,
     STEAM_CMD,
     FLATPAK_APPID,
     FLATPAK_CMD,
@@ -13,18 +12,7 @@ from dzgui.const.constants import (
     FLATPAK_SANDBOX,
 )
 
-
-# TODO: move to util.proc
-def is_dayz_running() -> bool:
-    """Subprocesses spawned from Steam will not show up in regular process tree"""
-    procs = []
-    substring = DAYZ_BINARY
-    for proc in psutil.process_iter():
-        try:
-            procs.append(proc.cmdline())
-        except Exception:
-            continue
-    return any(substring in item for sublist in procs for item in sublist)
+logger = logging.getLogger(APP_NAME)
 
 
 def is_steam_running(cmd: str) -> bool:
@@ -61,25 +49,3 @@ def has_cmd(cmd: str) -> bool:
     if shutil.which(cmd) is not None:
         return True
     return False
-
-
-@deprecated("dropped in favor of Gtk native methods")
-def foreground(cmd: str, pid: int) -> None:
-    if cmd == "wmctrl":
-        proc = subprocess.run(["wmctrl", "-ilp"], capture_output=True, text=True)
-        lines = proc.stdout.splitlines()
-        for line in lines:
-            els = line.split(" ")
-            if str(pid) in els:
-                wid = els[0]
-                break
-        subprocess.run(["wmctrl", "-ia", wid])
-    elif cmd == "xdotool":
-        args = [cmd, "search", "--pid", str(pid)]
-        proc = subprocess.run([*args], capture_output=True, text=True)
-        lines = proc.stdout.splitlines()
-        ## NOTE: some forked subprocesses may fail, so skip over them
-        for line in lines:
-            subprocess.run(
-                ["xdotool", "windowactivate", line], stderr=subprocess.DEVNULL
-            )

dzgui/main.py

@@ -1,151 +1,47 @@
 import argparse
-import logging
-import os
 import sys
 import warnings
 
-from typing import TYPE_CHECKING
-
-from dzgui.api.mods import remove_stale_signatures
 from dzgui.const.constants import APP_NAME
-from dzgui.const.enum import Preferences
-from dzgui.config.ipdb import get_ipdb
-from dzgui.config.query import lookup
-from dzgui.config.userprefs import UserPrefs
-from dzgui.config.xdg import get_xdg_paths, parse_filepaths
-from dzgui.init.coords import get_local_coords
-from dzgui.init.dayz import is_dayz_installed
-from dzgui.init.flock import lock_acquire
-from dzgui.init.migrate import (
-    has_new_config,
-    copy_state_files,
-    migrate_cols_file,
-)
+from dzgui.init.libgi import test_libgi_missing
 from dzgui.init.prefix import get_version
-from dzgui.init.prereqs import has_steam_client
-from dzgui.strings import boot
-from dzgui.init.update import check_updates
+from dzgui.util.deck import is_steam_deck
+from dzgui.util.map_count import set_map_count
+from dzgui.util.strings import flags
 
-# from dzgui.util.map_count import get_map_count
-from dzgui.util.deck import is_steam_deck, is_game_mode
-from dzgui.util.localize import set_locale
-from dzgui.util.symlink import rebuild_symlinks
-from dzgui.util.strings import init, flags
-
-from dzgui.views.base import App
-from dzgui.views.dialogs.wizard import SetupWizard
-from dzgui.views.dialogs.early_alert import EarlyAlertDialog
-
-if TYPE_CHECKING:
-    from pathlib import Path
-
-logger = logging.getLogger(APP_NAME)
+from dzgui.views.dialogs.uninstall import UninstallWizard
+from dzgui.config.xdg import get_xdg_paths
 
 parser = argparse.ArgumentParser(description=flags.description)
-parser.add_argument("-v", "--version", action="store_true", help=flags.version)
-parser.add_argument("-u", "--uninstall", action="store_true", help=flags.uninstall)
-parser.add_argument("-d", "--debug", action="store_true", help=flags.debug)
+group = parser.add_mutually_exclusive_group()
+group.add_argument("-d", "--debug", action="store_true", help=flags.debug)
+group.add_argument("-m", "--map", action="store_true", help=flags.map_count)
+group.add_argument("-u", "--uninstall", action="store_true", help=flags.uninstall)
+group.add_argument("-v", "--version", action="store_true", help=flags.version)
 args = parser.parse_args()
 
 
-# TODO: profile load time
-def make_parents(path: "Path") -> None:
-    path.parent.mkdir(parents=True, exist_ok=True)
-
-
-def uninstall() -> None:
-    # TODO: uninstall data files (-u)
-    # -u removes state, log, freedesktop
-    # XDG_SHARE_HOME/dzgui
-    # XDG_STATE_HOME/dzgui
-    # XDG_DATA_HOME/dzgui
-    pass
-
-
-def setup_logger(log_path: "Path") -> None:
-    _format = (
-        "%(asctime)s␞%(levelname)s␞%(filename)s::%(funcName)s::%(lineno)s␞%(message)s"
-    )
-    fh = logging.FileHandler(log_path)
-    formatter = logging.Formatter(_format)
-    fh.setFormatter(formatter)
-    fh.setLevel(logging.DEBUG)
-    logger.setLevel(logging.DEBUG)
-    logger.addHandler(fh)
-
-
 def main() -> None:
-    lock = lock_acquire()  # noqa
-
     if args.version is True:
         print(get_version())
         sys.exit(0)
     if args.uninstall is True:
-        uninstall()
+        paths = get_xdg_paths()
+        _is_steam_deck = is_steam_deck()
+        UninstallWizard(_is_steam_deck, paths)
         sys.exit(0)
     if args.debug is True:
         warnings.filterwarnings("default", category=DeprecationWarning)
+    if args.map is True:
+        set_map_count()
+        sys.exit(0)
 
     version = get_version()
-    set_locale()
 
     print(f"{APP_NAME} {version}")
+    test_libgi_missing()
 
-    # NOTE: consider aborting this check if steam deck
-    xdg_paths = get_xdg_paths()
-    XDG = parse_filepaths(xdg_paths)
+    # NOTE: only import ligbirepository modules after the above check
+    from dzgui.app_init import load_gui
 
-    if XDG.resolution.parent.is_dir() is False:
-        make_parents(XDG.resolution)
-
-    if XDG.debug.is_file() is False:
-        make_parents(XDG.debug)
-
-    _is_steam_deck = is_steam_deck()
-    _is_game_mode = is_game_mode() if _is_steam_deck else False
-    if _is_game_mode:
-        # NOTE: this may no longer be necessary on newer versions of SteamOS
-        del os.environ["GTK_IM_MODULE"]
-
-    if has_new_config(XDG.config) is False:
-        migrate_cols_file(XDG.columns)
-        copy_state_files(xdg_paths["XDG_STATE_HOME"])
-        # TODO: add logging inside wizard
-        SetupWizard(_is_steam_deck, XDG.config)
-        return
-
-    setup_logger(XDG.debug)
-    with open(XDG.debug, "w") as f:
-        f.truncate(0)
-
-    latest_release = check_updates(version)
-
-    if _is_steam_deck is False:
-        # TODO: sudo escalation dialog
-        # count = get_map_count()
-        # TODO: move into module
-        if has_steam_client() is False:
-            EarlyAlertDialog(init.requires_steam)
-
-    # NOTE: clear versions file of unlinked mods
-    rebuild_symlinks(XDG.config)
-    remove_stale_signatures(XDG.config, XDG.version)
-
-    is_dayz_installed(XDG.config)
-    # TODO: handle IP DB failure and use coords fallback
-    get_ipdb(XDG.ips)
-    local_coords = get_local_coords(XDG.ips)
-    use_miles = lookup(XDG.config, Preferences.DIST)
-
-    prefs = UserPrefs(
-        is_steam_deck=_is_steam_deck,
-        is_game_mode=_is_game_mode,
-        is_debug=args.debug,
-        coords=local_coords,
-        version=version,
-        paths=XDG,
-        latest_release=latest_release,
-        use_miles=use_miles,
-    )
-    print(boot.all_ok)
-    App(prefs)
+    load_gui(version, args.debug)

dzgui/managers/config.py

@@ -1,6 +1,7 @@
 import logging
 import traceback
 
+from collections import deque
 from typing import Any, TYPE_CHECKING
 
 from dzgui.const.constants import (
@@ -11,18 +12,13 @@ from dzgui.const.constants import (
     WINDOW_DEFAULT_X,
     WINDOW_DEFAULT_Y,
 )
-from dzgui.api.probe import test_steam_api, test_bm_api
+from dzgui.api.probe import test_steam_api
 from dzgui.const.enum import Preferences
 from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
 from dzgui.views.dialogs.generic import ExceptionDialog
+from dzgui.strings import dialogs
 from dzgui.util._json import read_json, write_json
 
-import gi
-
-gi.require_version("Gtk", "3.0")
-from gi.repository.Gtk import main_quit  # noqa E402
-
-# import dzgui.api.servers as Servers
 if TYPE_CHECKING:
     from dzgui.config.userprefs import UserPrefs
     from dzgui.controllers.mc import Controller
@@ -53,11 +49,28 @@ class ConfigManager:
         ips.append(record)
         self.update_config(Preferences.IP_LIST, ips)
 
-    def update_history_file(self, records: list[Any]) -> None:
+    def update_history_file(self, fqip: str) -> None:
+        try:
+            with open(self.prefs.paths.history, "r") as f:
+                ips = [line.rstrip() for line in f.readlines()]
+        except FileNotFoundError:
+            ips = []
+
+        seen = set()
+        ips.append(fqip)
+        # NOTE: Preserve linear order of records while deduplicating
+        unique = deque(maxlen=10)  # type: ignore
+        for i in range(len(ips) - 1, -1, -1):
+            if ips[i] not in seen:
+                seen.add(ips[i])
+                unique.appendleft(ips[i])
+                # NOTE: appendleft will push 11th item off right edge
+                if len(unique) == 10:
+                    break
+
         with open(self.prefs.paths.history, "w") as f:
-            for record in records:
-                addr = f"{record[7]}:{record[8]}"
-                f.write(f"{addr}\n")
+            for record in unique:
+                f.write(f"{record}\n")
 
     def remove_saved_server(self, record: str) -> None:
         ips = self.lookup(Preferences.IP_LIST)
@@ -80,15 +93,13 @@ class ConfigManager:
             logger.critical(e)
             raise e
 
-    # TODO: strings
-    @call_on_thread("Checking api")
-    def update_api_key(self, key: Preferences, text: str) -> None:
-        if key is Preferences.STEAM:
-            res = test_steam_api(text)
-        else:
-            res = test_bm_api(text)
+    @call_on_thread(dialogs.checking_api, show_dialog=False)
+    def update_steam_api_key(self, text: str) -> None:
+        res = test_steam_api(text)
         if res is True:
-            self.update_config(key, text)
+            self.update_config(Preferences.STEAM, text)
+            func = StoredFunc(lambda: self.emitter.emit("api_change_successful"))
+            self.thread_man.set_cleanup_func(func)
         else:
             self.thread_man.set_cleanup_func(
                 StoredFunc(lambda: self.emitter.emit("api_change_failed"))
@@ -145,6 +156,13 @@ class ConfigManager:
         except Exception:
             return
 
+    def unset_fav(self) -> None:
+        try:
+            self.write_config(Preferences.FAV_LBL, "")
+            self.write_config(Preferences.FAV_SRV, "")
+        except Exception:
+            return
+
     def write_config(self, key: Preferences, value: str) -> None:
         try:
             real_key = self.enum_to_key(key)
@@ -155,11 +173,14 @@ class ConfigManager:
             logger.critical(e)
             trace = traceback.format_exc()
             dialog = ExceptionDialog(self.controller, trace)
+            dialog.show_all()
             dialog.run()
-            raise e
 
     def save_res_and_quit(self, tv: "ServerTreeView", window: "OuterWindow") -> None:
         columns = tv.get_columns()
+        filters = self.controller.get_all_tree_filters()
+        filters_file = self.prefs.paths.filters
+
         columns_file = self.prefs.paths.columns
         try:
             data = read_json(columns_file)
@@ -174,12 +195,16 @@ class ConfigManager:
 
         try:
             write_json(data, columns_file)
+            write_json(filters, filters_file)
         except Exception as e:
             logger.critical(e)
 
         logger.info("Normal user exit")
         if window.props.is_maximized:
-            main_quit()
+            app = window.get_application()
+            if app is None:
+                return
+            app.quit()
             return
 
         w, h = window.get_size()
@@ -191,7 +216,10 @@ class ConfigManager:
         except Exception as e:
             logger.critical(e)
 
-        main_quit()
+        app = window.get_application()
+        if app is None:
+            return
+        app.quit()
 
     def set_resolution(self, window: "OuterWindow") -> None:
         if self.prefs.is_game_mode:
@@ -217,3 +245,12 @@ class ConfigManager:
             h = WINDOW_DEFAULT_Y
             logger.info(f"Using default window size {w},{h}")
             window.set_default_size(w, h)
+
+    def get_filters(self, tv: "ServerTreeView") -> Any | None:
+        filters = self.prefs.paths.filters
+        try:
+            enum = tv.get_enum()
+            filters = read_json(filters)
+            return filters[str(enum)]
+        except Exception:
+            return None

dzgui/managers/connection.py

@@ -9,12 +9,18 @@ from typing import TYPE_CHECKING
 
 import dzgui.api.pefile as PeFile
 import dzgui.api.servers as Servers
+from dzgui.api.shortcuts import Shortcuts
 
 from dzgui.api.steam import (
     connect,
-    enqueue_mod,
-    get_remote_signatures,
+    connect_debug,
+    get_app_allows_downloads,
+    get_app_name,
     get_needs_update,
+    get_remote_signatures,
+    get_running_app,
+    load_to_menu,
+    subscribe,
 )
 
 from dzgui.api.mods import (
@@ -24,16 +30,23 @@ from dzgui.api.mods import (
     update_signatures,
 )
 from dzgui.const.constants import (
+    API_RATE_LIMIT,
     APP_NAME,
     APPID_DAYZ,
     APPID_DAYZ_EXP,
     APPNAME_DAYZ,
     APPNAME_DAYZ_EXP_HUMAN,
 )
+from dzgui.api.steam import is_dayz_running
 from dzgui.const.enum import NotebookPage, Preferences
-from dzgui.init.proc import is_dayz_running, is_steam_running
+from dzgui.init.proc import is_steam_running
 from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
-from dzgui.strings.dialogs import waiting_for_launch, waiting_for_mods
+from dzgui.strings.dialogs import (
+    waiting_for_launch,
+    waiting_for_mods,
+    waiting_for_directories,
+)
+from dzgui.strings import kb
 from dzgui.strings.server_mods import checkmark, resync
 from dzgui.util.format import format_mib
 from dzgui.util.strings import dialog, server_timeout
@@ -74,6 +87,9 @@ class Prerequisites:
     steam_proc: SteamProcess
     mods: list[list[str]]
     game_mode: bool
+    is_last_server: bool
+    invalid_mods: list[tuple[str, str]]
+    allows_downloads: tuple[bool, str]
 
 
 class ConnectionManager:
@@ -86,14 +102,10 @@ class ConnectionManager:
         self.record: Record
         self.workshop: Path
 
+        self.client: str
         self.remote_mod_ids: list[str] = []
         self.missing_mods: list[tuple[str, str, int, int]] = []
 
-    @call_on_thread(dialog.querying)
-    def connect_by_id(self, _id: int, key: str) -> None:
-        res = Servers.query_by_id(_id, key)
-        self._prepare_connection(res)
-
     @call_on_thread(dialog.querying)
     def connect_by_ip(self, addr: str) -> None:
         res = Servers.query_by_ip(addr)
@@ -140,38 +152,53 @@ class ConnectionManager:
         remote_mods: list[list[str]] = []
         if res.is_modded():
             try:
-                remote_mods = self._query_modlist(record)
+                remote_mods, missing_mods = self._query_modlist(record)
+                self.missing_mods = missing_mods
                 self.remote_mod_ids = [mod[1] for mod in remote_mods]
             except Exception as e:
                 logger.warning(e)
                 self.thread_man.set_cleanup_func(failure_func, destroy_first=True)
                 return
 
-            hashes = get_remote_signatures(self.remote_mod_ids)
-            version_file = prefs.paths.version
-            self.missing_mods = get_needs_update(version_file, hashes)
-
-            for mod in remote_mods:
-                if any(mod[1] in tuple for tuple in self.missing_mods):
-                    mod[2] = resync
-
             if local_version is not None:
                 pefile_path = PeFile.get_pefile_path(steam_path, info.game_id)
                 total, used, free = shutil.disk_usage(pefile_path)
                 if len(self.missing_mods) > 0:
                     required_size = sum(row[2] for row in self.missing_mods)
                     required_mib = format_mib(required_size)
-                    free_mib = format_mib(required_size)
+                    free_mib = format_mib(free)
 
         dayz_running = is_dayz_running()
 
+        running_app = get_running_app()
+        if running_app is not None:
+            allows_dl = get_app_allows_downloads(steam_path, running_app)
+            running_app_name = get_app_name(running_app)
+            # NOTE: for out-of-range appid, assume NSG.
+            # dzgui.api.steam.get_app_name() will return None
+            if running_app_name is None:
+                s = Shortcuts(steam_path)
+                # NOTE: returns "Unknown" if unparseable
+                running_app_name = s.find_appname_by_unsigned_id(running_app)
+            allows_downloads = (allows_dl, running_app_name)
+        else:
+            allows_downloads = (True, "")
+
         client_name = self.controller.get_steam_client_name()
         client = self.controller.query_config(Preferences.CLIENT)
         running = is_steam_running(client)
         steam_proc = SteamProcess(client_name, running)
+        self.client = client
 
         game_mode = prefs.is_game_mode
 
+        is_last = self.is_last_server()
+
+        # TODO: strings
+        invalid_mods = [
+            (mod[0], mod[1]) for mod in remote_mods if mod[2] == "Invalid mod"
+        ]
+
         prereqs = Prerequisites(
             name=info.server_name,
             appid=info.game_id,
@@ -186,11 +213,25 @@ class ConnectionManager:
             steam_proc=steam_proc,
             mods=remote_mods,
             game_mode=game_mode,
+            is_last_server=is_last,
+            invalid_mods=invalid_mods,
+            allows_downloads=allows_downloads,
         )
 
         func = StoredFunc(self.controller.open_connection_assistant, prereqs)
         self.thread_man.set_cleanup_func(func, destroy_first=True)
 
+    def is_last_server(self) -> bool:
+        prefs = self.controller.get_prefs()
+        history = prefs.paths.history
+        try:
+            lines = history.read_text().splitlines()
+            last = lines[-1]
+            current = Servers.record_to_fqip(self.record)
+            return last == current
+        except Exception:
+            return False
+
     @call_on_thread(dialog.querying)
     def query_details(self, record: Servers.Record) -> None:
         details = Servers.get_details(record)
@@ -203,10 +244,13 @@ class ConnectionManager:
             StoredFunc(self._present_details_dialog, details), destroy_first=True
         )
 
-    def _query_modlist(self, record: Servers.Record) -> list[list[str]]:
+    def _query_modlist(
+        self, record: Servers.Record
+    ) -> tuple[list[list[str]], list[tuple[str, str, int, int]]]:
         mods = Servers.get_rules(record)
         steam_path = self.controller.query_config(Preferences.DEFAULT)
-        local = get_local_mod_ids(steam_path)
+        local = get_local_mod_ids(Path(steam_path))
+
         alpha_mods: list[list[str]] = [
             [
                 mod.name,
@@ -216,12 +260,28 @@ class ConnectionManager:
             for mod in mods
         ]
         alpha_mods.sort(key=lambda x: x[0])
-        return alpha_mods
+
+        prefs = self.controller.get_prefs()
+        version_file = prefs.paths.version
+
+        remote_mod_ids = [mod[1] for mod in alpha_mods]
+        hashes = get_remote_signatures(remote_mod_ids)
+        missing_mods = get_needs_update(version_file, hashes)
+        for mod in alpha_mods:
+            if any(mod[1] in tuple for tuple in missing_mods):
+                mod[2] = resync
+        for mod in alpha_mods:
+            # NOTE: if the mod is neither synched or out of date, it is a malformed mod
+            if mod[2] == "":
+                # TODO: strings
+                mod[2] = "Invalid mod"
+
+        return alpha_mods, missing_mods
 
     @call_on_thread(dialog.querying)
     def query_modlist_and_present(self, record: Servers.Record) -> None:
         try:
-            mods = self._query_modlist(record)
+            mods, missing_mods = self._query_modlist(record)
         except Exception:
             self.thread_man.set_cleanup_func(
                 StoredFunc(self._server_timeout), destroy_first=True
@@ -242,24 +302,34 @@ class ConnectionManager:
 
     def _server_timeout(self) -> None:
         dialog = ExceptionDialog(self.controller, server_timeout)
+        dialog.set_details_buffer(kb.DZG_006)
+        dialog.show_all()
         dialog.run()
 
-    def _connect_steam(self) -> None:
+    def get_debug_args(self) -> str:
         addr = f"{self.record.ip}:{self.record.gameport}"
         playername = self.controller.query_config(Preferences.NAME)
-        client = self.controller.query_config(Preferences.CLIENT)
-        rc = connect(client, addr, self.appid, playername, self.remote_mod_ids)
+        return connect_debug(
+            self.client, addr, self.appid, playername, self.remote_mod_ids
+        )
+
+    def _connect_steam(self, menu_only: bool) -> None:
+        addr = f"{self.record.ip}:{self.record.gameport}"
+        playername = self.controller.query_config(Preferences.NAME)
+        if menu_only:
+            rc = load_to_menu(self.client, self.appid, playername, self.remote_mod_ids)
+        else:
+            rc = connect(self.client, addr, self.appid, playername, self.remote_mod_ids)
         if rc != 0:
             # TODO: log/pop the error
             func = StoredFunc(self.controller.update_status)
             self.thread_man.set_cleanup_func(func)
             return
 
-        self.thread_man.show_cancel(False)
         self.thread_man.update_dialog(waiting_for_launch)
         while True:
-            # TODO: check cancel event
-            if self.controller.get_exit_event().is_set():
+            # FIXME: cancel should not be visible here per setting above
+            if self.controller.is_cancel_pending():
                 # TODO: some facility to also close spawned steam process
                 return
             if is_dayz_running():
@@ -270,33 +340,31 @@ class ConnectionManager:
         self.thread_man.set_cleanup_func(func)
 
     def _add_to_history_and_return(self) -> None:
-        self.controller.add_to_history(self.history)
+        self.controller.add_to_history(self.history, self.record)
         self.controller.open_page(NotebookPage.SERVERS)
 
-    def _update_mods(self, raise_window: bool) -> None:
-        # NOTE: fast enqueue all mods in auto mode
+    def _update_mods(self, menu_only: bool = False) -> None:
         prefs = self.controller.get_prefs()
+        config_man = self.controller.get_config_man()
+        key = config_man.lookup(Preferences.STEAM)
 
         for title, mod, stamp, size in self.missing_mods:
-            # TODO: check cancel and exit events
-            enqueue_mod(mod, self.appid)
-            time.sleep(2)
-
-        if raise_window is True:
-            logger.info("Bringing window to foreground")
-            GLib.idle_add(self.controller.present_window)
+            if self.controller.is_cancel_pending():
+                return
+            subscribe(key, int(mod))
+            time.sleep(API_RATE_LIMIT)
 
+        self.thread_man.update_dialog(waiting_for_directories)
         for title, mod, stamp, size in self.missing_mods:
             mod_path = self.workshop / mod
 
             # NOTE: Steam updates mod chunks in parallel, will finish at the same time
             while mod_path.is_dir() is False:
+                if self.controller.is_cancel_pending():
+                    return
                 time.sleep(1)
             while True:
-                if self.controller.get_exit_event().is_set():
-                    return
-                if self.controller.get_cancel_event().is_set():
-                    self.controller.clear_cancel_event()
+                if self.controller.is_cancel_pending():
                     return
                 cur_size = get_mod_dir_size(mod_path)
                 if cur_size == size:
@@ -304,13 +372,17 @@ class ConnectionManager:
                 time.sleep(1)
 
         update_signatures(self.missing_mods, prefs.paths.version)
-        # TODO: just push steam path directly
         rebuild_symlinks(prefs.paths.config)
-        self._connect_steam()
+
+        # NOTE: update table status in main loop
+        self.thread_man.update_emitter("all_mods_synched")
+
+        # TODO: just push steam path directly
+        self._connect_steam(menu_only)
 
     @call_on_thread(waiting_for_mods, show_cancel=True)
-    def update_and_connect(self, raise_window: bool) -> None:
+    def update_and_connect(self, menu_only: bool = False) -> None:
         if len(self.missing_mods) > 0:
-            self._update_mods(raise_window)
+            self._update_mods(menu_only)
         else:
-            self._connect_steam()
+            self._connect_steam(menu_only)

dzgui/managers/contextmenu.py

@@ -1,4 +1,3 @@
-import gi
 import logging
 from typing import TYPE_CHECKING
 
@@ -8,16 +7,12 @@ from dzgui.util.clip import copy_clipboard
 from dzgui.util.open_links import open_workshop_page
 
 from dzgui.views.dialogs.note import NoteDialog
-from dzgui.views.trees.tree_mods import ModTreeView
+from dzgui.views.trees.tree_mods import ModTreeView, OfflineModTreeView
 from dzgui.views.trees.tree_log import LogTreeView
 from dzgui.views.trees.tree_servers import ServerTreeView
 from dzgui.views.trees.tree_server_mods import ServerModTreeView
 
 
-gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gdk, GLib, GObject  # noqa E402
-
-
 logger = logging.getLogger(APP_NAME)
 
 if TYPE_CHECKING:
@@ -27,7 +22,13 @@ if TYPE_CHECKING:
 class ContextMenuManager:
     def __init__(
         self,
-        treeview: LogTreeView | ModTreeView | ServerTreeView | ServerModTreeView,
+        treeview: (
+            LogTreeView
+            | ModTreeView
+            | ServerTreeView
+            | ServerModTreeView
+            | OfflineModTreeView
+        ),
         controller: "Controller",
     ) -> None:
         self.controller = controller
@@ -72,10 +73,10 @@ class ContextMenuManager:
                 case ContextMenu.SHOW_MODS:
                     self.controller.get_modlist(record)
 
-        if isinstance(self.treeview, ModTreeView):
+        if isinstance(self.treeview, (ModTreeView, OfflineModTreeView)):
             match action:
-                case ContextMenu.DELETE_MOD:
-                    self.controller.delete_mods()
+                case ContextMenu.UNSUB_MOD:
+                    self.controller.unsub_mods(self.treeview)
                 case ContextMenu.OPEN_WORKSHOP:
                     self.open_mod_page()
 

dzgui/managers/filter.py

@@ -9,7 +9,7 @@ if TYPE_CHECKING:
 
 
 class FilterManager:
-    def __init__(self) -> None:
+    def __init__(self, show_empty: bool = False, show_full: bool = False) -> None:
 
         self.map_store = ModelFactory().make_map_store()
 
@@ -17,18 +17,34 @@ class FilterManager:
         self.default_filters = {
             strings.filter_1pp: True,
             strings.filter_day: True,
-            strings.filter_empty: False,
+            strings.filter_empty: show_empty,
             strings.filter_3pp: True,
             strings.filter_night: True,
-            strings.filter_full: False,
-            strings.filter_lowpop: True,
-            strings.filter_nonascii: False,
-            strings.filter_duplicate: False,
+            strings.filter_full: show_full,
             strings.filter_official: True,
+            strings.filter_nonascii: False,
+            strings.filter_lowpop: True,
             strings.filter_unofficial: True,
+            strings.filter_duplicate: False,
             strings.filter_modded: True,
         }
 
+        # TODO: strings
+        self.tooltips = {
+            strings.filter_1pp: "First-person perspective",
+            strings.filter_day: "In-game time between 0700 and 1659",
+            strings.filter_empty: "Servers with no players",
+            strings.filter_3pp: "Third-person perspective",
+            strings.filter_night: "In-game time between 1700 and 0659",
+            strings.filter_full: "Servers with no open slots",
+            strings.filter_official: "Bohemia official servers",
+            strings.filter_nonascii: "Server names using non-standard, complex glyphs",
+            strings.filter_lowpop: "Current population is under 30% of total",
+            strings.filter_unofficial: "Third-party servers",
+            strings.filter_duplicate: "Duplicates of existing servers (usually spoofed)",
+            strings.filter_modded: "Servers with one or more mods",
+        }
+
         self.active_keyword = ""
         self.active_map = (0, all_maps)
         self.prior_map = all_maps
@@ -36,6 +52,9 @@ class FilterManager:
         self.filters: list
         self.enabled_filters = dict(self.default_filters)
 
+    def get_tooltips(self) -> dict[str, str]:
+        return self.tooltips
+
     def set_prior_map(self, name: str) -> None:
         self.prior_map = name
 
@@ -80,17 +99,20 @@ class FilterManager:
         if maps is None:
             return
         if len(maps) < 1:
+            self.reinit_map_store()
             return
 
         self.reinit_map_store()
         maps.sort()
         for m in maps:
+            # TODO: strings
             if m == "All maps":
                 continue
             self.append_map([m])
 
+    # TODO: currently unused
     def get_unique_maps(self) -> list[str]:
-        return [row[0] for row in self.map_store if row != "All maps"]
+        return [row[0] for row in self.map_store if row[0] != "All maps"]
 
     def get_all_filters(self) -> tuple:
         map_name = self.get_active_map_name()

dzgui/managers/mods.py

@@ -1,23 +1,28 @@
 import logging
-import shutil
+import time
 
 from pathlib import Path
-from typing import Any, TYPE_CHECKING
+from typing import TYPE_CHECKING
 
+from dzgui.api.steam import unsubscribe
 from dzgui.api.mods import (
     get_delimited_mods,
-    get_local_mod_path,
     find_stale_mods,
     _hash,
     remove_stale_signatures,
 )
-from dzgui.const.constants import APP_NAME, APPID_DAYZ, APPID_DAYZ_EXP
+from dzgui.const.constants import (
+    API_RATE_LIMIT,
+    APP_NAME,
+    APPID_DAYZ,
+    APPID_DAYZ_EXP,
+)
 from dzgui.const.enum import Preferences
 from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
 from dzgui.model.model_factory import FastInsertListStore, ModelFactory
+from dzgui.strings import dialogs
 from dzgui.util.format import format_mods
-from dzgui.util.strings import server_timeout
-from dzgui.views.dialogs.generic import ExceptionDialog
+from dzgui.util.symlink import rebuild_symlinks
 
 
 import dzgui.api.pefile as PeFile
@@ -39,40 +44,48 @@ class ModManager:
     this manager is instantiated each time the Mods page is opened
     """
 
-    def __init__(self, controller: "Controller") -> None:
+    def __init__(self, tree: Gtk.TreeView, controller: "Controller") -> None:
+        self.treeview = tree
         self.controller = controller
+
         self.emitter = controller.get_emitter()
         self.prefs = controller.get_prefs()
         self.path = controller.query_config(Preferences.DEFAULT)
-        self.treeview = self.controller.get_modtreeview()
 
-        self.store: FastInsertListStore
+        self.store: FastInsertListStore | None = None
 
         self.thread_man = ThreadingManager(controller)
-        self._get_mods()
 
-    # TODO: dialog strings
-    @call_on_thread("getting mods")
-    def _get_mods(self) -> None:
-        mods = get_delimited_mods(self.path)
+    @call_on_thread(dialogs.fetching_mods)
+    def load_mods(self) -> None:
+        mods = get_delimited_mods(Path(self.path))
         if len(mods) < 1:
             msg = self.format_mod_statusbar()
             func = StoredFunc(lambda: self.emitter.emit("mods_updated", msg, 0))
             self.thread_man.set_cleanup_func(func)
             return
 
-        func = StoredFunc(self._on_mods_loaded, mods)
-        self.thread_man.set_cleanup_func(func)
+        prefs = self.controller.get_prefs()
+        rebuild_symlinks(prefs.paths.config)
 
-    def _on_mods_loaded(self, mods: list[list[Any]]) -> None:
         self.store = ModelFactory().make_mod_store()
         self.store.extend(mods)
+        func = StoredFunc(self._on_mods_loaded)
+
+        self.thread_man.set_cleanup_func(func)
+
+    def set_store(self, store: "FastInsertListStore") -> None:
+        self.store = store
+
+    def _on_mods_loaded(self) -> None:
         self.treeview.set_model(self.store)
+        if self.store is None:
+            return
         msg = self.format_mod_statusbar()
         total_mods = len(self.store)
         self.emitter.emit("mods_updated", msg, total_mods)
 
-    def delete_mods(self) -> None:
+    def unsub_mods(self) -> None:
         sel = self.treeview.get_selection()
         model, pathlist = sel.get_selected_rows()
         # NOTE: reverse when multiple selection
@@ -83,7 +96,8 @@ class ModManager:
                 continue
             mod, _iter = res
             mods.append((mod, _iter))
-        self.delete_mods_on_system(mods)
+        self.thread_man.set_job_count(len(mods))
+        self.unsub_all_mods(mods)
 
     def get_mod_from_tree_path(
         self, tree_path: Gtk.TreePath
@@ -95,45 +109,55 @@ class ModManager:
         mod = model.get_value(tree_iter, 2)
         return mod, tree_iter
 
-    # TODO: strings
-    @call_on_thread("deleting mods")
-    def delete_mods_on_system(self, mods: list[tuple[str, Gtk.TreeIter]]) -> None:
+    @call_on_thread(dialogs.deleting_mods)
+    def unsub_all_mods(self, mods: list[tuple[str, Gtk.TreeIter]]) -> None:
         for mod, _iter in mods:
-            self.delete_single_mod(mod)
+            self.unsub_atomic_mod(mod)
+            self.thread_man.increment_dialog()
+            time.sleep(API_RATE_LIMIT)
 
-        iters = [_iter for mod, _iter in mods]
-        func = StoredFunc(self._on_mods_deleted, iters)
+        func = StoredFunc(self._on_mods_unsubbed, mods)
         self.thread_man.set_cleanup_func(func)
 
-    def delete_single_mod(self, mod: str) -> None:
+    def unsub_atomic_mod(self, mod: str) -> None:
+        config_man = self.controller.get_config_man()
+        key = config_man.lookup(Preferences.STEAM)
+        unsubscribe(key, int(mod))
+
         steam_path = Path(self.path)
-        mods_path = get_local_mod_path(steam_path)
         app_path = PeFile.get_nested_app_path(steam_path, APPID_DAYZ)
 
-        md5 = _hash(mod)
-        symlink = app_path / md5
-        symlink.unlink()
-        shutil.rmtree(mods_path / mod)
-
+        try:
+            md5 = _hash(mod)
+            symlink = app_path / md5
+            symlink.unlink()
+        except Exception as e:
+            logger.warning(e)
         # NOTE: second pass to unlink DAYZ_EXP mods
         # TODO: test this with working APPID_DAYZ_EXP installation
         try:
             app_path_exp = PeFile.get_nested_app_path(steam_path, APPID_DAYZ_EXP)
             symlink = app_path_exp / md5
             symlink.unlink()
-        except PeFile.AppNotInstalledError:
+        except Exception:
             pass
+        time.sleep(API_RATE_LIMIT)
 
-    def _on_mods_deleted(self, iters: list[Gtk.TreeIter]) -> None:
+    def _on_mods_unsubbed(self, mod_iter: list[tuple[str, Gtk.TreeIter]]) -> None:
+        mods = [int(mod) for mod, _iter in mod_iter]
+        iters = [_iter for mod, _iter in mod_iter]
+        if self.store is None:
+            return
         for _iter in iters:
             self.store.remove(_iter)
-        remove_stale_signatures(self.prefs.paths.config, self.prefs.paths.version)
+        # TODO: process config path in called function
+        remove_stale_signatures(self.prefs.paths.config, self.prefs.paths.version, mods)
         model = self.treeview.get_model()
         if model is None:
             return
-        mods = len(model)
+        total_mods = len(model)
         msg = self.format_mod_statusbar()
-        self.emitter.emit("mods_updated", msg, mods)
+        self.emitter.emit("mods_updated", msg, total_mods)
 
     def uncolorize_mods(self) -> None:
         model = self.treeview.get_model()
@@ -181,17 +205,12 @@ class ModManager:
                 model[path][4] = True
         self.emitter.emit("mods_highlighted")
 
-    # TODO: dialog strings
-    @call_on_thread("working")
+    @call_on_thread(dialogs.scanning_mods)
     def highlight_stale(self) -> None:
         stale = find_stale_mods(self.prefs.paths.config)
         func = StoredFunc(self._on_stale_mods_found, stale)
         self.thread_man.set_cleanup_func(func)
 
-    def _server_timeout(self) -> None:
-        dialog = ExceptionDialog(self.controller, server_timeout)
-        dialog.run()
-
     def select_colorized(self) -> None:
         model = self.treeview.get_model()
         if model is None:

dzgui/managers/notes.py

@@ -20,7 +20,10 @@ logger = logging.getLogger(APP_NAME)
 class NoteManager:
     def __init__(self, controller: "Controller", path: "Path") -> None:
         self.notes_path = path
-        self.cache: dict[str, str] = read_json(self.notes_path)
+        try:
+            self.cache: dict[str, str] = read_json(self.notes_path)
+        except Exception:
+            self.cache = {}
 
     def add_note(self, server: str, note: str) -> None:
         self.cache[server] = note

dzgui/managers/offline.py

@@ -0,0 +1,133 @@
+import logging
+import time
+from pathlib import Path
+from typing import Callable, TYPE_CHECKING, Union
+
+import dzgui.api.pefile as PeFile
+from dzgui.api.mods import is_mission, get_custom_mods
+from dzgui.api.steam import is_dayz_running, launch_offline
+from dzgui.const.constants import APP_NAME, APPID_DAYZ_EXP
+from dzgui.const.enum import Preferences
+from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
+from dzgui.model.model_factory import ModelFactory
+from dzgui.strings import dialogs
+from dzgui.util.symlink import create_custom_symlinks, rebuild_symlinks, symlink_mission
+from dzgui.views.dialogs.filepicker import FolderPicker
+
+if TYPE_CHECKING:
+    from dzgui.controllers.mc import Controller
+    from dzgui.model.model_factory import FastInsertListStore
+
+logger = logging.getLogger(APP_NAME)
+
+
+class OfflineManager:
+    def __init__(
+        self,
+        controller: "Controller",
+    ) -> None:
+        super().__init__()
+
+        self.controller = controller
+        self.emitter = controller.get_emitter()
+        self.thread_man = ThreadingManager(controller)
+
+        self.appid: int
+        self.local_mods: list[str] | None
+        self.custom_mods: list[str] | None
+
+    # TODO: more robust test
+    def is_custom_folder_valid(self, folder: str) -> bool:
+        return Path(folder).exists()
+
+    # TODO: set properties as members of offline manager on demand and check them here
+    # rather than passing strings again
+    def is_mission_valid(self, folder: str) -> bool:
+        return is_mission(Path(folder))
+
+    def get_mission(self) -> None:
+        folder = self.open_folderpicker(dialogs.mission_dialog)
+        if folder is None:
+            return
+        is_valid = is_mission(folder)
+        self.emitter.emit("custom_mission_loaded", str(folder), is_valid)
+
+    def find_custom_mods(self, callback: Callable) -> None:
+        folder = self.open_folderpicker(dialogs.custom_mod_dialog)
+        window = self.controller.get_window()
+        window.set_sensitive(False)
+        if folder is None:
+            window.set_sensitive(True)
+            return
+        # NOTE: starts spinner in calling UI
+        callback()
+        self.parse_custom_mods(folder)
+
+    @call_on_thread(dialogs.parsing_mods, show_dialog=False)
+    def parse_custom_mods(self, folder: str) -> None:
+        mods = get_custom_mods(Path(folder))
+        store = ModelFactory().make_mod_store()
+        store.extend(mods)
+        func = StoredFunc(self.post_mod_loading, store, folder)
+        self.thread_man.set_cleanup_func(func)
+
+    def post_mod_loading(self, store: "FastInsertListStore", folder: str) -> None:
+        window = self.controller.get_window()
+        window.set_sensitive(True)
+        self.emitter.emit("custom_mods_loaded", store, folder)
+
+    @call_on_thread(dialogs.waiting_for_launch, show_cancel=True)
+    def launch(
+        self,
+        appid: int,
+        mission: str,
+        local_mods: list[str],
+        custom_folder: str,
+        custom_mods: list[str],
+    ) -> None:
+
+        # NOTE: local_mods and custom_mods are lists of symlinks
+        client = self.controller.query_config(Preferences.CLIENT)
+        name = self.controller.query_config(Preferences.NAME)
+        steam_path = self.controller.query_config(Preferences.DEFAULT)
+
+        combined_mods: list[str] = []
+
+        if len(local_mods) > 0:
+            combined_mods.extend(local_mods)
+            config = self.controller.get_prefs().paths.config
+            rebuild_symlinks(config)
+
+        if len(custom_mods) > 0:
+            new_symlinks = create_custom_symlinks(
+                Path(steam_path), Path(custom_folder), custom_mods
+            )
+            combined_mods.extend(new_symlinks)
+
+        relative_link = ""
+        if len(mission) > 0:
+            relative_link = symlink_mission(Path(steam_path), mission)
+
+        launch_offline(client, appid, name, combined_mods, relative_link)
+        while True:
+            if is_dayz_running():
+                break
+            time.sleep(1)
+
+    def open_folderpicker(self, title: str) -> Union["Path", None]:
+        picker = FolderPicker(self.controller.get_window(), title)
+        folder = picker.pick_folder()
+        picker.destroy()
+        return folder
+
+    def has_dayz_exp(self) -> bool:
+        try:
+            default_steam_path = self.controller.query_config(Preferences.DEFAULT)
+            steam_path = Path(default_steam_path)
+            dayz_exp = PeFile.get_pretty_version(steam_path, APPID_DAYZ_EXP)
+            if dayz_exp is None:
+                return False
+            return True
+        except Exception as e:
+            logger.warning(e)
+            return False

dzgui/managers/threading.py

@@ -47,8 +47,8 @@ class StoredFunc:
         self.func = func
         self.bindings = sig.bind(*args, **kwargs)
 
-    def call(self) -> None:
-        self.func(*self.bindings.args, *self.bindings.kwargs)
+    def call(self) -> Any:
+        return self.func(*self.bindings.args, *self.bindings.kwargs)
 
 
 class ThreadingManager:
@@ -81,6 +81,11 @@ class ThreadingManager:
     def set_job_count(self, jobs: int) -> None:
         self.jobs = jobs
 
+    def update_emitter(self, signal: str) -> None:
+        if self.controller:
+            emitter = self.controller.get_emitter()
+        GLib.idle_add(lambda: emitter.emit(signal))
+
     def update_dialog(self, msg: str) -> None:
         GLib.idle_add(lambda: self.wait_dialog.update_text(msg))
 
@@ -113,8 +118,8 @@ class ThreadingManager:
 
         func = self.get_cleanup_func()
         if func is not None:
-            func.call()
             self.set_cleanup_func(None)
+            func.call()
         if not self.destroy_first:
             self.destroy_dialog()
 

dzgui/managers/update.py

@@ -0,0 +1,68 @@
+import logging
+import requests
+import shutil
+import subprocess
+import tarfile
+from typing import TYPE_CHECKING
+
+from dzgui.const.constants import (
+    APP_NAME,
+    TMP_EXE,
+    TMP_PATH,
+    TMP_TARBALL,
+)
+from dzgui.strings import dialogs
+from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
+from dzgui.views.dialogs.generic import ExceptionDialog, QuitDialog
+
+import gi
+
+gi.require_version("Gtk", "3.0")
+from gi.repository import Gtk, GLib  # noqa E402
+
+if TYPE_CHECKING:
+    from dzgui.controllers.mc import Controller
+
+logger = logging.getLogger(APP_NAME)
+
+
+class UpdateManager:
+    def __init__(self, controller: "Controller") -> None:
+
+        self.thread_man = ThreadingManager(controller)
+        self.controller = controller
+
+    @call_on_thread(dialogs.fetching_update)
+    def update_version(self, exe_path: str, url: str) -> None:
+        try:
+            res = requests.get(url)
+            if res.status_code == 200:
+                with open(TMP_TARBALL, "wb") as file:
+                    file.write(res.content)
+                with tarfile.open(TMP_TARBALL) as tar:
+                    tar.extractall(TMP_PATH)
+
+                shutil.copy(TMP_EXE, exe_path)
+
+                proc = subprocess.run([exe_path, "self", "restore"])
+                if proc.returncode == 0:
+                    func = StoredFunc(self._on_update_success)
+                    self.thread_man.set_cleanup_func(func, destroy_first=True)
+                else:
+                    msg = dialogs.failed_to_update
+                    func = StoredFunc(self._on_update_failure, msg)
+                    self.thread_man.set_cleanup_func(func, destroy_first=True)
+        except Exception as e:
+            func = StoredFunc(self._on_update_failure, str(e))
+            self.thread_man.set_cleanup_func(func, destroy_first=True)
+            logger.warning(e)
+
+    def _on_update_success(self) -> None:
+        msg = dialogs.update_success
+        dialog = QuitDialog(self.controller, msg)
+        dialog.run()
+
+    def _on_update_failure(self, msg: str) -> None:
+        dialog = ExceptionDialog(self.controller, msg)
+        dialog.show_all()
+        dialog.run()

dzgui/model/model_factory.py

@@ -2,7 +2,6 @@ from dataclasses import dataclass
 from typing import Any, Sequence, TYPE_CHECKING
 
 from dzgui.const.enum import HELP_MENU_ROWS
-from dzgui.util.redact import redact_log
 from dzgui.util.strings import delimiter
 
 import gi
@@ -134,9 +133,7 @@ class ModelFactory:
         with open(path, "r") as f:
             lines = [line.split(delimiter) for line in f.read().splitlines()]
             for record in lines:
-                # NOTE: strips PII and API keys
-                clean = redact_log(record)
-                store.append(clean)
+                store.append(record)
         return store
 
     def new_model_from_class(self, cls: type) -> FastInsertListStore:
@@ -165,3 +162,6 @@ class ModelFactory:
 
     def make_server_store(self) -> FastInsertListStore:
         return self.new_model_from_class(ServerCols)
+
+    # def convert_model_to_list(self, model: "FastInsertListStore") -> list:
+    #     return [[el for el in row] for row in model]

dzgui/model/proxy_model.py

@@ -1,7 +1,6 @@
 import re
 
 from typing import Any, TYPE_CHECKING, Union
-from warnings import deprecated
 
 from dzgui.const.enum import FilterMode
 from dzgui.model.model_factory import ModelFactory
@@ -13,6 +12,9 @@ if TYPE_CHECKING:
     from dzgui.api.servers import Record
     from dzgui.model.servers import NewPlayerCount
 
+DAY_REG = r"([0][7-9]|[1][0-6])"
+NIGHT_REG = r"([0][0-6]|[1][7-9]|[2][0-3])"
+
 
 class ProxyModelManager:
     """
@@ -85,6 +87,7 @@ class ProxyModelManager:
 
         if found is False:
             self.control_model.append(history)
+
         if len(self.control_model) == 11:
             del self.control_model[0]
 
@@ -231,11 +234,9 @@ class ProxyModelManager:
                         final.append(row)
                 rows = final
             case strings.filter_day:
-                reg = r"([0][0-9]|[1][0-6])"
-                rows = [row for row in rows if not re.match(reg, row[3])]
+                rows = [row for row in rows if not re.match(DAY_REG, row[3])]
             case strings.filter_night:
-                reg = r"([0][0-4]|[1][8]|[2][0-3])"
-                rows = [row for row in rows if not re.match(reg, row[3])]
+                rows = [row for row in rows if not re.match(NIGHT_REG, row[3])]
             case strings.filter_nonascii:
                 rows = [row for row in rows if row[0].isascii()]
             case strings.filter_lowpop:
@@ -258,10 +259,6 @@ class ProxyModelManager:
     def set_cache(self, filters: tuple[str], filtered_rows: list[tuple]) -> None:
         self.filter_cache[filters] = filtered_rows
 
-    @deprecated("Currently unused")
-    # def convert_model_to_list(self, model: "FastInsertListStore") -> list:
-    #    return [[el for el in row] for row in model]
-
     def set_filtered(self, rows: list | None) -> None:
         if rows is None:
             self.filtered = []
@@ -297,4 +294,6 @@ class ProxyModelManager:
     def push(self, data: list[Any]) -> None:
         self.wipe_cache()
         self.set_control(data)
-        self.filter(FilterMode.INITIAL)
+        cur_keyword = self.filter_man.get_active_keyword()
+        mode = FilterMode.TOGGLE_ON if len(cur_keyword) > 0 else FilterMode.INITIAL
+        self.filter(mode)

dzgui/model/servers.py

@@ -14,7 +14,8 @@ from dzgui.const.constants import (
 )
 from dzgui.const.enum import FilterMode, Preferences, ServerTab
 from dzgui.managers.threading import call_on_thread, StoredFunc, ThreadingManager
-from dzgui.util.strings import api_warn_msg, dialog
+from dzgui.strings import dialogs, kb
+from dzgui.util.strings import server_timeout, dialog
 from dzgui.views.dialogs.generic import ExceptionDialog
 
 import gi
@@ -23,7 +24,7 @@ gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk  # noqa E402
 
 if TYPE_CHECKING:
-    from dzgui.api.servers import A2SInfo
+    from dzgui.api.servers import A2SInfo, Record
     from dzgui.controllers.mc import Controller
     from dzgui.model.proxy_model import ProxyModelManager
     from dzgui.views.trees.tree_servers import ServerTreeView
@@ -73,6 +74,7 @@ class ServerModelManager:
                 self._dump_history()
             case ServerTab.LAN:
                 # NOTE: LAN tab is only loaded on demand
+                self.emitter.emit("lan_page_initialized")
                 pass
             case _:
                 pass
@@ -123,31 +125,30 @@ class ServerModelManager:
         parsed = Servers.parse_json(servers)
         self._push_data(parsed)
 
-    @call_on_thread(dialog.scanning)
+    @call_on_thread(dialog.scanning, show_cancel=True)
     def dump_lan(self, port: int, early_abort: bool) -> None:
+        self.first_iteration = True
+
         servers = []
         ports = range(1, 256)
-        failure_func = StoredFunc(self._cleanup_on_failure)
+        failure_func = StoredFunc(self._cleanup_on_lan_failure)
 
         event = threading.Event()
         with ThreadPoolExecutor() as executor:
             futures = [executor.submit(Servers.test_ip, i, port, event) for i in ports]
             for future in as_completed(futures):
                 try:
-                    if self.controller.get_exit_event().is_set():
+                    if self.controller.is_cancel_pending():
+                        event.set()
                         return
                     res = future.result(timeout=LAN_TIMEOUT)
                     if res is None:
                         continue
+                    servers.append(res)
                     if early_abort is True:
                         # NOTE: on first non-empty hit, flag pending threads to close
                         event.set()
-                        servers.append(res)
-                        self.thread_man.set_cleanup_func(
-                            StoredFunc(self._cleanup_on_success)
-                        )
-                        return
-                    servers.append(res)
+                        break
                 except Exception as e:
                     logger.critical(e)
                     self.thread_man.set_cleanup_func(failure_func, destroy_first=True)
@@ -174,29 +175,29 @@ class ServerModelManager:
                 # TODO: wrap except
                 if self.controller.get_exit_event().is_set():
                     return
-                res = future.result(timeout=API_TIMEOUT)
                 self.thread_man.increment_dialog()
-                # NOTE: failing entries are culled
-                if res is None:
-                    # TODO: log which servers failed
-                    continue
-                servers.append(res)
-                if len(servers) == 0:
-                    self.thread_man.set_cleanup_func(
-                        StoredFunc(self._cleanup_on_failure), destroy_first=True
-                    )
-                    return
+
+        """
+        Collects futures in linear order after completion
+        for lock-step representation of the state file
+        """
+        for future in futures:
+            res = future.result(timeout=API_TIMEOUT)
+            # NOTE: failing entries are culled
+            if res is None:
+                # TODO: log which servers failed
+                # query_direct() currently does not return enough information
+                continue
+            servers.append(res)
+            if len(servers) == 0:
+                self.thread_man.set_cleanup_func(
+                    StoredFunc(self._cleanup_on_failure), destroy_first=True
+                )
+                return
 
         parsed = Servers.parse_json(servers)
         self._push_data(parsed)
 
-    @call_on_thread(dialog.querying)
-    def add_by_id(self, _id: str) -> None:
-        config_man = self.controller.get_config_man()
-        key = config_man.lookup(Preferences.BM)
-        res = Servers.query_by_id(int(_id), key)
-        self._parse_single_record(res)
-
     @call_on_thread(dialog.querying)
     def add_by_ip(self, addr: str) -> None:
         res = Servers.query_by_ip(addr)
@@ -221,15 +222,12 @@ class ServerModelManager:
         ) = None,
     ) -> None:
         proxy_man = self._get_proxy_man()
-        config_man = self.controller.get_config_man()
         if rows is not None:
             records = rows
         else:
             control_model = proxy_man.get_control()
             records = control_model
 
-        config_man.update_history_file(records)
-        config_man.update_history_file(records)
         self._sort_unique_maps(records)
         proxy = proxy_man.get_proxy_model()
         self.tv.set_model(proxy)
@@ -239,31 +237,31 @@ class ServerModelManager:
         filter_man = self.tv.get_filter_man()
         maps = self._get_new_maps()
         filter_man.set_unique_maps(maps)
+        store = filter_man.get_map_store()
 
         self.first_iteration = False
-        self.emitter.emit("servers_loaded_init")
+        self.emitter.emit("load_maps", store)
 
-    def add_to_history(self, record: dict[str, Any]) -> None:
+    # TODO: dataclass for record rows; check for other dict annotations
+    def add_to_history(self, data: tuple[dict[str, Any], "Record"]) -> None:
+        row, record = data
         proxy_man = self._get_proxy_man()
-        rows = Servers.parse_json([record])
+        rows = Servers.parse_json([row])
         try:
             proxy_man.append_row_to_history(rows[0])
+            self.update_history()
         except Exception:
             self.update_history(rows)
-            return
-        self.update_history()
+
+        fqip = Servers.record_to_fqip(record)
+        config_man = self.controller.get_config_man()
+        config_man.update_history_file(fqip)
 
     def remove_from_history(self, record: Servers.Record) -> None:
         proxy_man = self._get_proxy_man()
         proxy_man.remove_row_from_control(record)
         self.update_history()
 
-    def add_by_str(self, addr: str) -> None:
-        if addr.isdigit():
-            self.add_by_id(addr)
-        else:
-            self.add_by_ip(addr)
-
     @call_on_thread(dialog.querying)
     def update_playercount(
         self, treeiter: Gtk.TreeIter, record: Servers.Record
@@ -318,6 +316,7 @@ class ServerModelManager:
                 self.thread_man.set_cleanup_func(func)
                 return
             config_man.add_saved_server(fqip)
+
             # FIXME: this is valid if saved servers tab is already open,
             # but not if app was just booted; causes single row to appear prematurely
             if proxy_man.has_control_model() is False:
@@ -368,33 +367,47 @@ class ServerModelManager:
         proxy = self._get_proxy_man().get_proxy_model()
         self.tv.set_model(proxy)
 
-        self.emitter.emit("servers_loaded", self.enum)
+        if self.controller.get_active_treeview().get_enum() == ServerTab.SAVED:
+            self.emitter.emit("servers_loaded", self.enum)
 
         filter_man = self.tv.get_filter_man()
         # NOTE: maps are set outside of thread because it triggers map changed signals
         maps = self._get_new_maps()
         filter_man.set_unique_maps(maps)
+        store = filter_man.get_map_store()
+        self.emitter.emit("load_maps", store)
 
         self.first_iteration = False
-        self.emitter.emit("servers_loaded_init")
         self.emitter.emit("saved_servers_changed")
 
     def _update_maps(self) -> None:
         filter_man = self.tv.get_filter_man()
         filter_man.set_unique_maps(self._get_new_maps())
-        self.emitter.emit("servers_loaded_init")
+        store = filter_man.get_map_store()
+        self.emitter.emit("load_maps", store)
         self.first_iteration = False
 
     def _cleanup_on_success(self) -> None:
-        proxy = self._get_proxy_man().get_proxy_model()
+        proxy = self.proxy_man.get_proxy_model()
         self.tv.set_model(proxy)
+        if self.preserve_on_fail is True:
+            self.proxy_man.wipe_cache()
 
-        # TODO: servers_loaded vs servers_reloaded
         self.emitter.emit("servers_loaded", self.enum)
-
         if self.first_iteration:
             self._update_maps()
 
+    def _cleanup_on_lan_failure(self, show_dialog: bool = True) -> None:
+        if self.preserve_on_fail is False:
+            self.tv.set_model(None)
+            filter_man = self.tv.get_filter_man()
+            filter_man.set_unique_maps([])
+
+        if show_dialog:
+            dialog = ExceptionDialog(self.controller, dialogs.load_error_lan)
+            dialog.show_all()
+            dialog.run()
+
     def _cleanup_on_failure(self, show_dialog: bool = True) -> None:
         # TODO: disable map, keyword, and filter widgets if model is None
         # signal driven (servers_empty, servers_failed_to_load)
@@ -407,7 +420,9 @@ class ServerModelManager:
         # TODO: distinguish signals, e.g. "servers_failed_to_load", "servers_loaded_empty"
         # customize statusbar and dialog accordingly
         if show_dialog:
-            dialog = ExceptionDialog(self.controller, api_warn_msg)
+            dialog = ExceptionDialog(self.controller, server_timeout)
+            dialog.set_details_buffer(kb.DZG_006)
+            dialog.show_all()
             dialog.run()
 
     def _push_data(self, data: list[Any]) -> None:

dzgui/strings/changelog.py

@@ -0,0 +1,2 @@
+collapse_all = "Collapse all"
+expand_all = "Expand all"

dzgui/strings/connect_panel.py

@@ -4,11 +4,7 @@ add_popover = "This address is already in your Saved Servers"
 add_tooltip="Add to Saved Servers"
 connect_button="Connect"
 connect_tooltip="Connect to this server"
-connect_entry_tooltip=(
-    "- IP: format as IP:Query port\ne.g. 192.168.1.1:27016\n"
-    "- Battlemetrics: numeric server ID\ne.g. 123456"
-)
-connect_entry_placeholder="Enter IP (IP:Query port) or Battlemetrics ID (numerical id)"
+connect_entry_placeholder="Enter IP:Query port (e.g., 192.168.1.1:27016)"
 
 fav_heading="Favorite server"
 favs_empty="None set. Right click a server and select 'Set favorite' to set."
@@ -19,6 +15,6 @@ lan_custom_button="Custom port"
 lan_scan_button="Scan"
 lan_abort_tooltip = "Unless you have multiple DayZ servers on your LAN,\nleave this checked to get results faster"
 lan_checkbox = "Stop scanning on first hit"
-lan_placeholder="Enter the query port (1-65535)"
+lan_entry_placeholder="Enter the query port (1-65535)"
 lan_entry_tooltip="Specify the port to search for DayZ servers on the local network"
 lan_scan_tooltip="Scan for servers"

dzgui/strings/dialogs.py

@@ -1,6 +1,25 @@
 waiting_for_launch = "Waiting for DayZ to launch"
-waiting_for_mods = "Waiting for Steam to update mods"
+waiting_for_mods = "Queueing up mods (step 1/2)"
+waiting_for_directories = "Steam is staging mods (step 2/2)"
 
 fetching_update = "Fetching update"
 failed_to_update = "Failed to update DZGUI executable"
 update_success = "Updated successfully. Please exit and relaunch."
+
+load_error_lan = "Failed to find any servers on your network.\nCheck the server query port or your firewall settings."
+fetching_mods = "Fetching mod metadata"
+deleting_mods = "Unsubscribing mods"
+scanning_mods = "Scanning mods"
+parsing_mods = "Parsing mods"
+
+checking_api = "Checking API key"
+
+running = "Running"
+failed = "FAILED"
+ok = "OK"
+
+mission_dialog = "Set a mission folder location"
+custom_mod_dialog = "Set location to a custom mods folder"
+
+debug_heading = "Debug"
+debug_secondary = "Launch arguments"

dzgui/strings/errors.py

@@ -3,3 +3,4 @@ api_validation_error = (
 )
 
 api_popover = "API key validation failed."
+dayz_not_found = "Could not find a valid DayZ installation."

dzgui/strings/generic.py

@@ -0,0 +1 @@
+selectable_tree = "Ctrl-click to select multiple; Shift-click to select a range."

dzgui/strings/kb.py

@@ -0,0 +1,13 @@
+DZG_006 = """The leading cause of specific servers periodically timing out is local network configuration.
+
+Many third-party DayZ servers use a server rental/hosting provider with DDoS protection.
+
+This can cause responses from servers to originate from a server other than the one originally queried.
+
+Consumer-grade routers are likely to drop this traffic as invalid due to how they handle NAT (network address translation).
+
+By contrast, wireless routers and enterprise-grade routers may be less likely to have this issue.
+
+If you find that a specific server is unresponsive for you when it shouldn't be, add a port forwarding rule to your router's settings for the server's query port.
+
+In addition, a uniform packet size is expected. If your router's MTU (maximum transmission unit) setting differs from the default of 1500, it could lead to incoming responses being discarded."""

dzgui/strings/map_count.py

@@ -0,0 +1,16 @@
+exit_msg = (
+    "System map count is not high enough to run DayZ. "
+    "Please exit and run 'dzgui -m' to update map count."
+)
+failed_to_parse = (
+    "Failed to parse system map count.\n"
+    "This usually indicates that systemd is not installed."
+)
+failed_to_update = (
+    "Failed to update system map count.\n"
+    "Please report the issue upstream and provide the following traceback.\n\n"
+    "{0}"
+)
+meets_minimum = "System map count of {0} already meets the minimum."
+prompt = "Updated map count will be written to the file {0}."
+user_exit = "User exit"

dzgui/strings/offline.py

@@ -0,0 +1,25 @@
+heading = "Play offline"
+heading_disclaimer = (
+    "Not all mod combinations will function offline. Use at your own discretion."
+)
+
+mission_button = "Select mission folder"
+mission_frame = "Mission"
+
+version = "DayZ Version"
+
+custom_frame = "Custom mods"
+custom_button = "Set custom mod folder"
+
+local_frame = "Installed mods"
+
+no_local_mods = "No local mods found"
+no_mods = "No valid mods found"
+no_mission = "Not a valid mission"
+folder_changed = "Folder missing or changed on disk"
+
+custom_eventbox = "Set the root folder. Mods must be in atomic folders and have a meta.cpp file at a minimum."
+mission_eventbox = "Select a single mission folder containing an init.c file."
+
+folder_prefix = "<b>Current folder: </b>"
+unset_button = "Unset folder"

dzgui/strings/options.py

@@ -1,12 +1,19 @@
 developers = "Developers"
 start_tab = "Start tab"
 workshop_label = "Subscribed mods"
-workshop_eventbox = "If you manually subscribed to mods on Steam prior to using DZGUI, you can unsubscribe via this link."
 steam_combo = "Steam"
 flatpak_combo = "Flatpak"
 flatpak_container_combo = "Flatpak (container)"
 
+steam_placeholder = "Enter your Steam API key"
+name_placeholder = "Identifies you to other players"
+
 server_combo = "Server browser"
 saved_combo = "Saved servers"
 recent_combo = "Recent"
 lan_combo = "LAN"
+
+fullscreen_eventbox = "This option is not available on Steam Deck."
+save_button = "Save"
+
+api_failed = "API validation failed"

dzgui/strings/preboot.py

@@ -0,0 +1,6 @@
+symlinks = "Rebuilding symlinks"
+signatures = "Updating mod signatures"
+geo = "Checking geolocation records"
+coords = "Checking local coordinates"
+updates = "Checking for updates"
+dayz = "Looking for DayZ"

dzgui/strings/preconnect.py

@@ -1,11 +1,50 @@
 update_mods = "Update mods and connect"
 connect = "Connect"
+connect_last = "Load to menu screen"
+connect_last_tooltip = "Launch DayZ with these mods (if any) and\ngo to the menu screen without connecting."
+debug = "Debug"
 back = "Back"
 cancel = "Cancel"
 warnings = "Warnings"
 errors = "Errors"
 mods = "Mods"
 total_mods = "Total mods: "
+up_to_date = "All mods are up to date."
 all_updated = "All mods updated."
 "If you recently installed {build} or moved it to a different drive, "
 "restart Steam to allow these changes to synchronize, then try again."
+required_space = " Need to download {0} MiB of mod updates."
+
+placeholder_no_mods = "This server has no mods."
+placeholder_no_warnings = "No warnings."
+
+
+# Errors
+invalid_mods = (
+    "Server has invalid mods that are not recognized by Steam.\n"
+    "Contact the server owner and include these mod IDs in your report:\n"
+    "{0}"
+)
+not_enough_space = (
+    "Need to update {0} MiB of mods, but installation path only has {1} MiB."
+)
+resync = (
+    "If you recently installed {0} or moved it to a different drive,\n"
+    "restart Steam to allow these changes to synchronize, then try again."
+)
+steam_not_running = "'{0}' is set as the default Steam client, but it is either not installed or not running."
+use_desktop_mode = "Use Desktop Mode to download mods on Steam Deck."
+version_mismatch = "Local client version '{0}' does not match remote version '{1}'."
+version_missing = "Remote server is running the build '{0}', but it is not installed."
+
+
+# Warnings
+protected_server = (
+    "Protected: you will be prompted for a password when connecting to this server."
+)
+dayz_running = "It looks like DayZ is already running in the background. Exit DayZ before connecting."
+running_app = (
+    "The app '{0}' is currently running in Steam, but background downloads are not enabled.\n"
+    "Either stop the game first, or update your global Steam settings or the game's local settings.\n"
+    "Otherwise, mods may be queued for download but never update."
+)

dzgui/strings/uninstall.py

@@ -0,0 +1,38 @@
+pg1_title = "Choose uninstall targets"
+pg1_heading = "Choose uninstall targets"
+pg1_blurb = "Here you can choose which DZGUI configuration/state files to remove. "
+
+pg2_title = "Uninstall complete"
+pg2_heading = "Uninstall complete"
+pg2_blurb = "Finished removing the selected files. See the console for any errors."
+
+config_label = "Configuration files"
+config_details = (
+    "User preferences and API key. "
+    "Keep this file if you want to import it again later."
+)
+desktop_label = "Desktop shortcut"
+desktop_details = "Shortcut set on the desktop, if applicable."
+
+start_menu_label = "Start menu shortcut"
+start_menu_details = (
+    "Shortcut set under the Games category of the start menu, if applicable."
+)
+state_label = "Long-term state files"
+state_details = (
+    "UI size, filter preferences, column size, server notes, and mod signatures."
+)
+steam_shortcut = "Steam shortcut"
+steam_details = "Shortcut to DZGUI installed within Steam, if applicable. Requires Steam to be restarted to reflect the change."
+
+
+path_remove_prefix = "The following path will be removed:"
+not_installed = "It looks like DZGUI was not previously set up; nothing to uninstall."
+standalone_uninstall = (
+    "It looks like you are running the standalone version of DZGUI.\n"
+    "To finalize the uninstall process, you can remove the 'dzgui' file."
+)
+system_uninstall = (
+    "It looks like DZGUI was installed via your system package manager or directly from source code.\n"
+    "To finalize the uninstall process, follow the standard removal procedure for that context."
+)

dzgui/strings/wizard.py

@@ -46,11 +46,6 @@ You must set up a Steam Web API key in order to browse the global server list.
 \nIf you don't have one already, it can be set up via the page below.
 \nPlease refer to the DZGUI documentation for more instructions.
 """
-heading_bm_api = "Battlemetrics Web API key"
-blurb_bm_api = """A Battlemetrics key is <b>optional</b>, but allows you to add/search for servers\n
-by numeric ID on the web. For example, in the URL https://www.battlemetrics.net/servers/dayz/24819107,\n
-the ID would be <b>24819107</b>.
-"""
 
 ### PreferencesPage
 heading_prefs = "User preferences"
@@ -64,7 +59,26 @@ radio_mi = "mi (miles)"
 label_dist = "Distance display"
 label_client = "Steam client"
 
+### Shortcuts page
+heading_shortcuts = "Create shortcuts"
+blurb_shortcuts = (
+    "You can optionally create shortcuts to facilitate launching DZGUI faster."
+)
+button_shortcuts = "Create shortcuts"
+checkbox_steam_shortcut = (
+    "Add DZGUI to Steam library",
+    (
+        "This creates a standalone copy of DZGUI and adds it to Steam. "
+        "You <b>must restart Steam</b> for the shortcut to appear. This will not replace or update existing shortcuts. "
+        "If you update DZGUI when it is launched via Steam, updates will be applied to the Steam version."
+    ),
+)
+checkbox_start_menu = (
+    "Add a start menu shortcut",
+    "Depends on local window manager settings. Will work on Steam Deck.",
+)
+checkbox_desktop_shortcut = ("Add a desktop shortcut", "Depends on the option above.")
 
 ### Completion page
 heading_completion = "Setup complete"
-blurb_completion = "Configuration completed successfully. Please exit and restart DZGUI to apply changes."
+blurb_completion = "Configuration completed successfully. Click 'Close' to close this dialog and launch DZGUI."

dzgui/util/_json.py

@@ -2,20 +2,19 @@ import json
 from pathlib import Path
 from typing import Any
 
+
 def read_json(path: Path) -> Any:
     try:
         with open(path, "r") as infile:
-            try:
-                data = json.load(infile)
-                return data
-            except json.decoder.JSONDecodeError as e:
-                raise e
-    except OSError as e:
+            data = json.load(infile)
+            return data
+    except Exception as e:
         raise e
 
 
-def write_json(data: dict, path: Path) -> None:
+def write_json(data: dict[str, Any], path: Path) -> None:
     try:
+        path.parent.mkdir(parents=True, exist_ok=True)
         j = json.dumps(data, indent=2)
         path.write_text(j)
     except Exception as e:

dzgui/util/diag.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import platform
 
@@ -9,7 +10,9 @@ from dzgui.const.constants import APP_NAME
 from dzgui.const.enum import Preferences
 from dzgui.config.query import lookup
 from dzgui.init.prefix import get_version
-from dzgui.util.redact import redact
+from dzgui.util.redact import redact_home
+
+logger = logging.getLogger(APP_NAME)
 
 
 def get_cpu_model() -> str:
@@ -38,24 +41,26 @@ def print_mods(mods: list[int]) -> str:
 
 
 def write_diagnostic(config: Path, outfile: Path) -> None:
-    # TODO: test availability on other distros
     date = datetime.now().isoformat()
 
-    distro = platform.freedesktop_os_release()["ID_LIKE"]
+    try:
+        # FIXME: ID_LIKE not available on CachyOS
+        distro = platform.freedesktop_os_release()["ID_LIKE"]
+    except Exception as e:
+        logger.warn(e)
+        distro = "Unknown"
+
     kernel = os.uname().release
     cpu = get_cpu_model()
     version = get_version()
 
-    branch = lookup(config, Preferences.BRANCH)
-    debug = lookup(config, Preferences.DEBUG)
-    install = lookup(config, Preferences.INSTALL)
     default = lookup(config, Preferences.DEFAULT)
 
     steam_path = Path(default)
     workshop_path = get_local_mod_path(steam_path)
 
-    steam_redacted = redact(default)
-    workshop_redacted = redact(str(workshop_path))
+    steam_redacted = redact_home(default)
+    workshop_redacted = redact_home(str(workshop_path))
 
     mods = get_local_mod_ids(steam_path)
     mods_pretty = print_mods(mods)
@@ -65,15 +70,13 @@ def write_diagnostic(config: Path, outfile: Path) -> None:
 
     # FIXME: extraneous newlines in lists of mods
     template = f"""\
-    {APP_NAME} version {version} ({branch})
+    {APP_NAME} version {version}
     Date: {date}
     ===============================
     Distribution: {distro}
     Kernel: {kernel}
     CPU: {cpu}
 
-    Debug: {debug}
-    Auto-install: {install}
     Steam path: {steam_redacted}
     Workshop path: {workshop_redacted}
 

dzgui/util/dirs.py

@@ -0,0 +1,32 @@
+import logging
+import os
+import shutil
+
+from importlib import resources
+from pathlib import Path
+
+from dzgui.const.constants import APP_NAME, APP_NAME_LOWER, IMAGES_PATH
+
+logger = logging.getLogger(APP_NAME)
+
+
+def make_parents(path: "Path") -> None:
+    path.parent.mkdir(parents=True, exist_ok=True)
+
+
+def copy_dzgui_to_xdg_data(exe_path: Path) -> None:
+    dzgui = os.getenv("PYAPP")
+    if dzgui is None:
+        return
+    try:
+        make_parents(exe_path)
+        shutil.copy(dzgui, exe_path)
+    except Exception as e:
+        logger.critical(e)
+
+
+def find_icon_resource() -> "Path":
+    traversable = resources.files(APP_NAME_LOWER).joinpath(IMAGES_PATH)
+    images = Path(str(traversable))
+    icon = images.joinpath("icon.png")
+    return icon

dzgui/util/dist.py

@@ -84,6 +84,5 @@ class CalcDist:
         except Exception:
             return None
 
-        # TODO: handle failed remote dist
         haversine = Haversine(local.lat, local.lon, remote.lat, remote.lon)
         return haversine

dzgui/util/file.py

@@ -0,0 +1,15 @@
+from datetime import datetime
+from pathlib import Path
+
+
+def is_writeable(path: "Path") -> bool:
+    now = int(datetime.now().timestamp())
+    suffix = ".dzgtmp"
+    file = str(now) + suffix
+    filepath = Path(str(path) + "_" + file)
+    try:
+        filepath.touch()
+        filepath.unlink()
+        return True
+    except OSError:
+        return False

dzgui/util/format.py

@@ -1,6 +1,7 @@
 import re
 
 from dzgui.util.localize import number
+from dzgui.strings.generic import selectable_tree
 from dzgui.util.strings import no_mods, no_servers, workshop
 
 import gi
@@ -46,8 +47,7 @@ def format_mods(size: int, mods: int) -> str:
         return no_mods
     l_size = number(size)
     plural = pluralize("mods", mods)
-    # TODO: strings
-    suffix = "Ctrl-click to select multiple; Shift-click to select a range."
+    suffix = selectable_tree
     return f"Found {mods:n} {plural} taking up {l_size} MiB. {suffix}"
 
 
@@ -83,3 +83,7 @@ def format_player_count(model: Gtk.TreeModel | None, control: list) -> str:
 
 def embolden(text: str) -> str:
     return f"<b>{text}</b>"
+
+
+def format_exception(e: Exception) -> str:
+    return f"{type(e).__name__}: {e}"

dzgui/util/ip.py

@@ -2,14 +2,13 @@ import a2s
 import requests
 import shutil
 import subprocess
-from warnings import deprecated
 
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
 from dzgui.api.servers import Record
 from dzgui.const.constants import REQUEST_TIMEOUT
-from dzgui.const.endpoints import COORDS_API, IP_ECHO
+from dzgui.const.endpoints import IP_ECHO
 
 
 if TYPE_CHECKING:
@@ -127,10 +126,3 @@ def is_valid_port(port: str) -> bool:
     if not port.isdigit() or int(port) == 0 or int(port[0]) == 0 or int(port) > 65535:
         return True
     return False
-
-
-@deprecated("use ips.csv")
-def get_local_coords(ip: str) -> str:
-    url = COORDS_API + "/" + ip
-    # local res=$(curl -Ls "$url" | jq -r '"\(.lat)\n\(.lon)"')
-    return url

dzgui/util/map_count.py

@@ -1,28 +1,71 @@
+import logging
 import subprocess
+import sys
+import tempfile
+import traceback
 
 from pathlib import Path
-from dzgui.const.constants import VM_FILE, MIN_COUNT
+from dzgui.const.constants import APP_NAME, VM_FILE, MIN_COUNT
+from dzgui.util.bash import concat_bash_args
+from dzgui.strings import map_count
+from dzgui.views.dialogs.early_alert import EarlyIgnoreDialog
+
+logger = logging.getLogger(APP_NAME)
+
+
+def is_map_count_valid(count: int | None) -> bool:
+    if count is None:
+        # NOTE: permit if count was unreadable
+        return True
+    return count >= MIN_COUNT
+
 
 def get_map_count() -> int | None:
     path = Path(VM_FILE)
-    if path.is_file() is False:
+    try:
+        count = int(path.read_text())
+    except Exception as e:
+        logger.debug(e)
         return None
-    count = int(path.read_text())
     return count
 
-    # TODO: unfinished
-    #if count < MIN_COUNT:
-    #    print("needs sudo escalation")
-    #    # pop prompt
-    #    # get response
-    #    set_map_count()
-    #return count
 
-# TODO: unfinished
+def test_map_count() -> None:
+    count = get_map_count()
+    if is_map_count_valid(count):
+        return
+    msg = map_count.exit_msg
+    EarlyIgnoreDialog(msg)
+
+
 def set_map_count() -> None:
+    count = get_map_count()
+    if count is None:
+        print(map_count.failed_to_parse)
+        return
+    if is_map_count_valid(count):
+        msg = map_count.meets_minimum.format(count)
+        print(msg)
+        return
+
     conf = "/etc/sysctl.d/dayz.conf"
-    count = f"vm.max_map_count={MIN_COUNT}"
-    with open(conf, "w") as f:
-        f.write(count)
-    # TODO: use concat_bash_args()
-    subprocess.run(["/usr/bin/sudo", "sysctl", "-p", conf])
+    value = f"vm.max_map_count={MIN_COUNT}"
+    try:
+        msg = map_count.prompt.format(conf)
+        print(msg)
+        with tempfile.NamedTemporaryFile(delete=False) as f:
+            tmp = f.name
+        Path(tmp).write_text(value)
+
+        mv_cmd = f"sudo mv {tmp} {conf}"
+        reload_cmd = f"sudo sysctl -p {conf}"
+        for cmd in mv_cmd, reload_cmd:
+            args = concat_bash_args(cmd)
+            subprocess.run([*args])
+    except Exception as e:
+        logger.debug(e)
+        trace = traceback.format_exc()
+        print(map_count.failed_to_update.format(trace))
+    except KeyboardInterrupt:
+        print(map_count.user_exit)
+        sys.exit(0)

dzgui/util/redact.py

@@ -1,20 +1,30 @@
+import logging
 import re
+from typing import Literal
 
-def redact(text: str) -> str:
-    r = r"(/home/)([^/])*"
-    cleaned = re.sub(r, r"/home/REDACTED", text)
+api_filter = r"(.*&key=)([^&]*)(.*)"
+home_filter = r"(/home/)([^\s'\/]*)(.*)"
+user_filter = r"(.*Steam/userdata/)([^/]*)(.*)"
+REDACTED = r"\1REDACTED\3"
+REDACTION_PATTERNS = [api_filter, home_filter, user_filter]
+
+
+def redact_home(text: str) -> str:
+    pat = re.compile(home_filter)
+    cleaned = pat.sub(REDACTED, text)
     return cleaned
 
-def redact_log(record: list) -> list[str]:
-    """
-    requests library includes Steam API key in URL params
-    """
-    clean = []
-    for item in record:
-        if "&key=" in item:
-            pat = r"(.*&key=)(\S+)(.*)"
-            scrubbed = re.sub(pat, r"\1REDACTED\3", item)
-            clean.append(scrubbed)
-        else:
-            clean.append(item)
-    return clean
+
+class RedactionFilter(logging.Filter):
+    def __init__(self, patterns: list[str] | None = None) -> None:
+        super().__init__()
+        self._patterns = [re.compile(pat) for pat in (patterns or [])]
+
+    def filter(self, record: logging.LogRecord) -> Literal[True]:
+        for pattern in self._patterns:
+            try:
+                record.msg = pattern.sub(REDACTED, record.msg)
+            except TypeError:
+                exception_text = f"{type(record.msg).__name__}: {record.msg}"
+                record.msg = pattern.sub(REDACTED, exception_text)
+        return True

dzgui/util/strings.py

@@ -1,27 +1,6 @@
 from dataclasses import dataclass
 from dzgui.const.constants import SYSTEM_LOG
 
-# TODO: move to util.format.py
-
-
-def build_missing(build: str) -> str:
-    msg = (
-        f"This server is running {build}. You can install "
-        f"{build} by searching for it in your Steam library. "
-        f"If you recently installed {build} or moved it to a different drive, "
-        "restart Steam to allow these changes to synchronize, then try again."
-    )
-    return msg
-
-
-def build_path_invalid(build: str) -> str:
-    msg = (
-        f"Steam is reporting that {build} is installed at a non-existent location. "
-        f"If you recently installed {build} or moved it to a different drive, "
-        "restart Steam to allow these changes to synchronize, then try again."
-    )
-    return msg
-
 
 # General
 dialog_header = "DZGUI - Dialog"
@@ -52,7 +31,7 @@ show_mods = "Show server-side mods"
 show_details = "Show server details"
 refresh_players = "Refresh player count"
 open_workshop = "Open in Steam Workshop"
-delete_mod = "Delete mod"
+unsub_mod = "Unsubscribe mod"
 copy_name = "Copy name to clipboard"
 copy_ip = "Copy IP to clipboard"
 copy_log = "Copy record(s) to clipboard"
@@ -64,7 +43,7 @@ connect = "Connect"
 
 # Columns
 server_mod_cols = ["Mod", "ID", "Installed"]
-mod_cols = ["Mod", "Symlink", "Dir", "Size (MiB)", "Color"]
+mod_cols = ["Mod", "Symlink", "ID", "Size (MiB)", "Color"]
 log_cols = ["Timestamp", "Flag", "Traceback", "Message"]
 browser_cols = [
     "Name",
@@ -100,10 +79,7 @@ steam_missing = "Local Steam installation is not set, possibly malformed config
 build_corrupted = (
     "Steam settings or DayZ installation may be corrupted. Try restarting Steam."
 )
-api_warn_msg = """No servers returned. Please wait and try again.
-If this issue persists, your API key may be defunct or your network is blocking requests.
-"""
-server_timeout = "Timed out when querying server, check IP or try again later."
+server_timeout = "Timed out when querying server(s). Check IP or try again later."
 server_error = (
     "Error while contacting server, possibly timed out. Please wait and try again."
 )
@@ -130,7 +106,6 @@ servers = {
     "Enter/space/double-click": "connect to server",
     "Right-click/Ctrl-l": "additional context menus",
     "Ctrl-r": "refresh players",
-    "Ctrl-p": "refresh ping",
     "Ctrl-f": "jump to keyword search field",
     "Ctrl-m": "jump to maps field",
     "Ctrl-d": "select default LAN port",
@@ -148,8 +123,8 @@ servers = {
 vim = {
     "j": "Move down a row/scroll up",
     "k": "Move up a row/scroll down",
-    "l": "Jump to main area from sidebar",
-    "h": "Jump to sidebar from main area",
+    "h": "Jump to main area from sidebar",
+    "l": "Jump to sidebar from main area",
     "g": "Jump to first row/top of page",
     "G": "Jump to last row/bottom of page",
 }
@@ -181,7 +156,7 @@ filter_lowpop = "Low pop"
 filter_nonascii = "Non-ASCII"
 filter_duplicate = "Duplicate"
 filter_official = "Official"
-filter_unofficial = "Unoffic."
+filter_unofficial = "Unofficial"
 filter_modded = "Modded"
 
 # maps
@@ -193,11 +168,12 @@ none_provided = "None provided"
 disabled = "Disabled"
 enabled = "Enabled"
 null = "-"
-none = "None"
 unspecified = "not specified"
 
 # DLC
 dlc_frostline = "Frostline"
+dlc_badlands = "Badlands"
+dlc_none = "None"
 
 # platform
 windows = "Windows"
@@ -215,8 +191,8 @@ class ModPanelStrings:
     unhighlight_stale_tooltip: str
     highlight_stale: str
     highlight_stale_tooltip: str
-    delete_selected: str
-    delete_selected_tooltip: str
+    unsub_selected: str
+    unsub_selected_tooltip: str
     unselect_all: str
     unselect_all_tooltip: str
     select_all: str
@@ -273,6 +249,7 @@ class Crumbs:
     thanks: str
     developers: str
     default: str
+    offline: str
 
 
 @dataclass(slots=True, frozen=True)
@@ -286,11 +263,8 @@ class Thanks:
 class Options:
     header: str
     steam_web: str
-    bm_web: str
     enter_steam: str
-    enter_bm: str
     steam_placeholder: str
-    bm_placeholder: str
     name_placeholder: str
     last_used: str
     always_fs: str
@@ -311,7 +285,7 @@ class Options:
     force_eventbox: str
     self_update: str
     no_self_update: str
-    api_keys: str
+    api_key: str
     prefs: str
     mods: str
     version: str
@@ -333,11 +307,11 @@ mod_panel = ModPanelStrings(
     unhighlight_stale_tooltip="Clears highlight from stale mods",
     highlight_stale="Highlight stale",
     highlight_stale_tooltip=(
-        "Shows locally-installed mods which are not used by any server "
-        "in your Saved Servers"
+        "Shows locally-installed mods which are not \n"
+        "used by any server in your Saved Servers"
     ),
-    delete_selected="Delete selected",
-    delete_selected_tooltip="Deletes selected mods from the system",
+    unsub_selected="Unsubscribe selected",
+    unsub_selected_tooltip="Unsubscribes from selected mods",
     unselect_all="Unselect all",
     unselect_all_tooltip="Bulk unselects all mods",
     select_all="Select all",
@@ -360,12 +334,15 @@ thanks = Thanks(
         "bongjutsu",
         "Deku",
         "dj3hac",
+        "finntux",
         "GaryBlackbourne",
         "jiriks74",
         "Johnofwrong",
         "MatheusLasserr",
         "nolan-perez",
+        "OnniSaarni",
         "scandalouss",
+        "SnackSBR",
         "StevelDusa",
         "Thoughtduck216",
     ],
@@ -375,11 +352,8 @@ thanks = Thanks(
 options = Options(
     header="Options",
     steam_web="Steam API page",
-    bm_web="Battlemetrics API page",
     enter_steam="Enter your Steam API key",
-    enter_bm="Enter your Battlemetrics API key",
     steam_placeholder="Steam API key",
-    bm_placeholder="Battlemetrics API key",
     name_placeholder="Identifies you to other players in-game",
     last_used="Last used dimensions",
     always_fs="Always fullscreen",
@@ -408,7 +382,7 @@ options = Options(
         "In-app updates are disabled when DZGUI is "
         "installed globally (e.g., via package manager)."
     ),
-    api_keys="API Keys",
+    api_key="API Key",
     prefs="Preferences",
     mods="Mods",
     version="Version",
@@ -460,6 +434,7 @@ crumbs = Crumbs(
     thanks="Help > Special thanks",
     developers="Options > Developers",
     default="Servers > ",
+    offline="Mods > Play offline",
 )
 
 no_mods = "No local mods found."
@@ -472,13 +447,15 @@ class Flags:
     version: str
     uninstall: str
     debug: str
+    map_count: str
 
 
 flags = Flags(
     description="DayZ server browser and mod manager",
-    version="Print version information",
-    uninstall="Uninstall data files (use prior to 'pip uninstall')",
-    debug="Enables developer debugging features",
+    version="print version information",
+    uninstall="clean up state/config files",
+    debug="enable developer debugging features",
+    map_count="check and update system map count value",
 )
 
 
@@ -530,64 +507,6 @@ server_labels = ServerLabels(
 )
 
 
-@dataclass(slots=True, frozen=True)
-class ConnectPanel:
-    connect: str
-    add: str
-    add_con: str
-    placeholder: str
-    entry_tooltip: str
-    add_tooltip: str
-    connect_tooltip: str
-
-
-connect_panel = ConnectPanel(
-    connect="Connect",
-    add="Add",
-    add_con="Add/connect",
-    placeholder="Enter IP (IP:Query port) or Battlemetrics ID (numerical id)",
-    entry_tooltip=(
-        "- IP: format as IP:Query port\ne.g. 192.168.1.1:27016\n"
-        "- Battlemetrics: numeric server ID\ne.g. 123456"
-    ),
-    add_tooltip="Add to Saved Servers",
-    connect_tooltip="Connect to this server",
-)
-
-
-@dataclass(slots=True, frozen=True)
-class FavPanel:
-    heading: str
-    no_fav: str
-
-
-fav_panel = FavPanel(
-    heading="Favorite server",
-    no_fav="None set. Right click a server and select 'Set favorite' to set.",
-)
-
-
-@dataclass(slots=True, frozen=True)
-class LanPanel:
-    heading: str
-    default_button: str
-    custom_button: str
-    scan_button: str
-    placeholder: str
-    entry_tooltip: str
-    scan_tooltip: str
-
-
-lan_panel = LanPanel(
-    heading="LAN query port",
-    default_button="Default port (27016)",
-    custom_button="Custom port",
-    scan_button="Scan",
-    placeholder="Enter the query port (1-65535)",
-    entry_tooltip="Specify the port to search for DayZ servers on the local network",
-    scan_tooltip="Scan for servers",
-)
-
 distance_suffix = "Distance: calculating..."
 dialog_error = "ERROR"
 
@@ -609,6 +528,7 @@ atomic_buttons = AtomicButton(
     keys_tooltip="Toggles the keybindings dialog",
 )
 
+gtk_theme_missing = "No GTK theme provided"
 steam_icon_missing = "Steam icon not found in IconTheme"
 
 missing_changelog = "Error: failed to read changelog"

dzgui/util/symlink.py

@@ -2,7 +2,7 @@ import logging
 from pathlib import Path
 
 from dzgui.api.mods import get_local_mod_path, get_local_mod_ids, _hash
-from dzgui.const.constants import APPID_DAYZ, APPID_DAYZ_EXP, APP_NAME
+from dzgui.const.constants import APPID_DAYZ, APPID_DAYZ_EXP, APP_NAME, DAYZ_COMMUNITY_ROOT
 from dzgui.const.enum import Preferences
 from dzgui.config.query import lookup
 
@@ -11,14 +11,23 @@ import dzgui.api.pefile as PeFile
 logger = logging.getLogger(APP_NAME)
 
 
+def expunge_link(file: Path) -> None:
+    if not file.is_symlink():
+        return
+    # NOTE: unlink stale symlinks
+    if file.exists() is False:
+        file.unlink()
+    if str(file.stem)[:2] == "@C":
+        file.unlink()
+
 def rebuild_symlinks(config: Path) -> None:
+    # TODO: pass direct path as argument
     path = lookup(config, Preferences.DEFAULT)
     steam_path = Path(path)
     dayz_path = PeFile.get_nested_app_path(steam_path, APPID_DAYZ)
-    # NOTE: unlink stale symlinks
     for file in dayz_path.iterdir():
-        if file.is_symlink() and file.exists() is False:
-            file.unlink()
+        expunge_link(file)
+
     workshop = get_local_mod_path(steam_path)
     # NOTE: create symlinks for missing mods
     for mod_id in get_local_mod_ids(steam_path):
@@ -30,6 +39,37 @@ def rebuild_symlinks(config: Path) -> None:
     clone_symlinks(steam_path)
 
 
+def create_custom_symlinks(
+    steam_path: Path, custom_dir: Path, uids: list[str]
+) -> list[str]:
+    dayz_path = PeFile.get_nested_app_path(steam_path, APPID_DAYZ)
+    links = []
+    for uid in uids:
+        md5sum = _hash(uid, use_custom=True)
+        source = dayz_path.joinpath(md5sum)
+        target = custom_dir.joinpath(uid)
+        links.append(md5sum)
+        if source.exists() is False:
+            source.symlink_to(target)
+    clone_symlinks(steam_path)
+    return links
+
+
+def symlink_mission(steam_path: Path, target: str) -> str:
+    dayz_path = PeFile.get_nested_app_path(steam_path, APPID_DAYZ)
+    for file in dayz_path.iterdir():
+        expunge_link(file)
+    path = Path(target)
+    stem = path.name
+    parent = path.parent
+    source = dayz_path.joinpath(DAYZ_COMMUNITY_ROOT)
+    try:
+        source.symlink_to(parent)
+    except Exception:
+        return ""
+    return f"{DAYZ_COMMUNITY_ROOT}/{stem}"
+
+
 def clone_symlinks(steam_path: Path) -> None:
     """
     Shares symlinks between builds. Used after any symlink operation
@@ -43,11 +83,14 @@ def clone_symlinks(steam_path: Path) -> None:
 
     # TODO: test these two operations
     # use less time intensive logic like the above
-    for file in exp_path.iterdir():
-        if file.is_symlink():
-            file.unlink()
+    try:
+        for file in exp_path.iterdir():
+            if file.is_symlink():
+                file.unlink()
 
-    for file in dayz_path.iterdir():
-        if file.is_symlink():
-            uid = file.name
-            Path(exp_path / uid).symlink_to(dayz_path / uid)
+        for file in dayz_path.iterdir():
+            if file.is_symlink():
+                uid = file.name
+                Path(exp_path / uid).symlink_to(dayz_path / uid)
+    except Exception as e:
+        logger.critical(e)

dzgui/views/base.py

@@ -2,9 +2,14 @@ import logging
 import signal
 import warnings
 
-from typing import TYPE_CHECKING, Literal
+from typing import TYPE_CHECKING, Literal, Self
 
-from dzgui.const.constants import APP_NAME, APP_NAME_LOWER, STEAM_ICON
+from dzgui.const.constants import (
+    APP_NAME,
+    APP_NAME_LOWER,
+    GTK_APP_ID,
+    STEAM_ICON,
+)
 from dzgui.const.enum import NotebookPage
 from dzgui.controllers.emitter import Emitter
 from dzgui.controllers.mc import Controller
@@ -14,6 +19,7 @@ from dzgui.views.components.connect_panel import ConnectPanel
 from dzgui.views.components.crumbs import Breadcrumbs
 from dzgui.views.components.right_panel import RightPanel
 from dzgui.views.components.statusbar import Statusbar
+from dzgui.views.mixins.colorscheme import ColorAwareApp
 from dzgui.views.mixins.scrollable_mixin import ScrollableMixin
 
 # TODO: import notebook only and add components there?
@@ -23,6 +29,8 @@ from dzgui.views.pages.help import Help
 from dzgui.views.pages.keys import Keybindings
 from dzgui.views.pages.log import Log
 from dzgui.views.pages.mods import Mods
+
+from dzgui.views.pages.offline import OfflineLoader
 from dzgui.views.pages.options import Options
 from dzgui.views.pages.preconnect import PreConnectionAssistant
 from dzgui.views.pages.servers import ServerNotebook
@@ -44,15 +52,20 @@ logger = logging.getLogger(APP_NAME)
 warnings.filterwarnings("ignore", ".*g_value_get_int", Warning)
 
 
-class OuterWindow(Gtk.Window):
-    def __init__(self) -> None:
-        super().__init__(title=APP_NAME, border_width=10, icon_name=APP_NAME_LOWER)
+class OuterWindow(Gtk.ApplicationWindow):
+    def __init__(self, app: Gtk.Application) -> None:
+        super().__init__(
+            application=app, title=APP_NAME, border_width=10, icon_name=APP_NAME_LOWER
+        )
 
         self.hb = AppHeaderBar()
         MainController.register_widget("window", self)
 
         # NOTE: steam deck taskbar may occlude elements
-        if MainController.get_prefs().is_steam_deck is False:
+        is_deck = MainController.get_prefs().is_steam_deck
+        if is_deck:
+            self.maximize()
+        else:
             self.set_titlebar(self.hb)
 
         self.connect("delete-event", self._on_delete_event)
@@ -64,11 +77,10 @@ class OuterWindow(Gtk.Window):
         self.show_all()
         css.load_css()
 
-        MainController.open_page(NotebookPage.SERVERS)
         MainController.set_start_tab()
+        MainController.open_page(NotebookPage.SERVERS)
         self.grid.hide_widgets_on_init()
 
-        # TODO: POC, trigger page change here
         MainController.loaded = True
         MainController.populate_model(MainController.get_active_treeview())
 
@@ -110,8 +122,11 @@ class Notebook(ScrollableMixin, Gtk.Notebook):  # type: ignore
 
         self.connection = PreConnectionAssistant(MainController)
 
+        self.offline = OfflineLoader(MainController)
+
         self.pages = {
             self.help: NotebookPage.HELP,
+            self.offline: NotebookPage.OFFLINE,
             self.clog: NotebookPage.CHANGELOG,
             self.keys: NotebookPage.KEYS,
             self.settings: NotebookPage.OPTIONS,
@@ -262,8 +277,8 @@ class Grid(Gtk.Grid):
 
         self.emitter.connect("server_page_toggled", self.toggle_filter_panels)
 
+    # TODO: drop, use map/signal
     def hide_widgets_on_init(self) -> None:
-        self.conpan.set_lan_visible(False)
         self.right_panel.sel_panel.hide()
 
     def toggle_filter_panels(self, emitter: "Emitter", state: bool) -> None:
@@ -272,13 +287,18 @@ class Grid(Gtk.Grid):
         self.right_panel.refresh_button.set_visible(state)
 
 
-class App(Gtk.Application):
+class App(ColorAwareApp, Gtk.Application):  # type: ignore
     def __init__(self, prefs: "UserPrefs") -> None:
+        super().__init__(application_id=GTK_APP_ID)
 
         GLib.set_prgname(APP_NAME)
         MainController.set_prefs(prefs)
 
-        self.win = OuterWindow()
+        self._setup_signals()
+        self.connect("activate", self._on_activate)
+
+    def _on_activate(self, app: Self) -> None:
+        self.win = OuterWindow(app)
 
         accel = Gtk.AccelGroup()
         accel.connect(
@@ -289,9 +309,6 @@ class App(Gtk.Application):
         )
         self.win.add_accel_group(accel)
 
-        self._setup_signals()
-        Gtk.main()
-
     def _setup_signals(self) -> None:
         SIGNAL_ADD = "signal_add"
         SIGNAL_ADD_FULL = "signal_add_full"
@@ -323,8 +340,12 @@ class App(Gtk.Application):
 
 MainController = Controller()
 
-theme = Gtk.IconTheme.get_default()
-icons = theme.list_icons(None)
-if STEAM_ICON not in icons:
-    logger.warn(strings.steam_icon_missing)
-    warnings.warn(strings.steam_icon_missing, stacklevel=2)
+try:
+    theme = Gtk.IconTheme.get_default()
+    icons = theme.list_icons(None)
+    if STEAM_ICON not in icons:
+        logger.warn(strings.steam_icon_missing)
+        warnings.warn(strings.steam_icon_missing, stacklevel=2)
+except Exception as e:
+    logger.warning(e)
+    warnings.warn(strings.gtk_theme_missing, stacklevel=2)

dzgui/views/components/box.py

@@ -0,0 +1,32 @@
+from typing import Sequence
+
+import gi
+
+gi.require_version("Gtk", "3.0")
+from gi.repository import Gtk  # noqa
+
+
+class GenericBox(Gtk.Box):
+    def __init__(self, orientation: Gtk.Orientation, spacing: int = 0) -> None:
+        super().__init__(orientation=orientation, spacing=spacing)
+
+    def extend(self, els: Sequence[Gtk.Widget]) -> None:
+        for el in els:
+            self.add(el)
+
+
+class HBox(GenericBox):
+    def __init__(self, spacing: int = 0) -> None:
+        super().__init__(orientation=Gtk.Orientation.HORIZONTAL, spacing=spacing)
+
+
+class VBox(GenericBox):
+    def __init__(self, spacing: int = 0) -> None:
+        super().__init__(orientation=Gtk.Orientation.VERTICAL, spacing=spacing)
+
+class ShortHBox(HBox):
+    def __init__(self, widget: Gtk.Widget) -> None:
+        super().__init__(spacing=5)
+
+        self.set_halign(Gtk.Align.START)
+        self.pack_start(widget, expand=False, fill=False, padding=0)

dzgui/views/components/buttons.py

@@ -1,4 +1,4 @@
-from typing import Callable, Self, TYPE_CHECKING
+from typing import Callable, Literal, Self, TYPE_CHECKING, Union
 
 from dzgui.util.clip import copy_clipboard
 from dzgui.util.format import pluralize
@@ -6,10 +6,10 @@ from dzgui.strings import buttons
 from dzgui.util.strings import (
     alert_button_tooltip,
     atomic_buttons,
-    connect_panel,
 )
 from dzgui.const.constants import (
     CLIPBOARD,
+    CLOSE,
     INPUT_KEYBOARD,
     LIST_ADD,
     REFRESH_ICON,
@@ -17,6 +17,7 @@ from dzgui.const.constants import (
     WARNING,
     WEB_BROWSER,
 )
+from dzgui.strings import connect_panel
 
 import gi
 
@@ -31,55 +32,108 @@ if TYPE_CHECKING:
 
 
 class Icon(Gtk.Image):
-    def __init__(self, name: str, l_margin: int = 0) -> None:
+    def __init__(self, name: str, margin_start: int = 0, margin_end: int = 0) -> None:
         super().__init__(
             icon_name=name,
             icon_size=Gtk.IconSize.BUTTON,
-            margin_start=l_margin,
+            margin_start=margin_start,
+            margin_end=margin_end,
             ypad=2,
         )
 
 
 class LargeIcon(Gtk.Image):
-    def __init__(self, name: str, l_margin: int = 5) -> None:
+    def __init__(self, name: str, margin_start: int = 5, margin_end: int = 0) -> None:
         super().__init__(
-            icon_name=name, icon_size=Gtk.IconSize.LARGE_TOOLBAR, margin_start=l_margin
+            icon_name=name,
+            icon_size=Gtk.IconSize.LARGE_TOOLBAR,
+            margin_start=margin_start,
+            margin_end=margin_end,
         )
 
 
 class IconButton(Gtk.Button):
-    def __init__(self, icon: str, margin: int = 0) -> None:
+    def __init__(
+        self,
+        icon: str,
+        position: Gtk.PositionType = Gtk.PositionType.RIGHT,
+        margin_start: int = 0,
+        margin_end: int = 0,
+    ) -> None:
         super().__init__()
-        self.icon = Icon(icon, l_margin=margin)
+        self.icon = Icon(icon, margin_start=margin_start, margin_end=margin_end)
         self.set_image(self.icon)
-        self.set_image_position(Gtk.PositionType.RIGHT)
+        self.set_image_position(position)
         self.set_focus_on_click(False)
 
+    def swap_icon(self, icon: str) -> None:
+        start = self.icon.get_margin_start()
+        end = self.icon.get_margin_end()
+        alt_icon = Icon(icon, margin_start=start, margin_end=end)
+        self.set_image(alt_icon)
+
+    def revert_icon(self) -> None:
+        self.set_image(self.icon)
+
 
 class IconTextButton(IconButton):
-    def __init__(self, icon: str, label: str) -> None:
-        super().__init__(icon, margin=5)
+    def __init__(
+        self, icon: str, label: str, position: Gtk.PositionType = Gtk.PositionType.RIGHT
+    ) -> None:
+        match position:
+            case Gtk.PositionType.RIGHT:
+                super().__init__(icon, position, margin_start=5)
+            case Gtk.PositionType.LEFT:
+                super().__init__(icon, position, margin_end=5)
+            case _:
+                raise ValueError("Unsupported position type")
         self.set_label(label)
 
 
 class LargeIconTextButton(IconButton):
-    def __init__(self, icon: str, label: str) -> None:
-        super().__init__(icon)
+    def __init__(
+        self, icon: str, label: str, position: Gtk.PositionType = Gtk.PositionType.RIGHT
+    ) -> None:
+        super().__init__(icon, position)
         self.set_label(label)
         self.set_image(LargeIcon(icon))
 
 
 class ClipboardButton(IconTextButton):
-    def __init__(self, controller: "Controller", func: Callable) -> None:
+    def __init__(self, controller: Union["Controller", None], func: Callable) -> None:
         super().__init__(CLIPBOARD, atomic_buttons.copy)
         self.controller = controller
         self.connect("clicked", self._on_button_clicked, func)
 
-        self.set_tooltip_text("Copy IP to clipboard")
+        # TODO: strings
+        self.set_tooltip_text("Copy to clipboard")
 
     def _on_button_clicked(self, button: Self, func: Callable) -> None:
+        def revert() -> Literal[False]:
+            self.revert_icon()
+            return False
+
+        self.swap_icon("object-select-symbolic")
         data = func()
         copy_clipboard(data)
+        GLib.timeout_add(600, revert)
+
+
+# TODO: determine when controller would be passed to this button or drop
+class CopyIpButton(ClipboardButton):
+    def __init__(self, controller: Union["Controller", None], func: Callable) -> None:
+        super().__init__(controller, func)
+
+        # TODO: strings
+        self.set_tooltip_text("Copy IP to clipboard")
+
+
+class CloseButton(IconTextButton):
+    def __init__(self, label: str) -> None:
+        super().__init__(icon=CLOSE, label=label)
+
+        # TODO: strings
+        self.set_tooltip_text("Unset this server as favorite")
 
 
 class WebButton(IconTextButton):
@@ -94,9 +148,11 @@ class RefreshButton(IconTextButton):
             icon=REFRESH_ICON,
             label=atomic_buttons.refresh,
         )
+
         self.controller = controller
         emitter = self.controller.get_emitter()
         self.loading = False
+        self.is_clicked = False
 
         self.time = 30
 
@@ -110,17 +166,23 @@ class RefreshButton(IconTextButton):
 
     def _on_refresh_clicked(self, button: Self) -> None:
         """Spawned in a thread"""
-        self.loading = True
+        if self.controller.get_active_treeview().is_loaded() is False:
+            return
+        self.is_clicked = True
         self.controller.refresh_tree()
         # TODO: get server tab enum
         # if LAN tab, reload existing entries in place
 
     def start_decrement(self, emitter: "Emitter", tab: "ServerTab") -> None:
+        if self.is_clicked is False:
+            return
         if self.loading:
-            self.set_sensitive(False)
-            self.loading = False
-            self.show_time(True)
-            GLib.timeout_add_seconds(1, self.decrement)
+            return
+        self.set_sensitive(False)
+        self.loading = True
+        self.is_clicked = False
+        self.show_time(True)
+        GLib.timeout_add_seconds(1, self.decrement)
 
     def decrement(self) -> bool:
         self.time -= 1
@@ -128,6 +190,7 @@ class RefreshButton(IconTextButton):
             self.time = 30
             self.show_time(False)
             self.set_sensitive(True)
+            self.loading = False
             return False
         self.show_time(True)
         return True
@@ -158,7 +221,7 @@ class KeysButton(IconTextButton):
 
 class SteamConnectButton(LargeIconTextButton):
     def __init__(self) -> None:
-        super().__init__(icon=STEAM_ICON, label=connect_panel.connect)
+        super().__init__(icon=STEAM_ICON, label=connect_panel.connect_button)
         self.set_tooltip_text(connect_panel.connect_tooltip)
 
 
@@ -172,11 +235,13 @@ class SteamWorkshopButton(SteamTextButton):
     def __init__(self) -> None:
         super().__init__(label=buttons.workshop)
         self.set_tooltip_text(buttons.workshop_tooltip)
+        self.set_margin_top(10)
+        self.set_margin_bottom(10)
 
 
 class AddButton(IconTextButton):
     def __init__(self) -> None:
-        super().__init__(icon=LIST_ADD, label=connect_panel.add)
+        super().__init__(icon=LIST_ADD, label=connect_panel.add_button)
         self.set_tooltip_text(connect_panel.add_tooltip)
 
 
@@ -201,3 +266,38 @@ class LoggerAlertsButton(IconTextButton):
         self.set_halign(Gtk.Align.END)
         self.set_hexpand(True)
         self.set_tooltip_text(alert_button_tooltip)
+
+
+class SpinnerButton(Gtk.Button):
+    def __init__(self, label: str) -> None:
+        super().__init__()
+
+        self.text = label
+        self.label = Gtk.Label(label=label, halign=Gtk.Align.CENTER)
+
+        self.spinner = Gtk.Spinner()
+        self.spinner.set_halign(Gtk.Align.END)
+        self.spinner.set_sensitive(False)
+
+        grid = Gtk.Grid(column_spacing=10)
+        for el in self.label, self.spinner:
+            grid.add(el)
+
+        self.add(grid)
+
+        self.connect("clicked", self._on_button_clicked)
+        self.connect("map", self._on_map)
+
+    def _on_map(self, button: Self) -> None:
+        self.spinner.set_visible(False)
+
+    def _on_button_clicked(self, button: Self) -> None:
+        self.start_spinner()
+
+    def stop_spinner(self) -> None:
+        self.spinner.set_visible(False)
+        self.spinner.stop()
+
+    def start_spinner(self) -> None:
+        self.spinner.set_visible(True)
+        self.spinner.start()

dzgui/views/components/connect_panel.py

@@ -1,12 +1,15 @@
-from typing import TYPE_CHECKING
+from typing import Self, TYPE_CHECKING
 
-from dzgui.const.constants import UDP_PORT
+from dzgui.const.constants import CARET_DOWN, CARET_UP, UDP_PORT
 from dzgui.model.servers import ServerModelManager
 from dzgui.strings import connect_panel
 from dzgui.util.keys import is_ctrl_mask
 from dzgui.views.components.buttons import (
     AddButton,
-    ClipboardButton,
+    CloseButton,
+    CopyIpButton,
+    Icon,
+    IconButton,
     SteamConnectButton,
 )
 from dzgui.views.components.entry import IpEntry, PortEntry
@@ -18,12 +21,45 @@ gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk, Gdk  # noqa E402
 
 if TYPE_CHECKING:
-    from dzgui.controllers.mc import Controller, Emitter
+    from dzgui.controllers.mc import Controller
+    from dzgui.controllers.emitter import Emitter
 
 COLS = 1
 ROWS = 1
 
 
+class DockButton(IconButton):
+    def __init__(self, child: Gtk.Widget) -> None:
+        super().__init__(CARET_DOWN)
+
+        self.expanded = True
+        self.child = child
+        self.connect("clicked", self._on_click)
+
+        self.collapse_text = "Collapse the connection panel"
+        self.expand_text = "Expand the connection panel"
+
+        self.set_margin_top(10)
+        self.set_tooltip_text(self.collapse_text)
+
+    def collapse(self) -> None:
+        self.set_image(Icon(CARET_UP))
+        self.child.hide()
+        self.set_tooltip_text(self.expand_text)
+
+    def expand(self) -> None:
+        self.set_image(Icon(CARET_DOWN))
+        self.child.show()
+        self.set_tooltip_text(self.collapse_text)
+
+    def _on_click(self, button: Self) -> None:
+        if self.expanded:
+            self.collapse()
+        else:
+            self.expand()
+        self.expanded = not self.expanded
+
+
 class LanPanel(Gtk.Frame):
     def __init__(self, controller: "Controller") -> None:
         super().__init__(margin_top=10, margin_bottom=5)
@@ -151,18 +187,28 @@ class FavPanel(Gtk.Frame):
 
         self.fav_button = SteamConnectButton()
         self.fav_button.connect("clicked", self._on_connect_clicked)
-        self.copy_button = ClipboardButton(self.controller, self.get_fav_ip)
+        self.copy_button = CopyIpButton(self.controller, self.get_fav_ip)
+
+        # TODO: strings
+        self.unset_button = CloseButton("Unset")
+        self.unset_button.connect("clicked", self._on_unset_clicked)
+
         if favorite is None:
             self.toggle_buttons(False)
 
         # NOTE: disable vscrollbar to prevent layout jumping behavior
-        scrollable_label = Gtk.ScrolledWindow(vscrollbar_policy=Gtk.PolicyType.NEVER)
-        scrollable_label.add(self.fav_label)
+        self.scrollable_label = Gtk.ScrolledWindow(
+            vscrollbar_policy=Gtk.PolicyType.NEVER, overlay_scrolling=False
+        )
+        self.scrollable_label.add(self.fav_label)
 
         grid = Gtk.Grid(margin=10, vexpand=False, column_spacing=15, row_spacing=5)
-        grid.attach(scrollable_label, 0, 0, 3, ROWS)
+        grid.attach(self.scrollable_label, 0, 0, 3, ROWS)
         grid.attach_next_to(
-            self.copy_button, scrollable_label, Gtk.PositionType.RIGHT, COLS, ROWS
+            self.unset_button, self.scrollable_label, Gtk.PositionType.RIGHT, COLS, ROWS
+        )
+        grid.attach_next_to(
+            self.copy_button, self.unset_button, Gtk.PositionType.RIGHT, COLS, ROWS
         )
         grid.attach_next_to(
             self.fav_button, self.copy_button, Gtk.PositionType.RIGHT, COLS, ROWS
@@ -170,8 +216,16 @@ class FavPanel(Gtk.Frame):
 
         self.add(grid)
 
+    def _on_unset_clicked(self, button: Gtk.Button) -> None:
+        try:
+            self.controller.unset_fav()
+        except Exception:
+            return
+        self.fav_label.set_text(connect_panel.favs_empty)
+        self.toggle_buttons(False)
+
     def toggle_buttons(self, state: bool) -> None:
-        for button in self.fav_button, self.copy_button:
+        for button in self.fav_button, self.copy_button, self.unset_button:
             button.set_sensitive(state)
 
     def _on_connect_clicked(self, button: Gtk.Button) -> None:
@@ -272,15 +326,18 @@ class ConnectPanel(Gtk.Box):
         emitter = self.controller.get_emitter()
         emitter.connect("lan_tab_toggled", self._on_lan_tab_toggled)
 
+        self.panel_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
+
         self.lan = LanPanel(controller)
         self.fav = FavPanel(controller)
         self.add_panel = AddPanel(controller)
 
         for el in self.lan, self.fav, self.add_panel:
-            self.add(el)
+            self.panel_box.add(el)
 
-    def set_lan_visible(self, state: bool) -> None:
-        self.lan.set_visible(state)
+        self.add(DockButton(self.panel_box))
+        self.add(self.panel_box)
+        self.lan.set_visible(False)
 
     def _on_lan_tab_toggled(self, emitter: "Emitter", state: bool) -> None:
-        self.set_lan_visible(state)
+        self.lan.set_visible(state)

dzgui/views/components/entry.py

@@ -3,7 +3,7 @@ from typing import Any, Callable, TYPE_CHECKING
 from dzgui.api.servers import validate_ip
 from dzgui.const.constants import VIEW_CONCEAL, VIEW_REVEAL
 from dzgui.util.css import add_class, remove_class
-from dzgui.util.strings import connect_panel, lan_panel
+from dzgui.strings import connect_panel
 from dzgui.strings.errors import api_popover
 
 import gi
@@ -26,15 +26,12 @@ def validate_port(text: str) -> bool:
         return False
 
 
-def validate_ip_or_id(text: str) -> bool:
+def validate_ip_truthy(text: str) -> bool:
     try:
         validate_ip(text)
         return True
     except Exception:
-        if text.isdigit():
-            return True
-        else:
-            return False
+        return False
 
 
 class ValidatedEntry(Gtk.Entry):
@@ -124,12 +121,9 @@ class IpEntry(ValidatedEntry):
     def __init__(self, controller: "Controller") -> None:
         super().__init__(
             controller,
-            func=validate_ip_or_id,
-            placeholder_text=connect_panel.placeholder,
-            tooltip_text=connect_panel.entry_tooltip,
+            func=validate_ip_truthy,
+            placeholder_text=connect_panel.connect_entry_placeholder,
         )
-        self.set_placeholder_text(connect_panel.placeholder)
-        self.set_tooltip_text(connect_panel.entry_tooltip)
 
 
 class PortEntry(ValidatedEntry):
@@ -137,11 +131,9 @@ class PortEntry(ValidatedEntry):
         super().__init__(
             controller,
             func=validate_port,
-            placeholder_text=connect_panel.placeholder,
-            tooltip_text=connect_panel.entry_tooltip,
+            placeholder_text=connect_panel.lan_entry_placeholder,
+            tooltip_text=connect_panel.lan_entry_tooltip,
         )
-        self.set_placeholder_text(lan_panel.placeholder)
-        self.set_tooltip_text(lan_panel.entry_tooltip)
 
 
 # TODO: backport to Options page
@@ -162,7 +154,8 @@ class APIEntry(Gtk.Box):
         self.entry.connect("icon-release", self._on_icon_release)
         self.entry.connect("activate", self._on_field_activated)
 
-        self.submit = Gtk.Button(label="Submit")
+        # TODO: strings
+        self.submit = Gtk.Button(label="Validate")
         self.submit.set_sensitive(False)
         self.submit.connect("clicked", self._on_submit)
 

dzgui/views/components/eventbox.py

@@ -30,6 +30,9 @@ class InfoEventBox(Gtk.EventBox):
         self.connect("leave-notify-event", self._on_leave_tooltip)
         self.add(box)
 
+    def set_icon_yalign(self, offset: float) -> None:
+        self.icon.set_property("yalign", offset)
+
     def _on_enter_tooltip(
         self, eventbox: Gtk.EventBox, eventcrossing: Gdk.EventCrossing
     ) -> None:

dzgui/views/components/filter_panel.py

@@ -11,6 +11,7 @@ from dzgui.const.constants import (
 )
 from dzgui.const.enum import FilterMode
 from dzgui.model.servers import ServerModelManager
+from dzgui.util.format import format_exception
 from dzgui.util.strings import all_maps
 from dzgui.views.components.maps_combo import MapsCombo
 from dzgui.views.components.labels import BoldLabel
@@ -28,21 +29,33 @@ if TYPE_CHECKING:
 
 
 class ButtonGrid(Gtk.Grid):
-    def __init__(self, controller: "Controller", defaults: dict) -> None:
+    def __init__(
+        self,
+        controller: "Controller",
+        defaults: dict[str, str],
+        tooltips: dict[str, str],
+    ) -> None:
         super().__init__(
             halign=Gtk.Align.CENTER, column_spacing=5, column_homogeneous=True
         )
-        row = 1
-        col = 0
-
         self.controller = controller
         self.emitter = controller.get_emitter()
 
         self.checks: list[Gtk.CheckButton] = []
 
-        # TODO: use enumerated checks
+        flowbox = Gtk.FlowBox(
+            halign=Gtk.Align.CENTER, min_children_per_line=3, max_children_per_line=3, selection_mode=Gtk.SelectionMode.NONE
+        )
+
         for check in defaults.keys():
             checkbox = Gtk.CheckButton(label=check)
+            try:
+                tt = tooltips[check]
+            except Exception as e:
+                logger.debug(e)
+                tt = ""
+
+            checkbox.set_tooltip_text(tt)
             label = checkbox.get_child()
             if label is not None:
                 label.set_ellipsize(Pango.EllipsizeMode.END)  # type: ignore
@@ -50,14 +63,12 @@ class ButtonGrid(Gtk.Grid):
             if defaults[check]:
                 checkbox.set_active(True)
 
-            col = col + 1
-            if col > 3:
-                row += 1
-                col = 1
-            self.attach(checkbox, col, row, 1, 1)
             checkbox.connect("toggled", self._on_check_toggled)
+            flowbox.add(checkbox)
             self.checks.append(checkbox)
 
+        self.add(flowbox)
+
     def block_toggles(self, state: bool) -> None:
         for check in self.checks:
             self.controller.suppress_signal(
@@ -68,6 +79,7 @@ class ButtonGrid(Gtk.Grid):
             )
 
     def reload_filters(self) -> None:
+        # TODO: may be superfluous
         checkboxes = self.checks
         self.block_toggles(True)
         filters = self.controller.get_enabled_filters()
@@ -161,11 +173,12 @@ class FilterPanel(Gtk.Box):
 
         filter_man = self.controller.get_filter_man()
         defaults = filter_man.get_default_filters()
+        tooltips = filter_man.get_tooltips()
         self.map_store = filter_man.get_map_store()
         self.enabled_filters = defaults
 
         self.keyword_entry = KeywordEntry(self.controller)
-        self.button_grid = ButtonGrid(self.controller, defaults)
+        self.button_grid = ButtonGrid(self.controller, defaults, tooltips)
 
         # TODO: strings
         self.filters_label = BoldLabel("Filters")
@@ -330,3 +343,12 @@ class FilterPanel(Gtk.Box):
             self.block_map_change_propagation = False
             return
         self.emitter.emit("map_selection_changed", name)
+
+    def set_filters(self, filters: dict[str, bool]) -> None:
+        try:
+            for check in self.button_grid.checks:
+                label = check.get_label()
+                check.set_active(filters[label])
+        except Exception as e:
+            msg = format_exception(e)
+            logger.warning(msg)

dzgui/views/components/frame.py

@@ -1,3 +1,4 @@
+from typing import Self
 from dzgui.util import css
 
 import gi
@@ -6,16 +7,23 @@ gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk  # noqa
 
 
+# TODO: subclass Gtk.Frame directly
 class HeadingFrame(Gtk.Box):
-    def __init__(self, widget: Gtk.Widget, heading: str) -> None:
+    def __init__(self, heading: str = "") -> None:
         super().__init__(orientation=Gtk.Orientation.VERTICAL)
 
-        label = Gtk.Label(label=heading)
-        label.set_halign(Gtk.Align.START)
-        css.add_class(label, "settings-subheading")
+        self.label = Gtk.Label(label=heading)
+        self.label.set_halign(Gtk.Align.START)
+        css.add_class(self.label, "settings-subheading")
 
-        frame = Gtk.Frame(hexpand=True)
-        frame.add(widget)
-        frame.set_label_widget(label)
+        self.frame = Gtk.Frame(hexpand=True)
+        self.frame.set_label_widget(self.label)
 
-        self.add(frame)
+        self.add(self.frame)
+
+    @classmethod
+    def new_with_widget_and_label(cls, widget: Gtk.Widget, label: str) -> Self:
+        n = cls()
+        n.frame.add(widget)
+        n.label.set_label(label)
+        return n

dzgui/views/components/misc.py

@@ -1,5 +1,8 @@
+from dzgui.const.constants import ERROR, FLATPAK_RUN_CMD, FLATPAK_SANDBOX, STEAM_CMD
 from dzgui.strings import options
-from dzgui.const.constants import FLATPAK_RUN_CMD, FLATPAK_SANDBOX, STEAM_CMD
+from dzgui.views.components.box import HBox
+from dzgui.views.components.buttons import Icon
+
 
 import gi
 
@@ -33,3 +36,18 @@ class ClientCombo(Gtk.ComboBox):
         self.pack_start(renderer_text, True)
         self.add_attribute(renderer_text, "text", 0)
         self.set_active(0)
+
+class ErrorPopover(Gtk.Popover):
+    def __init__(self, relative_to: Gtk.Widget, position: Gtk.PositionType) -> None:
+        super().__init__(relative_to=relative_to, position=position)
+
+        self.hbox = HBox()
+        self.label = Gtk.Label(label="", margin_start=10, margin_end=10)
+        error_icon = Icon(ERROR, margin_start=10)
+        self.hbox.extend([error_icon, self.label])
+        self.add(self.hbox)
+        self.show_all()
+        self.popdown()
+
+    def set_label(self, label: str) -> None:
+        self.label.set_label(label)

dzgui/views/components/mod_panel.py

@@ -11,7 +11,8 @@ gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk  # noqa E402
 
 if TYPE_CHECKING:
-    from dzgui.controllers.mc import Controller, Emitter
+    from dzgui.controllers.mc import Controller
+    from dzgui.controllers.emitter import Emitter
 
 
 class EnumeratedModButton(Gtk.Button):
@@ -22,10 +23,12 @@ class EnumeratedModButton(Gtk.Button):
         self.set_label(enum.dict["label"])
         self.set_tooltip_text(enum.dict["tooltip"])
 
+
 class ModPanelButton(EnumeratedModButton):
     def __init__(self, enum: ModButton) -> None:
         super().__init__(enum=enum)
 
+        self.enum = enum
         if enum is not ModButton.HIGHLIGHT_STALE:
             self.set_sensitive(False)
 
@@ -46,7 +49,7 @@ class ModSelectionPanel(Gtk.Box):
         buttons = (
             ModButton.SELECT_ALL,
             ModButton.UNSELECT_ALL,
-            ModButton.DELETE_SELECTED,
+            ModButton.UNSUB_SELECTED,
         )
         for button in buttons:
             b = EnumeratedModButton(button)
@@ -58,8 +61,13 @@ class ModSelectionPanel(Gtk.Box):
         self.unhighlight_stale_button = ModPanelButton(ModButton.UNHIGHLIGHT_STALE)
         self.select_stale_button = ModPanelButton(ModButton.SELECT_STALE)
 
-        for b in (self.highlight_stale_button, self.unhighlight_stale_button, self.select_stale_button):
+        for b in (
+            self.highlight_stale_button,
+            self.unhighlight_stale_button,
+            self.select_stale_button,
+        ):
             self.stale_panel.pack_start(b, NO_EXPAND, FILL, NO_PADDING)
+            b.connect("clicked", self._on_button_clicked)
 
         for el in header, self.main_panel, self.stale_panel:
             self.pack_start(el, NO_EXPAND, FILL, NO_PADDING)
@@ -72,14 +80,18 @@ class ModSelectionPanel(Gtk.Box):
         self.highlight_stale_button.set_sensitive(True)
 
     def _on_mods_updated(self, emitter: "Emitter", msg: str, mods: int) -> None:
-        if mods < 1:
-            self.main_panel.set_sensitive(False)
-            self.stale_panel.set_sensitive(False)
+        self._toggle_panel_sensitivity(mods)
+
+    def _toggle_panel_sensitivity(self, mods: int) -> None:
+        state = bool(mods)
+        for el in self.main_panel, self.stale_panel:
+            el.set_sensitive(state)
 
     def _on_mods_highlighted(self, emitter: "Emitter") -> None:
         self.swap_sensitive(True)
 
-    def _on_mod_page_toggled(self, emitter: "Emitter", state: bool) -> None:
+    def _on_mod_page_toggled(self, emitter: "Emitter", state: bool, mods: int) -> None:
+        self._toggle_panel_sensitivity(mods)
         self.set_visible(state)
 
     def swap_sensitive(self, state: bool) -> None:
@@ -93,8 +105,8 @@ class ModSelectionPanel(Gtk.Box):
                 self.controller.toggle_mod_selection(True)
             case ModButton.UNSELECT_ALL:
                 self.controller.toggle_mod_selection(False)
-            case ModButton.DELETE_SELECTED:
-                self.controller.delete_mods()
+            case ModButton.UNSUB_SELECTED:
+                self.controller.unsub_mods()
             case ModButton.HIGHLIGHT_STALE:
                 self.controller.highlight_stale()
             case ModButton.UNHIGHLIGHT_STALE: