mirror of
https://github.com/aclist/dztui.git
synced 2025-04-05 12:03:00 +02:00
aclist
GitHub
commit
4ce2d0af45
7 changed files with 1695 additions and 1196 deletions
599
CHANGELOG.md
Normal file
599
CHANGELOG.md
Normal file
|
|
@ -0,0 +1,599 @@
|
|||
# Changelog
|
||||
|
||||
## [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.4.0-rc.1] 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
|
||||
|
||||
## [3.3.0-rc.24] 2023-05-10
|
||||
### Fixed
|
||||
- Return from lockfile function if first time setup is not complete
|
||||
|
||||
## [3.3.0-rc.23] 2023-05-10
|
||||
### Fixed
|
||||
- Display correct players in-game count
|
||||
### Changed
|
||||
- Make file picker method more robust
|
||||
|
||||
## [3.3.0-rc.22] 2023-05-10
|
||||
### Changed
|
||||
- Display canonical dir name of mods in list installed mods menu
|
||||
|
||||
## [3.3.0-rc.21] 2023-05-10
|
||||
### Fixed
|
||||
- Hardening of beta client targeting function to avoid false positives
|
||||
|
||||
## [3.3.0-rc.20] 2023-05-09
|
||||
### Changed
|
||||
- Use same WM_CLASS targeting method for beta and stable clients
|
||||
|
||||
## [3.3.0-rc.19] 2023-05-09
|
||||
### Fixed
|
||||
- Case folding when targeting WM_CLASS
|
||||
|
||||
## [3.3.0-rc.18] 2023-05-09
|
||||
### Changed
|
||||
- More robust targeting of Steam client
|
||||
- Change method of issuing console commands to Beta client
|
||||
|
||||
## [3.3.0-rc.17] 2023-05-07
|
||||
### Fixed
|
||||
- Use sudo when checking vm map count (#61)
|
||||
|
||||
## [3.3.0-rc.16] 2023-05-06
|
||||
### Fixed
|
||||
- Steam beta console not focusing (#60)
|
||||
|
||||
## [3.3.0-rc.15] 2023-02-22
|
||||
### Fixed
|
||||
- BM API returning stale query port and preventing fetching modlist
|
||||
|
||||
## [3.3.0-rc.12] 2023-01-19
|
||||
### Fixed
|
||||
- Don't check mod version timestamps if no mods installed
|
||||
- Don't continuously force popup to top of stack
|
||||
- Fix for repeated key input in console
|
||||
- Split merged modlist correctly on newline
|
||||
### Added
|
||||
- Parameterize native/Flatpak steam selection
|
||||
- Toggle native/Flatpak steam from options menu
|
||||
- Clarify popup wording
|
||||
|
||||
## [3.3.0-rc.11] 2023-01-01
|
||||
### Fixed
|
||||
- History menu not parsing ports correctly
|
||||
- Validate BM key on initial setup
|
||||
### Changed
|
||||
- More permissive Steam client discovery for tiling WMs
|
||||
- Reset minor version (was 1 ahead)
|
||||
|
||||
## [3.3.0-rc.2] 2022-12-10
|
||||
### Changed
|
||||
- Clarify low pop server count
|
||||
- Tick low pop server option by default
|
||||
|
||||
## [3.3.0-rc.1] 2022-12-06
|
||||
### Fixed
|
||||
- Merge Python version hotfix from stable branch
|
||||
|
||||
## [3.2.1-rc.1] 2022-12-03
|
||||
### Changed
|
||||
- Dropped legacy headless mode logic and refactor against new automod method
|
||||
|
||||
## [3.1.0-rc.21] 2022-12-03
|
||||
### Added
|
||||
- File picker error handling
|
||||
|
||||
## [3.1.0-rc.20] 2022-12-02
|
||||
### Fixed
|
||||
- Include /run in auto-discovery routine
|
||||
|
||||
## [3.1.0-rc.19] 2022-12-02
|
||||
### Fixed
|
||||
- Use Steam-safe local zenity version
|
||||
|
||||
## [3.1.0-rc.18] 2022-12-01
|
||||
### Added
|
||||
- Thousands separator to player counts
|
||||
### Dropped
|
||||
- Removed deprecated functions
|
||||
|
||||
## [3.1.0-rc.17] 2022-11-28
|
||||
### Changed
|
||||
- Explicitly check Python version
|
||||
|
||||
## [3.1.0-rc.16] 2022-11-25
|
||||
### Fixed
|
||||
- Hotfix for server modlists returning multiples of same mod
|
||||
|
||||
## [3.1.0-rc.15] 2022-11-24
|
||||
### Fixed
|
||||
- Faster path discovery on initial setup
|
||||
- Handle whitelist deletion when only one entry present
|
||||
- Return to main menu from recent servers list
|
||||
- Unset delete menu flags after deletion
|
||||
### Added
|
||||
- Add python to deps
|
||||
- Add Steam API key requirement to initial setup
|
||||
### Dropped
|
||||
- Drop mandatory server IDs on initial setup
|
||||
- Old functions and files pertaining to headless mode
|
||||
### Changed
|
||||
- Allow My Servers list to be initially empty
|
||||
|
||||
## [3.1.0-rc.14] 2022-11-24
|
||||
### Changed
|
||||
- Rename "History" to "Recent"
|
||||
|
||||
## [3.1.0-rc.13] 2022-11-24
|
||||
### Fixed
|
||||
- Prevent downloading mods if Steam is not running
|
||||
- Suppress "force refresh mods" option if automods is disabled
|
||||
|
||||
## [3.1.0-rc.12] 2022-11-22
|
||||
### Changed
|
||||
- Updated menu labels
|
||||
|
||||
## [3.1.0-rc.11] 2022-11-21
|
||||
### Added
|
||||
- Recent connect history
|
||||
- Force refresh local mods
|
||||
### Changed
|
||||
- More verbose messages regarding automod installation
|
||||
### Dropped
|
||||
- Headless mode
|
||||
|
||||
## [3.1.0-rc.10] 2022-11-09
|
||||
### Changed
|
||||
- More verbose logs
|
||||
- Rename log file for clarity
|
||||
|
||||
## [3.1.0-rc.8] 2022-10-26
|
||||
### Changed
|
||||
- Foreground mod progress watcher
|
||||
|
||||
## [3.1.0-rc.7] 2022-10-25
|
||||
### Changed
|
||||
- Simplify mod progress watcher
|
||||
|
||||
## [3.1.0-rc.6] 2022-10-25
|
||||
### Fixed
|
||||
- Download mod metadata
|
||||
|
||||
## [3.1.0-rc.5] 2022-10-25
|
||||
### Added
|
||||
- Versioning for automods
|
||||
### Fixed
|
||||
- Restore manual mode watcher file
|
||||
|
||||
## [3.1.0-rc.4] 2022-10-23
|
||||
### Added
|
||||
- Automod v.2 method
|
||||
|
||||
## [3.1.0-rc.3] 2022-10-16
|
||||
### Added
|
||||
- Backend preparation
|
||||
|
||||
## [3.1.0-rc.1-2] 2022-10-16
|
||||
### Fixed
|
||||
- Steam Deck path discovery
|
||||
|
||||
## [3.0.0-testing] 2022-10-12
|
||||
### Changed
|
||||
- Increment major version
|
||||
|
||||
## [2.8.0-rc.9] 2022-10-11
|
||||
### Changed
|
||||
- Reordered main menu elements
|
||||
|
||||
## [2.8.0-rc.8] 2022-10-11
|
||||
### Changed
|
||||
- Changed notification title
|
||||
|
||||
## [2.8.0-rc.7] 2022-10-11
|
||||
### Changed
|
||||
- Reword menu option
|
||||
### Fixed
|
||||
- Redirect stderr on popup
|
||||
|
||||
## [2.8.0-rc.6] 2022-10-11
|
||||
### Dropped
|
||||
- Stop using BM for query ports
|
||||
### Added
|
||||
- Deprecation warning/enforced Steam API
|
||||
|
||||
## [2.8.0-rc.5] 2022-10-11
|
||||
### Fixed
|
||||
- Width of some popups on Steam Deck
|
||||
|
||||
## [2.8.0-rc.4] 2022-10-11
|
||||
### Changed
|
||||
- Abstract news urls
|
||||
- Clarify dependency warning
|
||||
|
||||
## [2.8.0-rc.3] 2022-10-11
|
||||
### Added
|
||||
- Add forums link
|
||||
|
||||
## [2.8.0-rc.2] 2022-10-07
|
||||
### Added
|
||||
- Backend preparation for automods
|
||||
|
||||
## [2.8.0-rc.1] 2022-10-06
|
||||
### Fixed
|
||||
- Bug with normal mode not launching after closing progress bar
|
||||
|
||||
## [2.7.0-rc.26] 2022-10-04
|
||||
### Fixed
|
||||
- Delete server list array not being emptied when going back to main menu
|
||||
|
||||
### Added
|
||||
- Progress bars when downloading updates
|
||||
### Changed
|
||||
- Group main menu categories
|
||||
### Fixed
|
||||
- Encapsulate window strings to prevent arguments leaking into title
|
||||
- Remove extraneous download process that was slowing down startup
|
||||
|
||||
## [2.7.0-rc.23] 2022-10-03
|
||||
### Fixed
|
||||
- More robust error handling for API keys
|
||||
|
||||
## [2.7.0-rc.22] 2022-10-02
|
||||
### Fixed
|
||||
- Merge stable branch hotfixes
|
||||
|
||||
## [2.7.0-rc.21] 2022-10-01
|
||||
### Fixed
|
||||
- Clarify some menu messages and behavior
|
||||
|
||||
## [2.7.0-rc.20] 2022-09-29
|
||||
### Added
|
||||
- List total disk size used on mods list
|
||||
|
||||
## [2.7.0-rc.19] 2022-09-26
|
||||
### Fixed
|
||||
- Strip text from "all maps" option in header
|
||||
|
||||
## [2.7.0-rc.18] 2022-09-26
|
||||
### Changed
|
||||
- Move lockfile check earlier in pipeline
|
||||
- Reword "All maps" filter option
|
||||
### Fixed
|
||||
- Store player and server count sooner
|
||||
|
||||
## [2.7.0-rc.16-17] 2022-09-26
|
||||
### Changed
|
||||
- Clean up error logging and progress bars
|
||||
|
||||
## [2.7.0-rc.15] 2022-09-25
|
||||
### Fixed
|
||||
- Return selection from server function
|
||||
|
||||
## [2.7.0-rc.14] 2022-09-25
|
||||
### Fixed
|
||||
- Suppress progress dialog when new version available
|
||||
|
||||
## [2.7.0-rc.13] 2022-09-25
|
||||
### Fixed
|
||||
- Restore broken headers
|
||||
### Added
|
||||
- More verbose logging
|
||||
|
||||
## [2.7.0-rc.12] 2022-09-24
|
||||
### Changed
|
||||
- More verbose logging, error codes
|
||||
|
||||
## [2.7.0-rc.11] 2022-09-24
|
||||
### Added
|
||||
- Add debug code to troubleshoot API responses
|
||||
|
||||
## [2.7.0-rc.10] 2022-09-23
|
||||
### Fixed
|
||||
- Server list not appearing when launching script through Steam
|
||||
|
||||
## [2.7.0-rc.9] 2022-09-22
|
||||
### Added
|
||||
- Add alternative IP query method
|
||||
|
||||
## [2.7.0-rc.8] 2022-09-15
|
||||
### Dropped
|
||||
- Drop Python dependency
|
||||
|
||||
## [2.7.0-rc.7] 2022-09-14
|
||||
### Added
|
||||
- Verify IP table checksums when starting
|
||||
### Changed
|
||||
- Switch to C for helper logic
|
||||
### Fixed
|
||||
- Error handling for obscure servers returning no modlist
|
||||
|
||||
## [2.7.0-rc.6] 2022-09-13
|
||||
### Added
|
||||
- Add number of maps found to map select menu
|
||||
### Fixed
|
||||
- Strip Unicode spaces in server titles
|
||||
|
||||
## [2.7.0-rc.5] 2022-09-13
|
||||
### Changed
|
||||
- Improve server distance algorithm
|
||||
### Fixed
|
||||
- Strip Unicode spaces in server titles
|
||||
|
||||
## [2.7.0-rc.2 to 4] 2022-09-13
|
||||
### Changed
|
||||
- Retooling data in header
|
||||
|
||||
## [2.7.0-rc.1] 2022-09-12
|
||||
### Added
|
||||
- Initial server browser prototype
|
||||
|
||||
## [2.6.0-rc.5] 2022-09-03
|
||||
### Fixed
|
||||
- Make variable local
|
||||
|
||||
## [2.6.0-rc.4] 2022-09-03
|
||||
### Fixed
|
||||
- Use alternate API for direct IP queries
|
||||
|
||||
## [2.6.0-rc.3] 2022-09-03
|
||||
### Changed
|
||||
- Revert to legacy API method
|
||||
|
||||
## [2.6.0-rc.2] 2022-08-31
|
||||
### Added
|
||||
- Validate Steam API key
|
||||
|
||||
## [2.6.0-rc.1] 2022-08-16
|
||||
### Added
|
||||
- Connect to server by IP
|
||||
|
||||
## [2.5.0-rc.2] 2022-08-14
|
||||
### Fixed
|
||||
- Hotfix for server list responses with no next page cursor breaking table
|
||||
|
||||
## [2.5.0-rc.1] 2022-08-14
|
||||
### Changed
|
||||
- More performant path discovery, skip extraneous prompts
|
||||
|
||||
## [2.4.2-rc.5] 2022-08-13
|
||||
### Fixed
|
||||
- Cleaned typos and removed debug code
|
||||
|
||||
## [2.4.2-rc.4] 2022-08-13
|
||||
### Fixed
|
||||
- Clean up legacy symlinks
|
||||
|
||||
## [2.4.2-rc.3] 2022-08-13
|
||||
### Fixed
|
||||
- Alternate symlink method to prevent collisions in IDs
|
||||
|
||||
## [2.4.2-rc.2] 2022-08-10
|
||||
### Fixed
|
||||
- Pass correct query ports to modlist function
|
||||
|
||||
## [2.4.2-rc.1] 2022-08-10
|
||||
### Fixed
|
||||
- Page though API results to list >10 servers
|
||||
|
||||
## [2.4.1-testing] 2022-08-09
|
||||
### Fixed
|
||||
- Hotfix for progress bar breaking table when >9 servers in list
|
||||
|
||||
## [2.4.0-rc.10 - 2.4.0-rc.14] 2022-08-05
|
||||
### Fixed
|
||||
- Miscellaneous backend changes to test deployment of shortcuts to Steam Deck
|
||||
|
||||
## [2.4.0-rc.9] 2022-08-05
|
||||
### Added
|
||||
- Steam Deck artwork
|
||||
|
||||
## [2.4.0-rc.8] 2022-08-04
|
||||
### Fixed
|
||||
- Prevent word splitting of CPU result
|
||||
- Correct path for writing .desktop files
|
||||
|
||||
## [2.4.0-rc.7] 2022-08-04
|
||||
### Fixed
|
||||
- Prevent user from entering invalid entries on first-time setup
|
||||
- Prompt to re-run first-time setup if config is malformed
|
||||
- Better handling of field output from table
|
||||
### Added
|
||||
- Prototype .desktop file for Steam Deck
|
||||
- Generate bug report logs summarizing local settings
|
||||
### Dropped
|
||||
- Deprecated functions
|
||||
|
||||
## [2.4.0-rc.5] 2022-07-31
|
||||
### Dropped
|
||||
- Drop download prompt for branch toggle
|
||||
|
||||
## [2.4.0-rc.4] 2022-07-31
|
||||
### Fixed
|
||||
- Source seen_news and debug values when writing new config file
|
||||
|
||||
## [2.4.0-rc.3] 2022-07-31
|
||||
### Fixed
|
||||
- Populate branch value correctly when staging config file
|
||||
|
||||
## [2.4.0-rc.2] 2022-07-31
|
||||
### Fixed
|
||||
- Enforce download when switching branches
|
||||
|
||||
## [2.4.0-rc.1] 2022-07-24
|
||||
### Added
|
||||
- Dependency check for Steam
|
||||
- Delete server from list
|
||||
- News backend for critical updates
|
||||
- Prompt to permanently update sysctl map count
|
||||
- Clean up stale symlinks if mods were deleted
|
||||
- Backported DZTUI mod listing method (includes symlinks)
|
||||
- Backported DZTUI method of encoding symlinks when handling large number of mods
|
||||
- Write dry-run launch options to file when in debug mode
|
||||
### Fixed
|
||||
- Prevent garbage in dependency check messages
|
||||
- Send browser to background when opening links
|
||||
### Changed
|
||||
- Couple connect to fav and normal connect to same query function for maintainability
|
||||
- Revert to old issues page index
|
||||
- Hide header on unneeded pages
|
||||
- Better detection of Steam Deck
|
||||
|
||||
## [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
|
||||
357
changelog.md
357
changelog.md
|
|
@ -1,357 +0,0 @@
|
|||
# Changelog
|
||||
|
||||
## [3.3.0] 2023-05-16
|
||||
|
||||
As of this version, to reduce verbosity, the Stable branch will only receive changelog updates for major and minor version increments,
|
||||
rather than for every hotfix. The Testing branch will continue to receive changelog updates for every hotfix under a release candidate.
|
||||
|
||||
### 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
|
||||
>>>>>>> c293fcd8c5136b6578f519b2f400d45bc01335cc
|
||||
|
||||
## [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
|
||||
126
docs/dzgui.adoc
126
docs/dzgui.adoc
|
|
@ -89,23 +89,27 @@ echo 'vm.max_map_count=1048576' | sudo tee /etc/sysctl.d/dayz.conf
|
|||
. **Enable a Proton version ≥ `6.8` (or use Experimental) in the `Compatibility` field of the game's right-click options.**
|
||||
|
||||
=== API key & server IDs
|
||||
==== BattleMetrics API key
|
||||
1. Register for an API key at https://www.battlemetrics.com/account/register?after=%2Fdevelopers[BattleMetrics] (free)
|
||||
2. From the **Personal Access Tokens** area, Select **New Token**
|
||||
3. Give the token any name in the field at the top
|
||||
4. Leave all options **unchecked** and scroll to the bottom, select **Create Token**
|
||||
5. Copy the access token for later use (see below). This is the unique token you will use to query servers.
|
||||
|
||||
==== Steam API key
|
||||
==== Steam API key (required)
|
||||
1. Register for a https://steamcommunity.com/dev/apikey[Steam API key] (free) using your Steam account. You will be asked for a unique URL for your app when registering.
|
||||
2. Since this key is for a personal use application and does not actually call back anywhere, set a generic local identifier here like "127.0.0.1" or some other name that is meaningful to you.
|
||||
3. Once configured, you can insert this key in the app when launching it for the first time.
|
||||
|
||||
==== BattleMetrics API key (optional)
|
||||
|
||||
This step is optional. Using this key in conjunction with the above allows you to connect to and query servers by ID instead of by IP. See <<Add server by ID>>.
|
||||
|
||||
1. Register for an API key at https://www.battlemetrics.com/account/register?after=%2Fdevelopers[BattleMetrics] (free)
|
||||
2. From the **Personal Access Tokens** area, Select **New Token**
|
||||
3. Give the token any name in the field at the top
|
||||
4. Leave all options **unchecked** and scroll to the bottom, select **Create Token**
|
||||
5. 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 for the first time.
|
||||
|
||||
=== First-time launch
|
||||
|
||||
0. It is always advised to have Steam running in the background. DZGUI is meant to run "on top of" Steam.
|
||||
0. It is always advised to have Steam running in the background. DayZ is meant to run "on top of" Steam.
|
||||
|
||||
1. DZGUI can be launched one of two ways.
|
||||
1. DZGUI can be launched one of two ways.
|
||||
|
||||
**From the terminal:**
|
||||
|
||||
|
|
@ -113,24 +117,23 @@ echo 'vm.max_map_count=1048576' | sudo tee /etc/sysctl.d/dayz.conf
|
|||
./dzgui.sh
|
||||
```
|
||||
|
||||
Launching from the terminal gives more verbose information in the event of a crash,
|
||||
and can be a good way of troubleshooting problems.
|
||||
Launching from the terminal gives more verbose information in the event of a crash, and can be a good way of troubleshooting problems.
|
||||
|
||||
**From the shortcut shipped with the application** (if using a desktop environment based on the Freedesktop specification):
|
||||
|
||||
- Located under the "Games" category of your system's applications list.
|
||||
- Via the DZGUI desktop shortcut (Steam Deck only)
|
||||
- Via the "DZGUI" desktop shortcut (Steam Deck only)
|
||||
|
||||
[start=2]
|
||||
2. Follow the menu prompts given by the app. You will be asked to provide:
|
||||
|
||||
- Player name (a generic handle, required by some servers)
|
||||
- BM API key (see above)
|
||||
- Steam API key
|
||||
- Steam API key (required)
|
||||
- BM API key (optional)
|
||||
|
||||
==== Steam path discovery
|
||||
|
||||
DZGUI will then attempt to locate your default Steam installation and DayZ path. You *must* have DayZ installed in your Steam library in order to proceed. (It can be installed to any drive of your choosing.)
|
||||
DZGUI will now attempt to locate your default Steam installation and DayZ path. You *must* have DayZ installed in your Steam library in order to proceed. (It can be installed to any drive of your choosing.)
|
||||
If DZGUI cannot find Steam or cannot find DayZ installed at the detected Steam path, it will prompt you to manually specify the path to your Steam installation.
|
||||
|
||||
Specify the top-level entry point to Steam, not DayZ. E.g.,
|
||||
|
|
@ -153,15 +156,15 @@ For GTK 3, invoke the command:
|
|||
|
||||
DZGUI can be added to Steam as a "non-Steam game" in order to facilitate integration with Steam Deck or desktop environments.
|
||||
|
||||
1. Launch Steam in the "Large" view.
|
||||
1. Launch Steam in the "Large" view.
|
||||
|
||||
[NOTE]
|
||||
Steam Deck: you must switch to "Desktop Mode" and launch Steam from the desktop.
|
||||
Steam Deck: you must switch to "Desktop Mode" and launch Steam from the desktop. Steam Deck Game Mode does not support keyboard entry on some third party apps.
|
||||
|
||||
[start=2]
|
||||
2. Select **Add a Game** > **Add a Non-Steam Game** from the lower left-hand corner.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/01.png[01,500]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/01.png[01,500]
|
||||
|
||||
[start=3]
|
||||
3. Navigate to `$HOME/.local/share/applications/` and select `dzgui.desktop`
|
||||
|
|
@ -190,7 +193,7 @@ Updating the artwork:
|
|||
|
||||
1. Navigate to the app's details page and right-click the blank image header at the top.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/03.png[03,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/03.png[03,700]
|
||||
|
||||
[start=2]
|
||||
2. Select **Set Custom Background**
|
||||
|
|
@ -198,12 +201,12 @@ image::https://github.com/aclist/dztui/raw/testing/images/tutorial/03.png[03,700
|
|||
4. Navigate to the artwork path described above and select `hero.png`.
|
||||
5. Next, right-click the image background and select **Set Custom Logo**.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/04.png[04,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/04.png[04,700]
|
||||
|
||||
[start=5]
|
||||
5. Navigate to the same path and select `logo.png`. Notice that this removes the redundant app name that occluded the image.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/05.png[05,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/05.png[05,700]
|
||||
|
||||
[start=6]
|
||||
6. Next, navigate to your Library index (looks like a bookshelf of cover art) and find the DZGUI app.
|
||||
|
|
@ -211,12 +214,12 @@ image::https://github.com/aclist/dztui/raw/testing/images/tutorial/05.png[05,700
|
|||
[start=7]
|
||||
7. Right-click its cover and select **Manage** > **Set custom artwork**.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/06.png[06,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/06.png[06,700]
|
||||
|
||||
[start=8]
|
||||
8. Navigate to the same path and select `grid.png`. The final result:
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/07.png[07,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/07.png[07,700]
|
||||
|
||||
|
||||
=== Updating the app
|
||||
|
|
@ -237,11 +240,11 @@ Script:
|
|||
```
|
||||
<path to script><script name>.old
|
||||
```
|
||||
E.g., if DZGUI is named `dzgui`, in the path `$HOME/bin`, it will be located at
|
||||
E.g., if DZGUI is named `dzgui`, in the path `$HOME/bin`, the backup will be located at
|
||||
```
|
||||
$HOME/bin/dzgui.old
|
||||
```
|
||||
If launching DZGUI via its system shortcut, the backup file (similarly for log files) will be located under:
|
||||
If launching DZGUI via its system shortcut, the backup file will be located under:
|
||||
|
||||
```
|
||||
$HOME/.local/share/dzgui
|
||||
|
|
@ -256,12 +259,13 @@ $HOME/.config/dztui/dztuirc.old
|
|||
== Usage
|
||||
Select from among the <<Menu options>> below.
|
||||
|
||||
Connecting to a server consists of fetching metadata for the server IDs you have previously saved/are searching for.
|
||||
Connecting to a server consists of fetching metadata for the server(s) you are searching for.
|
||||
|
||||
DZGUI will check the server's modset against your local mods. If you are missing any,
|
||||
it will prompt you to download them through the Steam Workshop and open a window in the background in the system browser.
|
||||
|
||||
Open each link and click Subscribe to schedule these for download.
|
||||
|
||||
[NOTE]
|
||||
You must be logged into Steam for mod changes to take effect.
|
||||
It can take some time for the subscribed mods to download and update.
|
||||
|
|
@ -277,8 +281,7 @@ These servers can be filtered by various parameters in order to display a more g
|
|||
|
||||
After a server is selected from the list, the application continues to the mod validation step.
|
||||
|
||||
[NOTE]
|
||||
It is not currently possible to save servers from the full server browser.
|
||||
Prior to connecting, DZGUI will prompt you if you want to add this server to your <<My servers>>.
|
||||
|
||||
===== Filters
|
||||
|
||||
|
|
@ -337,23 +340,38 @@ after selecting the initial server.
|
|||
==== Quick connect to favorite server
|
||||
Bypasses the server list and quick-connects to a single favorite server specified in advance using the <<Add favorite server>> option.
|
||||
|
||||
==== Connect by ID
|
||||
Requires a BM API key. Use the https://www.battlemetrics.com/servers/dayz[BattleMetrics site] to find servers of interest (proximity, player count, rules, etc.)
|
||||
|
||||
Each server has a unique ID. This is the string of numbers at the end of the URL. Copy these IDs.
|
||||
For example, in the URL https://www.battlemetrics.com/servers/dayz/8039514, the ID is `8039514`.
|
||||
|
||||
Enter the ID of a server to have it translated to an IP. After this step, the process continues as though you were connecting by IP.
|
||||
|
||||
==== Connect by IP
|
||||
Instead of relying on server IDs, returns the list of maps behind a given IP.
|
||||
Provide only the IP; no port is necessary. This returns the server metadata for you to verify before connecting.
|
||||
|
||||
If there are multiple maps hosted behind an IP (e.g. different maps on varying ports), the application will list all of them.
|
||||
If there are multiple maps hosted behind an IP (e.g. different maps on varying ports), the application will list all of them for you to choose from.
|
||||
|
||||
==== Recent servers
|
||||
This feature queries the history file for the last 10 servers connected to by any means
|
||||
(server browser, favorite servers, connect-by-IP, etc.).
|
||||
|
||||
==== Add server by ID
|
||||
Use the https://www.battlemetrics.com/servers/dayz[BattleMetrics site] to find servers of interest (proximity, player count, rules, etc.)
|
||||
Requires a BM API key. Use the https://www.battlemetrics.com/servers/dayz[BattleMetrics site] to find servers of interest (proximity, player count, rules, etc.)
|
||||
|
||||
Each server has a unique ID. This is the string of numbers at the end of the URL. Copy these IDs.
|
||||
For example, in the URL https://www.battlemetrics.com/servers/dayz/8039514, the ID is `8039514`.
|
||||
|
||||
An indefinite number of servers can be added. These will be listed when using the <<My servers>> option.
|
||||
Servers you add will be saved and listed when using the <<My servers>> option.
|
||||
|
||||
==== Add server by IP
|
||||
Like the above, only using the direct IP of the server in question.
|
||||
|
||||
Provide only the IP; no port is necessary. This returns the server metadata for you to verify before connecting.
|
||||
|
||||
If there are multiple maps hosted behind an IP (e.g. different maps on varying ports), the application will list all of them for you to choose from.
|
||||
|
||||
==== Add (change) favorite server
|
||||
Prompts you to add/change a favorite server to the config file by ID. The name of the server will be updated in the header of the app. This server is used when selecting the <<Quick connect to favorite server>> option. If a favorite server is already enabled, this option switches to "Change favorite server."
|
||||
|
|
@ -377,23 +395,27 @@ The app ships with the stable branch enabled, with the testing branch being used
|
|||
===== Toggle debug mode
|
||||
Toggles debug mode, which is used to perform dry-runs and output what parameters would have been used to connect to a server.
|
||||
|
||||
===== Generate debug log
|
||||
Writes a list of your current settings to a local file that can be pasted into bug reports.
|
||||
|
||||
===== Toggle auto mod install
|
||||
This feature is experimental. It attempts to queue the mods requested for download
|
||||
automatically, rather than prompting the user to subscribe to each one.
|
||||
This feature is experimental. It attempts to queue the mods requested for download automatically, rather than prompting the user to subscribe to each one.
|
||||
|
||||
Both `wmctrl` and `xdotool` must be installed to use this feature.
|
||||
|
||||
[NOTE]
|
||||
When using auto mod installation, the mods will not appear as subscribed to in the Steam Workshop.
|
||||
When using auto mod installation, the mods may not appear as subscribed to in the Steam Workshop.
|
||||
DZGUI tracks their version internally and will trigger an update if necessary the next time you
|
||||
attempt to connect.
|
||||
|
||||
===== Change player name
|
||||
Used to change the in-game player name that is broadcast when on servers.
|
||||
|
||||
===== Output system info
|
||||
Writes a list of your current settings and system configuration to a local file that can be pasted into bug reports.
|
||||
|
||||
===== Force update local mods
|
||||
A convenience function that attempts to redownload all local mods. Can be used in the event of corruption
|
||||
or file integrity issues. In conjunction with the <<Toggle auto mod install>> feature, this feature is experimental.
|
||||
|
||||
Attempts to refresh the version of all local mods to the newest version by checking remote mod hashes and requesting updates from Steam.
|
||||
|
||||
This is a convenience feature that attempts to redownload all local mods. Can be used in the event of corruption or file integrity issues. In conjunction with the <<Toggle auto mod install>> feature, this feature is experimental.
|
||||
|
||||
==== Help file
|
||||
Uses xdg-open to open this documentation in the system browser.
|
||||
|
|
@ -404,26 +426,31 @@ Uses xdg-open to open the https://github.com/aclist/dztui/issues[bug tracker] in
|
|||
==== Forum
|
||||
Uses xdg-open to open the https://github.com/aclist/dztui/discussions[discussion forum] in the system browser.
|
||||
|
||||
==== Sponsor
|
||||
Uses xdg-open to open the https://github.com/sponsors/aclist[sponsor page], where you can help fund development, in the system browser.
|
||||
|
||||
==== Hall of fame
|
||||
Uses xdg-open to open the https://aclist.github.io/dzgui/dzgui#_hall_of_fame[Hall of Fame], which recognizes those who actively contributed to the betterment of the application through bug reports and suggestions, in the system browser.
|
||||
|
||||
== Config file key/value pairs
|
||||
Under normal usage, these values are populated and toggled automatically in-app. This config file is partially compatible with DZTUI.
|
||||
|
||||
|
||||
[%autowidth]
|
||||
|===
|
||||
|Key|Value
|
||||
|
||||
|`api_key`|the API key generated at BattleMetrics. See <<Setup>>
|
||||
|`whitelist`|comma-separated list of server IDs from BattleMetrics; integer-values only
|
||||
|`fav`|server to display in the `Fav` field and to quick-connect to (must be one only); integer-values only
|
||||
|`name`|an arbitrary "handle" name used to identify the player on a server (required by some servers)
|
||||
|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports)
|
||||
|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch
|
||||
|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted
|
||||
|`term`|the preferred terminal emulator. This key is deprecated.
|
||||
|`auto_install`|permissible values are 0, 1, and 2. These are set internally depending on if the user enabled auto mod installation
|
||||
|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable
|
||||
|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch
|
||||
|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports)
|
||||
|`default_steam_path`|the path to the default Steam client installation
|
||||
|`ip_list`|array of server addresses; a concatenation of the IP/GamePort/Queryport
|
||||
|`fav_server`|server to display in the `Fav` field and to quick-connect to (must be one only); a concatenation of the IP/Gameport/Queryport
|
||||
|`fav_label`|the human-readable name of the fav server set above
|
||||
|`name`|a custom "handle" name used to identify the player on a server (required by some servers)
|
||||
|`preferred_client`|whether the user prefers native Steam or Flatpak. This value is only set if concurrent installations are found on the system
|
||||
|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted
|
||||
|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable
|
||||
|===
|
||||
|
||||
== Troubleshooting/FAQ
|
||||
|
|
@ -473,3 +500,6 @@ Tracked down several highly obscure but key bugs in the early development of the
|
|||
.StevelDusa
|
||||
Played a critical role in the elaboration of many of the features we now take for granted by being an early beta tester who not only reported bugs, but
|
||||
helped workshop and brainstorm various ideas that turned into QOL features.
|
||||
|
||||
.Thiughtduck216
|
||||
Contributed extensive beta testing of Steam Deck builds and provided ongoing troubleshooting for Steam Deck users
|
||||
|
|
|
|||
|
|
@ -89,23 +89,27 @@ echo 'vm.max_map_count=1048576' | sudo tee /etc/sysctl.d/dayz.conf
|
|||
. **Enable a Proton version ≥ `6.8` (or use Experimental) in the `Compatibility` field of the game's right-click options.**
|
||||
|
||||
=== API key & server IDs
|
||||
==== BattleMetrics API key
|
||||
1. Register for an API key at https://www.battlemetrics.com/account/register?after=%2Fdevelopers[BattleMetrics] (free)
|
||||
2. From the **Personal Access Tokens** area, Select **New Token**
|
||||
3. Give the token any name in the field at the top
|
||||
4. Leave all options **unchecked** and scroll to the bottom, select **Create Token**
|
||||
5. Copy the access token for later use (see below). This is the unique token you will use to query servers.
|
||||
|
||||
==== Steam API key
|
||||
==== Steam API key (required)
|
||||
1. Register for a https://steamcommunity.com/dev/apikey[Steam API key] (free) using your Steam account. You will be asked for a unique URL for your app when registering.
|
||||
2. Since this key is for a personal use application and does not actually call back anywhere, set a generic local identifier here like "127.0.0.1" or some other name that is meaningful to you.
|
||||
3. Once configured, you can insert this key in the app when launching it for the first time.
|
||||
|
||||
==== BattleMetrics API key (optional)
|
||||
|
||||
This step is optional. Using this key in conjunction with the above allows you to connect to and query servers by ID instead of by IP. See <<Add server by ID>>.
|
||||
|
||||
1. Register for an API key at https://www.battlemetrics.com/account/register?after=%2Fdevelopers[BattleMetrics] (free)
|
||||
2. From the **Personal Access Tokens** area, Select **New Token**
|
||||
3. Give the token any name in the field at the top
|
||||
4. Leave all options **unchecked** and scroll to the bottom, select **Create Token**
|
||||
5. 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 for the first time.
|
||||
|
||||
=== First-time launch
|
||||
|
||||
0. It is always advised to have Steam running in the background. DZGUI is meant to run "on top of" Steam.
|
||||
0. It is always advised to have Steam running in the background. DayZ is meant to run "on top of" Steam.
|
||||
|
||||
1. DZGUI can be launched one of two ways.
|
||||
1. DZGUI can be launched one of two ways.
|
||||
|
||||
**From the terminal:**
|
||||
|
||||
|
|
@ -113,24 +117,23 @@ echo 'vm.max_map_count=1048576' | sudo tee /etc/sysctl.d/dayz.conf
|
|||
./dzgui.sh
|
||||
```
|
||||
|
||||
Launching from the terminal gives more verbose information in the event of a crash,
|
||||
and can be a good way of troubleshooting problems.
|
||||
Launching from the terminal gives more verbose information in the event of a crash, and can be a good way of troubleshooting problems.
|
||||
|
||||
**From the shortcut shipped with the application** (if using a desktop environment based on the Freedesktop specification):
|
||||
|
||||
- Located under the "Games" category of your system's applications list.
|
||||
- Via the DZGUI desktop shortcut (Steam Deck only)
|
||||
- Via the "DZGUI" desktop shortcut (Steam Deck only)
|
||||
|
||||
[start=2]
|
||||
2. Follow the menu prompts given by the app. You will be asked to provide:
|
||||
|
||||
- Player name (a generic handle, required by some servers)
|
||||
- BM API key (see above)
|
||||
- Steam API key
|
||||
- Steam API key (required)
|
||||
- BM API key (optional)
|
||||
|
||||
==== Steam path discovery
|
||||
|
||||
DZGUI will then attempt to locate your default Steam installation and DayZ path. You *must* have DayZ installed in your Steam library in order to proceed. (It can be installed to any drive of your choosing.)
|
||||
DZGUI will now attempt to locate your default Steam installation and DayZ path. You *must* have DayZ installed in your Steam library in order to proceed. (It can be installed to any drive of your choosing.)
|
||||
If DZGUI cannot find Steam or cannot find DayZ installed at the detected Steam path, it will prompt you to manually specify the path to your Steam installation.
|
||||
|
||||
Specify the top-level entry point to Steam, not DayZ. E.g.,
|
||||
|
|
@ -153,15 +156,15 @@ For GTK 3, invoke the command:
|
|||
|
||||
DZGUI can be added to Steam as a "non-Steam game" in order to facilitate integration with Steam Deck or desktop environments.
|
||||
|
||||
1. Launch Steam in the "Large" view.
|
||||
1. Launch Steam in the "Large" view.
|
||||
|
||||
[NOTE]
|
||||
Steam Deck: you must switch to "Desktop Mode" and launch Steam from the desktop.
|
||||
Steam Deck: you must switch to "Desktop Mode" and launch Steam from the desktop. Steam Deck Game Mode does not support keyboard entry on some third party apps.
|
||||
|
||||
[start=2]
|
||||
2. Select **Add a Game** > **Add a Non-Steam Game** from the lower left-hand corner.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/01.png[01,500]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/01.png[01,500]
|
||||
|
||||
[start=3]
|
||||
3. Navigate to `$HOME/.local/share/applications/` and select `dzgui.desktop`
|
||||
|
|
@ -190,7 +193,7 @@ Updating the artwork:
|
|||
|
||||
1. Navigate to the app's details page and right-click the blank image header at the top.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/03.png[03,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/03.png[03,700]
|
||||
|
||||
[start=2]
|
||||
2. Select **Set Custom Background**
|
||||
|
|
@ -198,12 +201,12 @@ image::https://github.com/aclist/dztui/raw/testing/images/tutorial/03.png[03,700
|
|||
4. Navigate to the artwork path described above and select `hero.png`.
|
||||
5. Next, right-click the image background and select **Set Custom Logo**.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/04.png[04,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/04.png[04,700]
|
||||
|
||||
[start=5]
|
||||
5. Navigate to the same path and select `logo.png`. Notice that this removes the redundant app name that occluded the image.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/05.png[05,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/05.png[05,700]
|
||||
|
||||
[start=6]
|
||||
6. Next, navigate to your Library index (looks like a bookshelf of cover art) and find the DZGUI app.
|
||||
|
|
@ -211,12 +214,12 @@ image::https://github.com/aclist/dztui/raw/testing/images/tutorial/05.png[05,700
|
|||
[start=7]
|
||||
7. Right-click its cover and select **Manage** > **Set custom artwork**.
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/06.png[06,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/06.png[06,700]
|
||||
|
||||
[start=8]
|
||||
8. Navigate to the same path and select `grid.png`. The final result:
|
||||
|
||||
image::https://github.com/aclist/dztui/raw/testing/images/tutorial/07.png[07,700]
|
||||
image::https://github.com/aclist/dztui/raw/dzgui/images/tutorial/07.png[07,700]
|
||||
|
||||
|
||||
=== Updating the app
|
||||
|
|
@ -237,11 +240,11 @@ Script:
|
|||
```
|
||||
<path to script><script name>.old
|
||||
```
|
||||
E.g., if DZGUI is named `dzgui`, in the path `$HOME/bin`, it will be located at
|
||||
E.g., if DZGUI is named `dzgui`, in the path `$HOME/bin`, the backup will be located at
|
||||
```
|
||||
$HOME/bin/dzgui.old
|
||||
```
|
||||
If launching DZGUI via its system shortcut, the backup file (similarly for log files) will be located under:
|
||||
If launching DZGUI via its system shortcut, the backup file will be located under:
|
||||
|
||||
```
|
||||
$HOME/.local/share/dzgui
|
||||
|
|
@ -256,12 +259,13 @@ $HOME/.config/dztui/dztuirc.old
|
|||
== Usage
|
||||
Select from among the <<Menu options>> below.
|
||||
|
||||
Connecting to a server consists of fetching metadata for the server IDs you have previously saved/are searching for.
|
||||
Connecting to a server consists of fetching metadata for the server(s) you are searching for.
|
||||
|
||||
DZGUI will check the server's modset against your local mods. If you are missing any,
|
||||
it will prompt you to download them through the Steam Workshop and open a window in the background in the system browser.
|
||||
|
||||
Open each link and click Subscribe to schedule these for download.
|
||||
|
||||
[NOTE]
|
||||
You must be logged into Steam for mod changes to take effect.
|
||||
It can take some time for the subscribed mods to download and update.
|
||||
|
|
@ -277,8 +281,7 @@ These servers can be filtered by various parameters in order to display a more g
|
|||
|
||||
After a server is selected from the list, the application continues to the mod validation step.
|
||||
|
||||
[NOTE]
|
||||
It is not currently possible to save servers from the full server browser.
|
||||
Prior to connecting, DZGUI will prompt you if you want to add this server to your <<My servers>>.
|
||||
|
||||
===== Filters
|
||||
|
||||
|
|
@ -337,23 +340,38 @@ after selecting the initial server.
|
|||
==== Quick connect to favorite server
|
||||
Bypasses the server list and quick-connects to a single favorite server specified in advance using the <<Add favorite server>> option.
|
||||
|
||||
==== Connect by ID
|
||||
Requires a BM API key. Use the https://www.battlemetrics.com/servers/dayz[BattleMetrics site] to find servers of interest (proximity, player count, rules, etc.)
|
||||
|
||||
Each server has a unique ID. This is the string of numbers at the end of the URL. Copy these IDs.
|
||||
For example, in the URL https://www.battlemetrics.com/servers/dayz/8039514, the ID is `8039514`.
|
||||
|
||||
Enter the ID of a server to have it translated to an IP. After this step, the process continues as though you were connecting by IP.
|
||||
|
||||
==== Connect by IP
|
||||
Instead of relying on server IDs, returns the list of maps behind a given IP.
|
||||
Provide only the IP; no port is necessary. This returns the server metadata for you to verify before connecting.
|
||||
|
||||
If there are multiple maps hosted behind an IP (e.g. different maps on varying ports), the application will list all of them.
|
||||
If there are multiple maps hosted behind an IP (e.g. different maps on varying ports), the application will list all of them for you to choose from.
|
||||
|
||||
==== Recent servers
|
||||
This feature queries the history file for the last 10 servers connected to by any means
|
||||
(server browser, favorite servers, connect-by-IP, etc.).
|
||||
|
||||
==== Add server by ID
|
||||
Use the https://www.battlemetrics.com/servers/dayz[BattleMetrics site] to find servers of interest (proximity, player count, rules, etc.)
|
||||
Requires a BM API key. Use the https://www.battlemetrics.com/servers/dayz[BattleMetrics site] to find servers of interest (proximity, player count, rules, etc.)
|
||||
|
||||
Each server has a unique ID. This is the string of numbers at the end of the URL. Copy these IDs.
|
||||
For example, in the URL https://www.battlemetrics.com/servers/dayz/8039514, the ID is `8039514`.
|
||||
|
||||
An indefinite number of servers can be added. These will be listed when using the <<My servers>> option.
|
||||
Servers you add will be saved and listed when using the <<My servers>> option.
|
||||
|
||||
==== Add server by IP
|
||||
Like the above, only using the direct IP of the server in question.
|
||||
|
||||
Provide only the IP; no port is necessary. This returns the server metadata for you to verify before connecting.
|
||||
|
||||
If there are multiple maps hosted behind an IP (e.g. different maps on varying ports), the application will list all of them for you to choose from.
|
||||
|
||||
==== Add (change) favorite server
|
||||
Prompts you to add/change a favorite server to the config file by ID. The name of the server will be updated in the header of the app. This server is used when selecting the <<Quick connect to favorite server>> option. If a favorite server is already enabled, this option switches to "Change favorite server."
|
||||
|
|
@ -377,23 +395,27 @@ The app ships with the stable branch enabled, with the testing branch being used
|
|||
===== Toggle debug mode
|
||||
Toggles debug mode, which is used to perform dry-runs and output what parameters would have been used to connect to a server.
|
||||
|
||||
===== Generate debug log
|
||||
Writes a list of your current settings to a local file that can be pasted into bug reports.
|
||||
|
||||
===== Toggle auto mod install
|
||||
This feature is experimental. It attempts to queue the mods requested for download
|
||||
automatically, rather than prompting the user to subscribe to each one.
|
||||
This feature is experimental. It attempts to queue the mods requested for download automatically, rather than prompting the user to subscribe to each one.
|
||||
|
||||
Both `wmctrl` and `xdotool` must be installed to use this feature.
|
||||
|
||||
[NOTE]
|
||||
When using auto mod installation, the mods will not appear as subscribed to in the Steam Workshop.
|
||||
When using auto mod installation, the mods may not appear as subscribed to in the Steam Workshop.
|
||||
DZGUI tracks their version internally and will trigger an update if necessary the next time you
|
||||
attempt to connect.
|
||||
|
||||
===== Change player name
|
||||
Used to change the in-game player name that is broadcast when on servers.
|
||||
|
||||
===== Output system info
|
||||
Writes a list of your current settings and system configuration to a local file that can be pasted into bug reports.
|
||||
|
||||
===== Force update local mods
|
||||
A convenience function that attempts to redownload all local mods. Can be used in the event of corruption
|
||||
or file integrity issues. In conjunction with the <<Toggle auto mod install>> feature, this feature is experimental.
|
||||
|
||||
Attempts to refresh the version of all local mods to the newest version by checking remote mod hashes and requesting updates from Steam.
|
||||
|
||||
This is a convenience feature that attempts to redownload all local mods. Can be used in the event of corruption or file integrity issues. In conjunction with the <<Toggle auto mod install>> feature, this feature is experimental.
|
||||
|
||||
==== Help file
|
||||
Uses xdg-open to open this documentation in the system browser.
|
||||
|
|
@ -404,26 +426,31 @@ Uses xdg-open to open the https://github.com/aclist/dztui/issues[bug tracker] in
|
|||
==== Forum
|
||||
Uses xdg-open to open the https://github.com/aclist/dztui/discussions[discussion forum] in the system browser.
|
||||
|
||||
==== Sponsor
|
||||
Uses xdg-open to open the https://github.com/sponsors/aclist[sponsor page], where you can help fund development, in the system browser.
|
||||
|
||||
==== Hall of fame
|
||||
Uses xdg-open to open the https://aclist.github.io/dzgui/dzgui#_hall_of_fame[Hall of Fame], which recognizes those who actively contributed to the betterment of the application through bug reports and suggestions, in the system browser.
|
||||
|
||||
== Config file key/value pairs
|
||||
Under normal usage, these values are populated and toggled automatically in-app. This config file is partially compatible with DZTUI.
|
||||
|
||||
|
||||
[%autowidth]
|
||||
|===
|
||||
|Key|Value
|
||||
|
||||
|`api_key`|the API key generated at BattleMetrics. See <<Setup>>
|
||||
|`whitelist`|comma-separated list of server IDs from BattleMetrics; integer-values only
|
||||
|`fav`|server to display in the `Fav` field and to quick-connect to (must be one only); integer-values only
|
||||
|`name`|an arbitrary "handle" name used to identify the player on a server (required by some servers)
|
||||
|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports)
|
||||
|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch
|
||||
|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted
|
||||
|`term`|the preferred terminal emulator. This key is deprecated.
|
||||
|`auto_install`|permissible values are 0, 1, and 2. These are set internally depending on if the user enabled auto mod installation
|
||||
|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable
|
||||
|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch
|
||||
|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports)
|
||||
|`default_steam_path`|the path to the default Steam client installation
|
||||
|`ip_list`|array of server addresses; a concatenation of the IP/GamePort/Queryport
|
||||
|`fav_server`|server to display in the `Fav` field and to quick-connect to (must be one only); a concatenation of the IP/Gameport/Queryport
|
||||
|`fav_label`|the human-readable name of the fav server set above
|
||||
|`name`|a custom "handle" name used to identify the player on a server (required by some servers)
|
||||
|`preferred_client`|whether the user prefers native Steam or Flatpak. This value is only set if concurrent installations are found on the system
|
||||
|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted
|
||||
|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable
|
||||
|===
|
||||
|
||||
== Troubleshooting/FAQ
|
||||
|
|
@ -473,3 +500,6 @@ Tracked down several highly obscure but key bugs in the early development of the
|
|||
.StevelDusa
|
||||
Played a critical role in the elaboration of many of the features we now take for granted by being an early beta tester who not only reported bugs, but
|
||||
helped workshop and brainstorm various ideas that turned into QOL features.
|
||||
|
||||
.Thiughtduck216
|
||||
Contributed extensive beta testing of Steam Deck builds and provided ongoing troubleshooting for Steam Deck users
|
||||
|
|
|
|||
50
helpers/query.py
Normal file
50
helpers/query.py
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
import sys
|
||||
import a2s
|
||||
import math
|
||||
import json
|
||||
from a2s import dayzquery
|
||||
sys.path.append('a2s')
|
||||
|
||||
def get_info(ip, qport):
|
||||
try:
|
||||
info = a2s.info((ip, int(qport)))
|
||||
|
||||
name = info.server_name
|
||||
address = ip + ":" + str(info.port)
|
||||
count = str(info.player_count) + "/" + str(info.max_players)
|
||||
keywords = info.keywords
|
||||
ping = (info.ping*1000)
|
||||
ping = math.floor(ping)
|
||||
|
||||
res = {}
|
||||
|
||||
res['name'] = name
|
||||
res['address'] = address
|
||||
res['count'] = count
|
||||
res['keywords'] = keywords
|
||||
res['stat'] = "online"
|
||||
res['qport'] = qport
|
||||
res['ping'] = str(ping) + "ms"
|
||||
|
||||
j = json.dumps(res)
|
||||
|
||||
print(j)
|
||||
except:
|
||||
sys.exit(1)
|
||||
|
||||
def get_rules(ip, qport):
|
||||
try:
|
||||
mods = dayzquery.dayz_rules((ip, int(qport))).mods
|
||||
for k in mods:
|
||||
print(k.workshop_id)
|
||||
except:
|
||||
sys.exit(1)
|
||||
|
||||
ip = sys.argv[1]
|
||||
qport = sys.argv[2]
|
||||
mode = sys.argv[3]
|
||||
match mode:
|
||||
case "info":
|
||||
get_info(ip, qport)
|
||||
case "rules":
|
||||
get_rules(ip, qport)
|
||||
2
news
2
news
|
|
@ -1 +1 @@
|
|||
NEWS: Fedora 38 users: a bug in a Fedora package is causing menu dialogs to crash. This has been reported to GNOME developers.
|
||||
NEWS: Major 4.0.0 update. Full details via the View Changelog menu option.
|
||||
Loading…
Reference in a new issue