diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..1f2ae3f --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: aclist diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a9738f..81b7149 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## 4.1.0 2023-12-03 +## Added +- Virtual keyboard support for text entry fields on Steam Deck Game Mode +- Validate 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 @@ -46,7 +59,7 @@ from source or waiting until the latest version is merged into Fedora's package - 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 +## [3.3.0] 2023-05-16 ### Added - Fetch more inclusive global "players in-game" count - List mod directory on installed mods list @@ -68,440 +81,231 @@ from source or waiting until the latest version is merged into Fedora's package - 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.3.0-rc.24] 2023-05-10 +## [3.2.10] 2023-05-11 ### Fixed -- Return from lockfile function if first time setup is not complete +- Return from lockfile function if first-time setup has not been run +- Sanitize inputs when using file picker +- Require both wmctrl and xdotool -## [3.3.0-rc.23] 2023-05-10 -### Fixed -- Display correct players in-game count +## [3.2.9] 2023-05-10 ### Changed -- Make file picker method more robust +- Reword button to "Choose path manually" instead of "Retry" -## [3.3.0-rc.22] 2023-05-10 +## [3.2.7] 2023-05-10 ### Changed -- Display canonical dir name of mods in list installed mods menu +- Better sudo escalation within zenity dialogs if vm map count is too small -## [3.3.0-rc.21] 2023-05-10 +## [3.2.6] 2023-05-10 ### Fixed -- Hardening of beta client targeting function to avoid false positives +- Don't parse Flatpak symlinks when setting up default Steam path -## [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 +## [3.2.5] 2023-05-07 ### Fixed -- Case folding when targeting WM_CLASS +- Require sudo when checking vm map count -## [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 +## [3.2.4] 2023-03-01 ### Fixed - BM API returning stale query port and preventing fetching modlist -## [3.3.0-rc.12] 2023-01-19 +## [3.2.3] 2023-02-17 ### 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 +- 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.3.0-rc.11] 2023-01-01 +## [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 -- History menu not parsing ports correctly - Validate BM key on initial setup +- Fix history menu not parsing query ports correctly ### 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 +## [3.1.4] 2022-12-10 ### Fixed -- Merge Python version hotfix from stable branch +- Issue #43: Hotfix for workspace-driven WMs -## [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 +## [3.1.3] 2022-12-06 ### Fixed -- Include /run in auto-discovery routine +- Explicitly require Python 3 -## [3.1.0-rc.19] 2022-12-02 +## [3.1.1-2] 2022-12-03 ### Fixed -- Use Steam-safe local zenity version +- Fix lockfile path -## [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 +## [3.1.0] 2022-12-03 ### Added - Recent connect history -- Force refresh local mods -### Changed -- More verbose messages regarding automod installation +- 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 mode +- 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.1.0-rc.10] 2022-11-09 +## [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 -- 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 +## [3.0.5] 2022-10-27 ### Fixed -- Download mod metadata +- Properly create .desktop file on desktop PCs -## [3.1.0-rc.5] 2022-10-25 +## [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 -- 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 +- Foreground progress of manual mod subscriptions +- Automatic mod helper through steamcmd +- Forum link +- Enforce Steam API ### 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 +- Stop retrieving extra metadata from BM ### 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 +- Reorder main menu +- More verbose error messages +- Better abstraction of URLs ### Fixed -- Bug with normal mode not launching after closing progress bar +- Width and text of some popups on Steam Deck -## [2.7.0-rc.26] 2022-10-04 +## [2.7.2] 2022-10-07 ### Fixed -- Delete server list array not being emptied when going back to main menu +- 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 -- Progress bars when downloading updates +- 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 categories -### Fixed -- Encapsulate window strings to prevent arguments leaking into title -- Remove extraneous download process that was slowing down startup +- Group main menu entries in advance of future functionality +- Better abstraction of paths +- Clarification of certain options and errors -## [2.7.0-rc.23] 2022-10-03 +## [2.6.3] 2022-10-02 ### Fixed -- More robust error handling for API keys +- Hotfix for connect-to-fav not getting modlist -## [2.7.0-rc.22] 2022-10-02 +## [2.6.2] 2022-10-02 ### Fixed -- Merge stable branch hotfixes +- Hotfix for BM API returning malformed publishedfileids -## [2.7.0-rc.21] 2022-10-01 +## [2.6.1] 2022-09-25 ### Fixed -- Clarify some menu messages and behavior +- Freedesktop shortcut errors -## [2.7.0-rc.20] 2022-09-29 +## [2.6.0] 2022-09-05 ### Added -- List total disk size used on mods list +- Connect by IP method -## [2.7.0-rc.19] 2022-09-26 +## [2.5.1] 2022-08-17 ### Fixed -- Strip text from "all maps" option in header +- Hotfix for malformed paths during first-time setup + +## [2.5.0] 2022-08-16 +### Added +- Lockfile: prevent concurrent instances of DZGUI from being opened -## [2.7.0-rc.18] 2022-09-26 ### Changed -- Move lockfile check earlier in pipeline -- Reword "All maps" filter option +- Faster path discovery on first-time setup + ### Fixed -- Store player and server count sooner +- Symlink collision on servers with many mods +- API response pagination for large server lists -## [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 +## [2.4.1] 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 +## [2.4.0] 2022-08-07 ### Added -- Steam Deck artwork +- 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 -## [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 +- 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 -### Added -- Prototype .desktop file for Steam Deck -- Generate bug report logs summarizing local settings -### Dropped -- Deprecated functions +- Better Steam Deck detection and handling +- Prevent garbage in error messages +- Miscellaneous backend improvements -## [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 +### Changed - 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 +## [2.3.2] 2022-08-04 ### Fixed -- Prevent garbage in dependency check messages -- Send browser to background when opening links +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 -- 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 +- Prompt user to restart first-time setup if broken config is found ## [2.3.0] 2022-07-18 ### Added diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index b7c262a..51a6ff0 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,19 @@ ## What this is +DZGUI is a GUI version of [DZTUI](https://github.com/aclist/dztui/tree/dztui) for Linux. -A GUI version of [DZTUI](https://githubom/aclist/dztui) for Linux. Used to list official and community server details and quick connect to preferred servers by staging mods and concatenating launch options automatically. +Note: development of DZTUI has stopped and has been replaced with DZGUI. DZGUI allows you to connect to both official and modded/community DayZ servers on Linux and provides a graphical interface for doing so. This overcomes certain limitations in the Linux client and helps prepare the game to launch by doing the following: -1. Display server metadata in a table (server name, player count, ping, current gametime, distance, IP) -2. Find and prepare mods being requested by the server (choose from manual or automatic installation) -3. Concatenate launch options to pass to Steam +1. Search for and display server metadata in a table (server name, player count, ping, current gametime, distance, IP) +2. Add/delete/manage favorite servers by IP or ID +3. Find and prepare mods being requested by the server (choose from manual or automatic installation) +4. Concatenate launch options to pass to Steam + +Other options include the ability to connect by IP or ID or set a favorite server. ## Setup and usage Refer to the [manual](https://aclist.github.io/dzgui/dzgui.html) for installation and setup instructions, a feature-by-feature breakdown, and Steam integration tutorials. -![Alt text](example.png) - -## Attribution -A subset of geolocation data was sourced from DB-IP under a Creative Commons Attribution 4.0 International License. - -## Acknowledgments -Special thanks to the following users for going above and beyond in beta testing and finding obscure bugs. - -- fossean -- scandalouss -- SteveIDusa -- The_Axelrod +![Alt text](/images/example.png) diff --git a/docs/dzgui.adoc b/docs/dzgui.adoc index 4b2b12d..312c3b6 100644 --- a/docs/dzgui.adoc +++ b/docs/dzgui.adoc @@ -3,7 +3,7 @@ :stylesheet: custom.css = DZGUI documentation -DayZ official/community server graphical launcher for Linux | Last updated: 2023-05-15 +DayZ official/community server graphical launcher for Linux | Last updated: {d} Click https://aclist.github.io/dzgui/dzgui_dark.html[here] for dark mode @@ -34,7 +34,7 @@ If any dependencies are missing when the application starts, it will warn you, s Automatic method: generic OS (skip to step 3 below when complete) ``` -curl -s "https://raw.githubusercontent.com/aclist/dztui/main/install.sh" | bash +curl -s "https://raw.githubusercontent.com/aclist/dztui/dzgui/install.sh" | bash ``` Automatic method: nix-based systems (contributed by lelgenio) diff --git a/docs/dzgui_dark.adoc b/docs/dzgui_dark.adoc index 6db172a..3cc4eb1 100644 --- a/docs/dzgui_dark.adoc +++ b/docs/dzgui_dark.adoc @@ -3,7 +3,7 @@ :stylesheet: dark.css = DZGUI documentation -DayZ official/community server graphical launcher for Linux | Last updated: 2023-05-15 +DayZ official/community server graphical launcher for Linux | Last updated: {d} Click https://aclist.github.io/dzgui/dzgui.html[here] for light mode @@ -34,7 +34,7 @@ If any dependencies are missing when the application starts, it will warn you, s Automatic method: generic OS (skip to step 3 below when complete) ``` -curl -s "https://raw.githubusercontent.com/aclist/dztui/main/install.sh" | bash +curl -s "https://raw.githubusercontent.com/aclist/dztui/dzgui/install.sh" | bash ``` Automatic method: nix-based systems (contributed by lelgenio) diff --git a/dzgui.adoc b/dzgui.adoc deleted file mode 100644 index d66ed7c..0000000 --- a/dzgui.adoc +++ /dev/null @@ -1,446 +0,0 @@ -:nofooter: -:toc: left -:stylesheet: custom.css - -= DZGUI documentation -DayZ official/community server graphical launcher for Linux | Last updated: 2023-05-15 - -Click https://aclist.github.io/dzgui/dzgui_dark.html[here] for dark mode - -== What this is -A GUI version of https://github.com/aclist/dztui[DZTUI] for Linux. -Used to list official and community server details and quick connect to preferred servers -by staging mods and concatenating launch options automatically. - -Development on DZTUI (terminal client) has stopped at this time. -Instead, DZGUI brings numerous functionality and security improvements and is intended to be a more user-friendly, -turnkey solution for graphical desktop environments, and can also be used on the Steam Deck or similar devices. - -== Setup -=== 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` -- `zenity` -- `steam` -- `wmctrl` or `xdotool` - -=== Preparation -. **Download DZGUI and make it executable:** - -Automatic method: generic OS (skip to step 3 below when complete) - -``` -curl -s "https://raw.githubusercontent.com/aclist/dztui/main/install.sh" | bash -``` - -Automatic method: nix-based systems (contributed by lelgenio) - -Follow the instructions at https://github.com/lelgenio/dzgui-nix to ingest the package and dependencies -into your system using flakes. - -Manual method - -``` -git clone https://github.com/aclist/dztui.git -chmod +x dzgui.sh -``` - -''' -[start=2] -. **Update the `vm.max_map_count` value (see https://www.protondb.com/app/221100)** - -**Automatic method:** - -This is handled automatically by DZGUI if you just choose to run the application out of the box. -You will be prompted for your sudo password in order to check whether the system map count is too small. -This is a one-time check that will not be triggered again once the map count is updated. -If you used the automatic method, you can skip to Step 3 below. - -This process writes the count to the file `/etc/sysctl.d/dayz.conf`. - -If the map count was lower than the threshold, it is updated to 1048576. -If the system map count was already higher, that value is interpolated into this file as a redundancy check. - -[NOTE] -If, for reasons unrelated to DayZ, you choose at a later time to raise your system map count higher than it originally was and -you find that the count is not sticking, check for the presence of the `dayz.conf` file to see if it is taking precedence and delete it accordingly. - -**Ephemeral method:** -the map count will revert after the system is rebooted. - -``` -sudo sysctl -w vm.max_map_count=1048576 -``` - -**Persistent method:** -``` -echo 'vm.max_map_count=1048576' | sudo tee /etc/sysctl.d/dayz.conf -``` - -[start=3] -. **Prepare a Steam account with a DayZ license** -. **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 -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. - -=== First-time launch - -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. - -**From the terminal:** - -``` -./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. - -**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) - -[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 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.) -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., - -`/media/mydrive/Steam`, not `/media/mydrive/Steam/steamapps/common/DayZ` - -If your Steam installation is in a hidden folder but the file picker dialog does not show hidden folders, ensure that your GTK settings are set to show hidden files. - -For GTK 2, edit the file below so that `ShowHidden=true`: - -`~/.config/gtk-2.0/gtkfilechooser.ini` - -For GTK 3, invoke the command: - -`gsettings set org.gtk.Settings.FileChooser show-hidden true` - -=== Steam integration & artwork - -==== Adding to steam - -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. - -[NOTE] -Steam Deck: you must switch to "Desktop Mode" and launch Steam from the desktop. - -[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] - -[start=3] -3. Navigate to `$HOME/.local/share/applications/` and select `dzgui.desktop` -4. Select **Add Selected Programs**. - -==== Controller layout - -An official controller layout for Steam Deck is available in the Steam community layouts section. Search for "DZGUI Official Config" to download it. Long-press the View button and Select button (☰) to toggle D-pad navigation. This creates an additional layer that lets you navigate through menus using the D-pad and A/B to respectively confirm selections and go back. Remember to toggle this layer off again after launching your game to revert back to the master layer. - -==== Artwork - -The application also ships with Steam cover artwork. It is located under: - -``` -$HOME/.local/share/dzgui -``` - -The artwork consists of four parts: - -1. Grid: a vertical "box art" grid used on library pages -2. Hero: a large horizontal banner used on the app's details page -3. Logo: a transparent icon used to remove Steam's default app text -4. dzgui: used by freedesktop shortcut to generate a desktop icon; not intended for the user - -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] - -[start=2] -2. Select **Set Custom Background** -3. Select to display All Files from the File type dropdown -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] - -[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] - -[start=6] -6. Next, navigate to your Library index (looks like a bookshelf of cover art) and find the DZGUI app. - -[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] - -[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] - - -=== Updating the app -If DZGUI detects a new upstream version, it will prompt you to download it automatically. -It backs up the original version before fetching the new one, then updates your config file with your existing values. Once finished, it will ask you to relaunch the app. - -If you decline to upgrade to the new version, DZGUI will continue to the main menu with the current version. - -[NOTE] -New versions may include changes to bugs that could prevent you from playing on certain servers. -Upgrading is always advised. - -If you experience a problem or need to restore the prior version of DZGUI and/or your configs, -it is enough to simply replace the new version with the old one and relaunch the app. -The files can be found at: - -Script: -``` -