docs: add history file

HISTORY.md

@@ -0,0 +1,119 @@
+# History of the project
+This file collects notable milestones and events related to DZGUI, mainly around DZGUI as a framework and the history of development.
+A chronological summary of features can be found in CHANGELOG.md.
+
+## 2021
+### 2021-12-03: DayZ adds support for Battleye over Proton
+DayZ was among a handful of games with whitelisted anti-cheat support under Valve's emerging WINE-based Proton compatibility layer.
+While adding anti-cheat compatibility at a technical level, this change did not actually allow the client to connect to servers running complex modlists.
+
+Development of the precursor to DZGUI began at around this time.
+
+### 2021-12-12: initial version of DZTUI is created
+DZTUI, a Bash script and terminal user interface, was the precursor to DZGUI.
+This was an initial attempt at bootstrapping the Steam client to handle mods correctly when launching DayZ.
+Due to user interest, features continued to be added. This early tool is archived under the 'dztui' branch.
+
+## 2022
+### 2022-05-09: addition of zenity GUI and project name change (DZGUI)
+With the introduction of the Steam Deck, more users wanted a graphical user interface
+to interact with DZTUI. Being that DZTUI was purely a Bash script, a method of
+drawing menus was needed, so the 'zenity' package was used to create prefabricated dialogs.
+While this met the minimum requirement to show prompts and selectable options, no rich customization was possible.
+
+The introduction of zenity as a dependency marked the shift from "DZTUI" to "DZGUI".
+
+Throughout 2022, the limits of zenity for DZGUI's purposes were tested, particularly in the context of SteamOS.
+This led to the discovery of a number of bugs in zenity, GTK, and SteamOS, which were reported up to their respective channels.
+While this was improving the SteamOS user experience, it started to become clear that a fully custom UI was needed.
+
+This barebones version of DZGUI sufficed for some time, with the Bash script and some standalone Python modules doing the heavy lifting,
+and this period served to surface a number of bugs and interesting interactions with the Steam client.
+
+## 2023
+### 2023-11-23: Python 3.10 dependency
+Prior to this time, DZGUI open-endedly allowed you to use any Python version for its modules, without any significant handling for
+the idiosyncrasies of different versions. A minimum requirement of Python 3.10 was thus instituted to normalize expected behavior.
+
+Throughout 2023, various features related to server browsing were added, such as filters and more granular search parameters.
+
+There were still a lot of unknowns at this time, so things were being resolved through trial and error.
+
+## 2024
+### 2024-01-31: DZGUI 5 API introduces GTK UI
+Using zenity as a simple GUI had exposed some bugs and limitations in that package, particularly when trying to push huge lists of server records
+into tables and sorting them in a performant manner.
+
+Around this time it became clear that a more robust UI framework was needed. While keeping the original Bash script and Python modules for
+background processing, PyGObject (GTK) was added to the project in order to ship a custom UI that could be designed from the ground up.
+
+However, it should be noted that at this point, the DZGUI logic itself was still a (increasingly large) Bash script to which a GTK UI had been stitched on.
+These were totally separate components, with UI actions on the GTK side triggering calls to Bash functions in an overly complex helper file.
+The UI was basically a thin client around the old Bash logic, but this was still a far cry from an integrated application with proper signals and dedicated components.
+
+Effectively, DZGUI 5 through 6 were a stepping stone that set the groundwork to go from DZGUI 4 (pure Bash script) to
+DZGUI 7 (standalone Python application). Today, little of DZGUI 5's original logic remains outside of the basic UI grid.
+
+### 2024-10-15: Frostline DLC released, widespread parsing problems
+DayZ's first DLC introduced a new format for server responses that packed extra metadata into the A2S_RULES format.
+Upon its release, all third-party DayZ launchers and server listing web sites were unable to parse the mod information being returned from Frostline servers.
+
+For a period of two weeks, this remained unsolved and various attempts were made to understand the updated specification.
+
+### 2024-10-30: DZGUI hotfix adds support for Frostline servers
+DZGUI was the first third-party tool to fix parsing for Frostline servers and restore functionality.
+This was a small milestone, because it meant DZGUI was evolving from a "dumb" launcher to a featureful tool
+touching upon and improving all aspects of the end-to-end DayZ experience.
+
+Particularly around this time, the sheer diversity of needs of modders, server operators, and players started to become clear.
+Users had highly specific and diverse use cases for setting up their game environment, and requested a number of features to support that on
+the DZGUI side.
+
+## 2025
+### 2025-01-17: DZGUI 6 API
+With DZGUI 6, the difficult decision to enforce a Python 3.13 dependency was made.
+While the previous dependency was Python 3.10+, it was deemed better to develop against and target identical versions.
+
+However, due to the vagaries of managing Python environments on end-user systems, this change added unnecessary complexity and frustration.
+Users had to properly set up virtual environments, install the relevant dependencies, and create a wrapper script to run this version, whereas
+previous versions had essentially been point and click.
+
+### 2025-10-23: DZGUI 7 API and the "Ship of Theseus"
+It had become clear that the situation above was untenable and the legacy Bash script was unmaintainable given the project's enlarged scope.
+The lack of a robust testing or typehinting framework made it difficult to diagnose rare bugs.
+
+Shipping a standalone, turnkey application with zero or minimal dependencies was the most urgent priority.
+DZGUI was still carrying around small bits and pieces of the old Bash script logic, so the decision was made to
+refactor the application into a pure Python + GTK tool. This would effectively be a total rewrite of all logic,
+only preserving the most minimal skeleton of the original UI layout as a reference.
+
+Over the course of a year, a wholesale "Ship of Theseus" rewrite took place.
+Nearly every component of DZGUI 6, both API and UI side, was taken apart and replaced.
+
+A soft alpha and beta phase were used to iterate on this concept further. DZGUI 7 was increasingly recommended to users
+as the preferred choice. This allowed for keeping the established userbase on the (relatively) stable DZGUI 6 spec, while building up
+the new spec and making it available to more users as features were elaborated.
+
+Through late 2025, several LLM-generated applications that recycled significant parts of DZGUI's code without the applicable GPL license were found.
+The maintainers of those projects were advised to excise the offending segments or apply the necessary GPL licenses.
+
+## 2026
+### 2026-05-17: Switch to standalone releases
+The DZGUI 7 beta starts shipping standalone glibc builds with an integrated setup wizard and installer.
+
+# TODO: remarks on DZGUI 6 stable vs testing branch logic and "over the air" updates vs standalone builds
+# TODO: note archived branch names
+
+### 2026-10-27: 500 tickets closed
+The milestone of 500 tickets/PRs being closed was reached.
+
+2026 was by far DZGUI's most intensive year by commits, perhaps suggesting the scope of the rewrite:
+
+- 2021: 16
+- 2022: 434
+- 2023: 322
+- 2024: 347
+- 2025: 426
+- 2026: 1300
+
+DZGUI 7 is scheduled to release as a stable version within the year.

README.md

@@ -37,8 +37,6 @@ Users wishing to review the licenses to these components can inspect the `LICENS
 
 Steam and the Steam logo are trademarks and/or registered trademarks of Valve Corporation in the U.S. and/or other countries.
 
-DayZ is a trademark and brand of Bohemia Interactive a.s.
-
 ## Disclaimer
 
 DZGUI is beta-quality software and is provided as-is.

dzgui/config/query.py

@@ -5,7 +5,6 @@ from dzgui.util._json import read_json
 
 from dzgui.const.enum import Preferences
 
-
 class ConfigFileError(Exception):
     pass
 
@@ -40,4 +39,4 @@ def get_favorites(path: Path) -> list[str]:
 
 
 def enum_to_key(enum: Preferences) -> str:
-    return str(enum.key)
+    return str(enum.dict["key"])

dzgui/const/enum.py

@@ -1,9 +1,7 @@
-from __future__ import annotations
-from dataclasses import dataclass
 from enum import Enum
+from typing import Any, Self
 
 from dzgui.util import strings
-from dzgui.strings import rows
 
 
 class Port(Enum):
@@ -48,61 +46,125 @@ class FilterMode(Enum):
     TOGGLE_ON = 3
 
 
-@dataclass(slots=True, frozen=True)
-class ModButtonMeta:
-    label: str
-    tooltip: str
+class EnumWithAttrs(Enum):
+    def __new__(cls, *args: Any, **kwargs: Any) -> Self:
+        value = len(cls.__members__) + 1
+        obj = object.__new__(cls)
+        obj._value_ = value
+        return obj
+
+    def __init__(self, d: dict):
+        self.dict = d
 
 
-@dataclass(slots=True, frozen=True)
-class ButtonTypeMeta:
-    label: str
-    tooltip: str
-    opens: NotebookPage | None
+class Preferences(EnumWithAttrs):
+    STEAM = {
+        "key": "steam_api",
+    }
+    CLIENT = {
+        "key": "client",
+    }
+    WINDOW = {
+        "key": "fullscreen",
+    }
+    DIST = {
+        "key": "use_miles",
+    }
+    NAME = {
+        "key": "name",
+    }
+    DEFAULT = {
+        "key": "default_steam_path",
+    }
+    FAV_LBL = {
+        "key": "fav_label",
+    }
+    FAV_SRV = {
+        "key": "fav_server",
+    }
+    IP_LIST = {
+        "key": "ip_list",
+    }
+    START_TAB = {
+        "key": "start_tab",
+    }
 
 
-@dataclass(slots=True, frozen=True)
-class ConfigKey:
-    key: str
+class NotebookPage(EnumWithAttrs):
+    OFFLINE = {"crumbs": strings.crumbs.offline, "statusbar": True}
+    CHANGELOG = {"crumbs": strings.crumbs.changelog, "statusbar": True}
+    DEVELOPERS = {"crumbs": strings.crumbs.developers, "statusbar": False}
+    HELP = {"crumbs": strings.crumbs._help, "statusbar": True}
+    KEYS = {"crumbs": strings.crumbs.keys, "statusbar": True}
+    LOG = {"crumbs": strings.crumbs.log, "statusbar": True}
+    MODS = {"crumbs": strings.crumbs.mods, "statusbar": True}
+    OPTIONS = {"crumbs": strings.crumbs.options, "statusbar": False}
+    SERVERS = {"crumbs": strings.crumbs.servers, "statusbar": True}
+    THANKS = {"crumbs": strings.crumbs.thanks, "statusbar": True}
+    CONNECTION = {"crumbs": "Connect", "statusbar": True}
 
 
-@dataclass(slots=True, frozen=True)
-class NotebookMeta:
-    crumbs: str
-    has_statusbar: bool
+class RowType(EnumWithAttrs):
+    # TODO: strings
+    CHANGELOG = {
+        "label": "View changelog",
+        "tooltip": "Opens the DZGUI changelog",
+    }
+    SHOW_LOG = {
+        "label": "Show debug log",
+        "tooltip": "Read the DZGUI log generated since startup",
+    }
+    SEPARATOR = {
+        "label": "SEPARATOR",
+        "tooltip": "",
+    }
+    DUMP_LOG = {
+        "label": "Output system info to log file",
+        "tooltip": "Dump diagnostic data for troubleshooting",
+    }
+    DOCS = {
+        "label": "Documentation/help files (GitHub) ⧉",
+        "tooltip": "Open the DZGUI documentation in a browser",
+    }
+    DOCS_FALLBACK = {
+        "label": "Documentation/help files (Codeberg mirror) ⧉",
+        "tooltip": "Open the DZGUI documentation in a browser",
+    }
+    BUGS = {
+        "label": "Report a bug (GitHub) ⧉",
+        "tooltip": "Open the DZGUI issue tracker in a browser",
+    }
+    FORUM = {
+        "label": "DZGUI Subreddit ⧉",
+        "tooltip": "Open the DZGUI discussion forum in a browser",
+    }
+    SPONSOR = {
+        "label": "Sponsor (GitHub) ⧉",
+        "tooltip": "Sponsor development of the DZGUI project",
+    }
+    THANKS = {
+        "label": "Special thanks",
+        "tooltip": "A list of contributors, testers, and sponsors",
+    }
 
 
-@dataclass(slots=True, frozen=True)
-class RowMeta:
-    label: str
-    tooltip: str
-
-
-@dataclass(slots=True, frozen=True)
-class ContextMenuMeta:
-    label: str
-
-
-class ContextMenuItem(Enum):
-    ADD_NOTE = ContextMenuMeta(strings.add_note)
-    ADD_SERVER = ContextMenuMeta(strings.add)
-    CONNECT = ContextMenuMeta(strings.connect)
-    COPY_LOG_CLIPBOARD = ContextMenuMeta(strings.copy_log)
-    COPY_SERVER_IP = ContextMenuMeta(strings.copy_ip)
-    COPY_SERVER_NAME = ContextMenuMeta(strings.copy_name)
-    UNSUB_MOD = ContextMenuMeta(strings.unsub_mod)
-    VALIDATE_MOD = ContextMenuMeta(strings.validate_mod)
-    OPEN_WORKSHOP = ContextMenuMeta(strings.open_workshop)
-    REFRESH_PLAYERS = ContextMenuMeta(strings.refresh_players)
-    REMOVE_HISTORY = ContextMenuMeta(strings.remove_history)
-    REMOVE_SERVER = ContextMenuMeta(strings.remove)
-    SET_FAV = ContextMenuMeta(strings.add_fav)
-    SHOW_DETAILS = ContextMenuMeta(strings.show_details)
-    SHOW_MODS = ContextMenuMeta(strings.show_mods)
-
-    @property
-    def label(self) -> str:
-        return self.value.label
+# TODO: rename to ContextMenuItem
+class ContextMenu(EnumWithAttrs):
+    ADD_NOTE = {"label": strings.add_note}
+    ADD_SERVER = {"label": strings.add}
+    CONNECT = {"label": strings.connect}
+    COPY_LOG_CLIPBOARD = {"label": strings.copy_log}
+    COPY_SERVER_IP = {"label": strings.copy_ip}
+    COPY_SERVER_NAME = {"label": strings.copy_name}
+    UNSUB_MOD = {"label": strings.unsub_mod}
+    VALIDATE_MOD = {"label": strings.validate_mod}
+    OPEN_WORKSHOP = {"label": strings.open_workshop}
+    REFRESH_PLAYERS = {"label": strings.refresh_players}
+    REMOVE_HISTORY = {"label": strings.remove_history}
+    REMOVE_SERVER = {"label": strings.remove}
+    SET_FAV = {"label": strings.add_fav}
+    SHOW_DETAILS = {"label": strings.show_details}
+    SHOW_MODS = {"label": strings.show_mods}
 
 
 class ContextMenuGroup(Enum):
@@ -110,193 +172,113 @@ class ContextMenuGroup(Enum):
     Groupings of context menu items
     """
 
-    SERVER_MOD = (ContextMenuItem.OPEN_WORKSHOP,)
-    MOD = (
-        ContextMenuItem.OPEN_WORKSHOP,
-        ContextMenuItem.UNSUB_MOD,
-        ContextMenuItem.VALIDATE_MOD,
-    )
+    SERVER_MOD = (ContextMenu.OPEN_WORKSHOP,)
+    MOD = (ContextMenu.OPEN_WORKSHOP, ContextMenu.UNSUB_MOD, ContextMenu.VALIDATE_MOD)
     MOD_OFFLINE = (None,)
-    LOG = (ContextMenuItem.COPY_LOG_CLIPBOARD,)
+    LOG = (ContextMenu.COPY_LOG_CLIPBOARD,)
     SERVER_BROWSER = (
-        ContextMenuItem.CONNECT,
-        ContextMenuItem.ADD_SERVER,
-        ContextMenuItem.SET_FAV,
-        ContextMenuItem.COPY_SERVER_NAME,
-        ContextMenuItem.COPY_SERVER_IP,
-        ContextMenuItem.ADD_NOTE,
-        ContextMenuItem.SHOW_MODS,
-        ContextMenuItem.SHOW_DETAILS,
-        ContextMenuItem.REFRESH_PLAYERS,
+        ContextMenu.CONNECT,
+        ContextMenu.ADD_SERVER,
+        ContextMenu.SET_FAV,
+        ContextMenu.COPY_SERVER_NAME,
+        ContextMenu.COPY_SERVER_IP,
+        ContextMenu.ADD_NOTE,
+        ContextMenu.SHOW_MODS,
+        ContextMenu.SHOW_DETAILS,
+        ContextMenu.REFRESH_PLAYERS,
     )
     SCAN_LAN = (
-        ContextMenuItem.CONNECT,
-        ContextMenuItem.SET_FAV,
-        ContextMenuItem.COPY_SERVER_NAME,
-        ContextMenuItem.COPY_SERVER_IP,
-        ContextMenuItem.ADD_NOTE,
-        ContextMenuItem.SHOW_MODS,
-        ContextMenuItem.SHOW_DETAILS,
-        ContextMenuItem.REFRESH_PLAYERS,
+        ContextMenu.CONNECT,
+        ContextMenu.SET_FAV,
+        ContextMenu.COPY_SERVER_NAME,
+        ContextMenu.COPY_SERVER_IP,
+        ContextMenu.ADD_NOTE,
+        ContextMenu.SHOW_MODS,
+        ContextMenu.SHOW_DETAILS,
+        ContextMenu.REFRESH_PLAYERS,
     )
     SAVED = (
-        ContextMenuItem.CONNECT,
-        ContextMenuItem.SET_FAV,
-        ContextMenuItem.REMOVE_SERVER,
-        ContextMenuItem.COPY_SERVER_NAME,
-        ContextMenuItem.COPY_SERVER_IP,
-        ContextMenuItem.ADD_NOTE,
-        ContextMenuItem.SHOW_MODS,
-        ContextMenuItem.SHOW_DETAILS,
-        ContextMenuItem.REFRESH_PLAYERS,
+        ContextMenu.CONNECT,
+        ContextMenu.SET_FAV,
+        ContextMenu.REMOVE_SERVER,
+        ContextMenu.COPY_SERVER_NAME,
+        ContextMenu.COPY_SERVER_IP,
+        ContextMenu.ADD_NOTE,
+        ContextMenu.SHOW_MODS,
+        ContextMenu.SHOW_DETAILS,
+        ContextMenu.REFRESH_PLAYERS,
     )
     RECENT = (
-        ContextMenuItem.CONNECT,
-        ContextMenuItem.ADD_SERVER,
-        ContextMenuItem.SET_FAV,
-        ContextMenuItem.REMOVE_HISTORY,
-        ContextMenuItem.COPY_SERVER_NAME,
-        ContextMenuItem.COPY_SERVER_IP,
-        ContextMenuItem.ADD_NOTE,
-        ContextMenuItem.SHOW_MODS,
-        ContextMenuItem.SHOW_DETAILS,
-        ContextMenuItem.REFRESH_PLAYERS,
+        ContextMenu.CONNECT,
+        ContextMenu.ADD_SERVER,
+        ContextMenu.SET_FAV,
+        ContextMenu.REMOVE_HISTORY,
+        ContextMenu.COPY_SERVER_NAME,
+        ContextMenu.COPY_SERVER_IP,
+        ContextMenu.ADD_NOTE,
+        ContextMenu.SHOW_MODS,
+        ContextMenu.SHOW_DETAILS,
+        ContextMenu.REFRESH_PLAYERS,
     )
 
 
-class Preferences(Enum):
-    STEAM = ConfigKey("steam_api")
-    CLIENT = ConfigKey("client")
-    WINDOW = ConfigKey("fullscreen")
-    DIST = ConfigKey("use_miles")
-    NAME = ConfigKey("name")
-    DEFAULT = ConfigKey("default_steam_path")
-    FAV_LBL = ConfigKey("fav_label")
-    FAV_SRV = ConfigKey("fav_server")
-    IP_LIST = ConfigKey("ip_list")
-    START_TAB = ConfigKey("start_tab")
-
-    @property
-    def key(self) -> str:
-        return self.value.key
+class ModButton(EnumWithAttrs):
+    SELECT_ALL = {
+        "label": strings.mod_panel.select_all,
+        "tooltip": strings.mod_panel.select_all_tooltip,
+    }
+    UNSELECT_ALL = {
+        "label": strings.mod_panel.unselect_all,
+        "tooltip": strings.mod_panel.unselect_all_tooltip,
+    }
+    HIGHLIGHT_STALE = {
+        "label": strings.mod_panel.highlight_stale,
+        "tooltip": strings.mod_panel.highlight_stale_tooltip,
+    }
+    UNHIGHLIGHT_STALE = {
+        "label": strings.mod_panel.unhighlight_stale,
+        "tooltip": strings.mod_panel.unhighlight_stale_tooltip,
+    }
+    UNSUB_SELECTED = {
+        "label": strings.mod_panel.unsub_selected,
+        "tooltip": strings.mod_panel.unsub_selected_tooltip,
+    }
+    SELECT_STALE = {
+        "label": strings.mod_panel.select_stale,
+        "tooltip": strings.mod_panel.select_stale_tooltip,
+    }
+    VALIDATE = {
+        "label": strings.mod_panel.validate,
+        "tooltip": strings.mod_panel.validate_tooltip,
+    }
 
 
-class NotebookPage(Enum):
-    OFFLINE = NotebookMeta(strings.crumbs.offline, True)
-    CHANGELOG = NotebookMeta(strings.crumbs.changelog, True)
-    DEVELOPERS = NotebookMeta(strings.crumbs.developers, False)
-    HELP = NotebookMeta(strings.crumbs._help, True)
-    KEYS = NotebookMeta(strings.crumbs.keys, True)
-    LOG = NotebookMeta(strings.crumbs.log, True)
-    MODS = NotebookMeta(strings.crumbs.mods, True)
-    OPTIONS = NotebookMeta(strings.crumbs.options, False)
-    SERVERS = NotebookMeta(strings.crumbs.servers, True)
-    THANKS = NotebookMeta(strings.crumbs.thanks, True)
-    CONNECTION = NotebookMeta(strings.crumbs.connect, True)
-
-    @property
-    def crumbs(self) -> str:
-        return self.value.crumbs
-
-    @property
-    def has_statusbar(self) -> bool:
-        return self.value.has_statusbar
-
-
-class RowType(Enum):
-    CHANGELOG = RowMeta(rows.changelog_label, rows.changelog_status)
-    SHOW_LOG = RowMeta(rows.log_label, rows.log_status)
-    SEPARATOR = RowMeta(rows.separator_label, rows.separator_status)
-    DUMP_LOG = RowMeta(rows.system_log_label, rows.system_log_status)
-    DOCS = RowMeta(rows.docs_label, rows.docs_status)
-    DOCS_FALLBACK = RowMeta(rows.docs_fallback_label, rows.docs_fallback_status)
-    BUGS = RowMeta(rows.bugs_label, rows.bugs_status)
-    FORUM = RowMeta(rows.forum_label, rows.forum_status)
-    SPONSOR = RowMeta(rows.sponsor_label, rows.sponsor_status)
-    THANKS = RowMeta(rows.thanks_label, rows.thanks_status)
-
-    @property
-    def label(self) -> str:
-        return self.value.label
-
-    @property
-    def tooltip(self) -> str:
-        return self.value.tooltip
-
-
-class ModButton(Enum):
-    SELECT_ALL = ModButtonMeta(
-        strings.mod_panel.select_all, strings.mod_panel.select_all_tooltip
-    )
-    UNSELECT_ALL = ModButtonMeta(
-        strings.mod_panel.unselect_all, strings.mod_panel.unselect_all_tooltip
-    )
-    HIGHLIGHT_STALE = ModButtonMeta(
-        strings.mod_panel.highlight_stale, strings.mod_panel.highlight_stale_tooltip
-    )
-    UNHIGHLIGHT_STALE = ModButtonMeta(
-        strings.mod_panel.unhighlight_stale, strings.mod_panel.unhighlight_stale_tooltip
-    )
-    UNSUB_SELECTED = ModButtonMeta(
-        strings.mod_panel.unsub_selected,
-        strings.mod_panel.unsub_selected_tooltip,
-    )
-    SELECT_STALE = ModButtonMeta(
-        strings.mod_panel.select_stale,
-        strings.mod_panel.select_stale_tooltip,
-    )
-    VALIDATE = ModButtonMeta(
-        strings.mod_panel.validate,
-        strings.mod_panel.validate_tooltip,
-    )
-
-    @property
-    def label(self) -> str:
-        return self.value.label
-
-    @property
-    def tooltip(self) -> str:
-        return self.value.tooltip
-
-
-class ButtonType(Enum):
-    SERVERS = ButtonTypeMeta(
-        strings.buttons.servers_label,
-        strings.buttons.servers_tooltip,
-        NotebookPage.SERVERS,
-    )
-    MODS = ButtonTypeMeta(
-        strings.buttons.mods_label,
-        strings.buttons.mods_tooltip,
-        NotebookPage.MODS,
-    )
-    OPTIONS = ButtonTypeMeta(
-        strings.buttons.options_label,
-        strings.buttons.options_tooltip,
-        NotebookPage.OPTIONS,
-    )
-    HELP = ButtonTypeMeta(
-        strings.buttons.help_label,
-        strings.buttons.help_tooltip,
-        NotebookPage.HELP,
-    )
-    EXIT = ButtonTypeMeta(
-        strings.buttons.exit_label,
-        strings.buttons.exit_tooltip,
-        None,
-    )
-
-    @property
-    def label(self) -> str:
-        return self.value.label
-
-    @property
-    def tooltip(self) -> str:
-        return self.value.tooltip
-
-    @property
-    def opens(self) -> NotebookPage | None:
-        return self.value.opens
+class ButtonType(EnumWithAttrs):
+    SERVERS = {
+        "label": strings.buttons.servers_label,
+        "tooltip": strings.buttons.servers_tooltip,
+        "opens": NotebookPage.SERVERS,
+    }
+    MODS = {
+        "label": strings.buttons.mods_label,
+        "tooltip": strings.buttons.mods_tooltip,
+        "opens": NotebookPage.MODS,
+    }
+    OPTIONS = {
+        "label": strings.buttons.options_label,
+        "tooltip": strings.buttons.options_tooltip,
+        "opens": NotebookPage.OPTIONS,
+    }
+    HELP = {
+        "label": strings.buttons.help_label,
+        "tooltip": strings.buttons.help_tooltip,
+        "opens": NotebookPage.HELP,
+    }
+    EXIT = {
+        "label": strings.buttons.exit_label,
+        "tooltip": strings.buttons.exit_tooltip,
+        "opens": None,
+    }
 
 
 HELP_MENU_ROWS = (

dzgui/controllers/mc.py

@@ -8,7 +8,7 @@ import dzgui.util._json as JSON  # noqa
 
 from dzgui.const.enum import (
     ButtonType,
-    ContextMenuItem,
+    ContextMenu,
     FilterMode,
     NotebookPage,
     Preferences,
@@ -196,9 +196,7 @@ class Controller(GObject.GObject):
     def show_developers_page(self) -> None:
         self.open_page(NotebookPage.DEVELOPERS)
 
-    def open_page(self, page: NotebookPage | None) -> None:
-        if page is None:
-            return
+    def open_page(self, page: NotebookPage) -> None:
         self.mediator.grid.notebook.set_page_by_enum(page)
 
     def open_page_by_button(self, button: "ContextualButton") -> None:
@@ -264,7 +262,7 @@ class Controller(GObject.GObject):
             logger.critical(e)
             return
 
-    def menu_action(self, action: ContextMenuItem, tree: "ServerTreeView") -> None:
+    def menu_action(self, action: ContextMenu, tree: "ServerTreeView") -> None:
         context_man = ContextMenuManager(tree, self)
         context_man.process(action)
 
@@ -276,7 +274,7 @@ class Controller(GObject.GObject):
         except Exception as e:
             dialog = ExceptionDialog(self, str(e))
             dialog.show_all()
-            dialog.run()  # type: ignore[no-untyped-call]
+            dialog.run()
 
     def select_colorized(self) -> None:
         mod_man = self.mediator.modtreeview.get_mod_man()
@@ -310,7 +308,7 @@ class Controller(GObject.GObject):
             except Exception as e:
                 dialog = ExceptionDialog(self, str(e))
                 dialog.show_all()
-                dialog.run()  # type: ignore[no-untyped-call]
+                dialog.run()
 
     def update_steam_api_key(self, text: str) -> None:
         self.config_man.update_steam_api_key(text)
@@ -367,11 +365,12 @@ class Controller(GObject.GObject):
         filter_man = self.get_filter_man()
         return filter_man.get_map_store()
 
-    def get_enabled_filters(self) -> dict[str, bool]:
+    def get_enabled_filters(self) -> dict:
         filter_man = self.get_filter_man()
         return filter_man.get_filters()
 
     # FIXME: wipe maps store when changing tabs if model is none
+
     def has_server_model(self) -> bool:
         treeview = self.get_active_treeview()
         proxy_man = treeview.get_proxy_man()

dzgui/managers/config.py

@@ -124,7 +124,7 @@ class ConfigManager:
         return False
 
     def enum_to_key(self, enum: Preferences) -> str:
-        return str(enum.key)
+        return str(enum.dict["key"])
 
     def toggle_config(self, key: Preferences) -> None:
         try:

dzgui/managers/contextmenu.py

@@ -2,7 +2,7 @@ import logging
 from typing import TYPE_CHECKING
 
 from dzgui.const.constants import APP_NAME
-from dzgui.const.enum import ContextMenuItem, Preferences
+from dzgui.const.enum import ContextMenu, Preferences
 from dzgui.util.clip import copy_clipboard
 from dzgui.util.open_links import open_workshop_page
 
@@ -34,7 +34,7 @@ class ContextMenuManager:
         self.controller = controller
         self.treeview = treeview
 
-    def process(self, action: ContextMenuItem) -> None:
+    def process(self, action: ContextMenu) -> None:
         if isinstance(self.treeview, ServerTreeView):
             record = self.treeview.get_record()
             if record is None:
@@ -42,14 +42,14 @@ class ContextMenuManager:
 
             match action:
                 # UNTHREADED
-                case ContextMenuItem.ADD_NOTE:
+                case ContextMenu.ADD_NOTE:
                     dialog = NoteDialog(self.controller)
-                    dialog.run()  # type: ignore[no-untyped-call]
-                case ContextMenuItem.COPY_SERVER_IP:
+                    dialog.run()
+                case ContextMenu.COPY_SERVER_IP:
                     self.copy_server_ip()
-                case ContextMenuItem.COPY_SERVER_NAME:
+                case ContextMenu.COPY_SERVER_NAME:
                     self.copy_server_name()
-                case ContextMenuItem.SET_FAV:
+                case ContextMenu.SET_FAV:
                     name = self.treeview.get_value_at_index(0)
                     # NOTE: fully qualified ip
                     fqip = self.treeview.get_record_string()
@@ -58,40 +58,40 @@ class ContextMenuManager:
                     self.controller.set_fav(name, fqip, simple)
 
                 # THREADED
-                case ContextMenuItem.ADD_SERVER:
+                case ContextMenu.ADD_SERVER:
                     self.controller.add_by_record(record)
-                case ContextMenuItem.CONNECT:
+                case ContextMenu.CONNECT:
                     self.controller.connect_by_record(record)
-                case ContextMenuItem.REFRESH_PLAYERS:
+                case ContextMenu.REFRESH_PLAYERS:
                     self.controller.refresh_players(record)
-                case ContextMenuItem.REMOVE_HISTORY:
+                case ContextMenu.REMOVE_HISTORY:
                     self.controller.remove_from_history(record)
-                case ContextMenuItem.REMOVE_SERVER:
+                case ContextMenu.REMOVE_SERVER:
                     self.controller.remove_by_record(record)
-                case ContextMenuItem.SHOW_DETAILS:
+                case ContextMenu.SHOW_DETAILS:
                     self.controller.get_details(record)
-                case ContextMenuItem.SHOW_MODS:
+                case ContextMenu.SHOW_MODS:
                     self.controller.get_modlist(record)
 
         if isinstance(self.treeview, (ModTreeView, OfflineModTreeView)):
             match action:
-                case ContextMenuItem.OPEN_WORKSHOP:
+                case ContextMenu.OPEN_WORKSHOP:
                     self.open_mod_page()
-                case ContextMenuItem.UNSUB_MOD:
+                case ContextMenu.UNSUB_MOD:
                     self.controller.unsub_mods(self.treeview)
-                case ContextMenuItem.VALIDATE_MOD:
+                case ContextMenu.VALIDATE_MOD:
                     self.controller.validate_mods(self.treeview)
                 case _:
                     pass
 
         if isinstance(self.treeview, LogTreeView):
             match action:
-                case ContextMenuItem.COPY_LOG_CLIPBOARD:
+                case ContextMenu.COPY_LOG_CLIPBOARD:
                     self.copy_log()
 
         if isinstance(self.treeview, ServerModTreeView):
             match action:
-                case ContextMenuItem.OPEN_WORKSHOP:
+                case ContextMenu.OPEN_WORKSHOP:
                     self.open_mod_page()
 
     def copy_server_ip(self) -> None:

dzgui/model/model_factory.py

@@ -147,7 +147,7 @@ class ModelFactory:
 
     def make_help_store(self) -> FastInsertListStore:
         store = self.new_model_from_class(MenuCols)
-        rows = [[row.label, row] for row in HELP_MENU_ROWS]
+        rows = [[row.dict["label"], row] for row in HELP_MENU_ROWS]
         store.extend(rows)
         return store
 

dzgui/strings/rows.py

@@ -1,29 +0,0 @@
-changelog_label = "View changelog"
-changelog_status = "Opens the DZGUI changelog"
-
-log_label = "Show debug log"
-log_status = "Read the DZGUI log generated since startup"
-
-separator_label = "SEPARATOR"
-separator_status = ""
-
-system_log_label = "Output system info to log file"
-system_log_status = "Dump diagnostic data for troubleshooting"
-
-docs_label = "Documentation/help files (GitHub) ⧉"
-docs_status = "Open the DZGUI documentation in a browser"
-
-docs_fallback_label = "Documentation/help files (Codeberg mirror) ⧉"
-docs_fallback_status = "Open the DZGUI documentation in a browser"
-
-bugs_label = "Report a bug (GitHub) ⧉"
-bugs_status = "Open the DZGUI issue tracker in a browser"
-
-forum_label = "DZGUI Subreddit ⧉"
-forum_status = "Open the DZGUI discussion forum in a browser"
-
-sponsor_label = "Sponsor (GitHub) ⧉"
-sponsor_status = "Sponsor development of the DZGUI project"
-
-thanks_label = "Special thanks"
-thanks_status = "A list of contributors, testers, and sponsors"

dzgui/util/strings.py

@@ -252,7 +252,6 @@ class Crumbs:
     developers: str
     default: str
     offline: str
-    connect: str
 
 
 @dataclass(slots=True, frozen=True)
@@ -440,7 +439,6 @@ crumbs = Crumbs(
     developers="Options > Developers",
     default="Servers > ",
     offline="Mods > Play offline",
-    connect="Connect",
 )
 
 no_mods = "No local mods found."

dzgui/views/components/buttonbox.py

@@ -19,7 +19,7 @@ if TYPE_CHECKING:
 
 class ContextualButton(Gtk.Button):
     def __init__(
-        self, label: str, opens: "NotebookPage" | None, tooltip: str, context: ButtonType
+        self, label: str, opens: "NotebookPage", tooltip: str, context: ButtonType
     ) -> None:
         super().__init__(
             label=label,
@@ -51,9 +51,9 @@ class ButtonBox(Gtk.Box):
 
         for side_button in ButtonType:
             button = ContextualButton(
-                label=side_button.label,
-                opens=side_button.opens,
-                tooltip=side_button.tooltip,
+                label=side_button.dict["label"],
+                opens=side_button.dict["opens"],
+                tooltip=side_button.dict["tooltip"],
                 context=side_button,
             )
 

dzgui/views/components/crumbs.py

@@ -43,7 +43,7 @@ class Breadcrumbs(Gtk.Label):
             label = page.get_current_tab_text()
             self.set_server_crumbs(label)
         else:
-            crumbs = enum.crumbs
+            crumbs = enum.dict["crumbs"]
             self.set_crumbs(crumbs)
 
     def set_server_crumbs(self, suffix: str) -> None:

dzgui/views/components/mod_panel.py

@@ -20,8 +20,8 @@ class EnumeratedModButton(Gtk.Button):
         super().__init__(margin_start=10, margin_end=10, focus_on_click=False)
 
         self.enum = enum
-        self.set_label(enum.label)
-        self.set_tooltip_text(enum.tooltip)
+        self.set_label(enum.dict["label"])
+        self.set_tooltip_text(enum.dict["tooltip"])
 
 
 class ModPanelButton(EnumeratedModButton):

dzgui/views/components/statusbar.py

@@ -60,7 +60,7 @@ class Statusbar(Gtk.Grid):
             return
 
         enum = notebook.get_page_by_enum()
-        show_statusbar = enum.has_statusbar
+        show_statusbar = enum.dict["statusbar"]
 
         if show_statusbar is False:
             self.set_by_context(enum, "")
@@ -152,5 +152,5 @@ class Statusbar(Gtk.Grid):
         row = tree.get_value_at_index(1)
         if self.controller.loaded is False:
             return
-        tooltip = row.tooltip
+        tooltip = row.dict["tooltip"]
         self.set_by_context(NotebookPage.HELP, tooltip)

dzgui/views/mixins/context_mixin.py

@@ -1,7 +1,7 @@
 import logging
 
 from dzgui.const.constants import APP_NAME
-from dzgui.const.enum import ContextMenuItem
+from dzgui.const.enum import ContextMenu
 from dzgui.util.keys import is_ctrl_mask, is_navkey
 from dzgui.util.strings import edit_note
 from dzgui.views.trees.tree_base import TreeView
@@ -15,7 +15,9 @@ logger = logging.getLogger(APP_NAME)
 
 
 class ContextMixin(TreeView):
-    def present_menu(self, widget: Gtk.Widget, event: Gdk.Event) -> bool:
+    def present_menu(
+        self, widget: Gtk.Widget, event: Gdk.Event
+    ) -> bool:
 
         if self.menu is None:
             return False
@@ -58,17 +60,17 @@ class ContextMixin(TreeView):
         self.context_menu.select_first(False)
         return True
 
-    def _process_dynamic_row(self, row: ContextMenuItem) -> Gtk.MenuItem:
-        if row == ContextMenuItem.ADD_SERVER and self.is_in_favs():  # type: ignore
-            row = ContextMenuItem.REMOVE_SERVER
+    def _process_dynamic_row(self, row: ContextMenu) -> Gtk.MenuItem:
+        if row == ContextMenu.ADD_SERVER and self.is_in_favs():  # type: ignore
+            row = ContextMenu.REMOVE_SERVER
 
-        item = Gtk.MenuItem(label=row.label)
+        item = Gtk.MenuItem(label=row.dict["label"])
         item.connect("activate", self._on_menu_click, row)
 
-        if row == ContextMenuItem.SHOW_MODS:
+        if row == ContextMenu.SHOW_MODS:
             item.set_sensitive(self.is_modded())  # type: ignore
 
-        if row == ContextMenuItem.ADD_NOTE:
+        if row == ContextMenu.ADD_NOTE:
             if self.controller.has_note():
                 item.set_label(edit_note)
 
@@ -92,7 +94,7 @@ class ContextMixin(TreeView):
         except AttributeError:
             return False
 
-    def _on_menu_click(self, widget: Gtk.MenuItem, enum: ContextMenuItem) -> None:
+    def _on_menu_click(self, widget: Gtk.MenuItem, enum: ContextMenu) -> None:
         self.controller.menu_action(enum, self)  # type: ignore
 
     def _on_key(self, menu: Gtk.Menu, event: Gdk.EventKey) -> bool | None:

dzgui/views/trees/tree_menu.py

@@ -77,4 +77,4 @@ class MenuTreeView(TreeView):
             raise ValueError("Trying to call a method on non-existent model")
         _iter = self.get_focused_row_iter()
         rowtype = model.get_value(_iter, 1)
-        return str(rowtype.tooltip)
+        return str(rowtype.dict["tooltip"])

dzgui/views/trees/tree_servers.py

@@ -7,7 +7,7 @@ from warnings import deprecated
 
 from dzgui.api.servers import ping, Record
 from dzgui.const.constants import APP_NAME
-from dzgui.const.enum import ContextMenuItem, ContextMenuGroup, ServerTab
+from dzgui.const.enum import ContextMenu, ContextMenuGroup, ServerTab
 from dzgui.managers.filter import FilterManager
 from dzgui.model.proxy_model import ProxyModelManager
 from dzgui.util import strings
@@ -250,9 +250,9 @@ class ServerTreeView(ContextMixin, TreeView):  # type: ignore
                     if self.enum is ServerTab.LAN:
                         self.emitter.emit("request_custom_port_focus")
                 case Gdk.KEY_c:
-                    self.controller.menu_action(ContextMenuItem.COPY_SERVER_IP, self)
+                    self.controller.menu_action(ContextMenu.COPY_SERVER_IP, self)
                 case Gdk.KEY_r:
-                    self.controller.menu_action(ContextMenuItem.REFRESH_PLAYERS, self)
+                    self.controller.menu_action(ContextMenu.REFRESH_PLAYERS, self)
         else:
             match event.keyval:
                 case Gdk.KEY_l | Gdk.KEY_Right:

scripts/concat_licenses.py

@@ -1,4 +1,4 @@
-from shared import get_git_root
+from pathlib import Path
 
 BOILERPLATE = """
 This file includes the combined licenses to the following components:
@@ -40,7 +40,7 @@ class CombinedLicense:
 
 def concat_license() -> str:
     combined = CombinedLicense()
-    root = get_git_root()
+    root = Path(__file__).resolve().parents[1]
     licenses = root.joinpath("docs/licenses")
 
     main_license = root.joinpath(LICENSE_FILE)

scripts/copy_changelog.py

@@ -1,11 +1,10 @@
 import shutil
 import subprocess
+from pathlib import Path
 
-from shared import get_git_root
-
-root = get_git_root()
-clog = root.joinpath("CHANGELOG.md")
-target = root.joinpath("dzgui/data/CHANGELOG.md")
+par = Path(__file__).parent.parent
+clog = par / "CHANGELOG.md"
+target = par / "dzgui/data/CHANGELOG.md"
 
 shutil.copy(clog, target)
 

scripts/parse_toml.py

@@ -1,9 +1,10 @@
 import tomllib
-from shared import get_git_root
+from pathlib import Path
+
+root = Path(__file__).resolve().parents[1]
 
 
 def get_entrypoint() -> None:
-    root = get_git_root()
     p = root.joinpath("pyproject.toml")
     with open(p, "rb") as f:
         t = tomllib.load(f)

scripts/prebuild.py

@@ -3,15 +3,14 @@ import requests
 import subprocess
 import tarfile
 
+from pathlib import Path
 from urllib.parse import unquote
 
-from shared import get_git_root
-
 BUILD = "3.13.9"
 DATE = "20251014"
 CPYTHON_BUILD = f"cpython-{BUILD}"
 
-root = get_git_root()
+root = Path(__file__).resolve().parents[1]
 build_dir = root.joinpath("build")
 cpython_dir = build_dir.joinpath(CPYTHON_BUILD)
 

scripts/release.py

@@ -9,7 +9,6 @@ from pathlib import Path
 from concat_licenses import concat_license
 from parse_toml import get_entrypoint
 from prebuild import get_pyapp, rebuild_cpython
-from shared import get_git_root
 
 
 def update_uname(info: tarfile.TarInfo) -> tarfile.TarInfo:
@@ -18,7 +17,7 @@ def update_uname(info: tarfile.TarInfo) -> tarfile.TarInfo:
     return info
 
 
-root = get_git_root()
+root = Path(__file__).resolve().parents[1]
 dist_dir = root.joinpath("dist")
 build_dir = root.joinpath("build")
 

scripts/scrot.py

@@ -1,7 +1,16 @@
+import subprocess
 from pathlib import Path
 
 from dzgui.app_init import build_gui
-from shared import get_git_root
+
+
+def get_git_root() -> Path:
+    proc = subprocess.run(
+        ["git", "rev-parse", "--show-toplevel"], capture_output=True, text=True
+    )
+    if proc.returncode != 0:
+        raise OSError("Failed to parse git root")
+    return Path(proc.stdout.rstrip())
 
 
 def get_image_path() -> Path:

scripts/shared/__init__.py

@@ -1,11 +0,0 @@
-import subprocess
-from pathlib import Path
-
-
-def get_git_root() -> Path:
-    proc = subprocess.run(
-        ["git", "rev-parse", "--show-toplevel"], capture_output=True, text=True
-    )
-    if proc.returncode != 0:
-        raise OSError("Failed to parse git root")
-    return Path(proc.stdout.rstrip())