From 0c99d7d397f07412e626e8b28f34efabf5e30200 Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Wed, 22 Nov 2023 15:46:43 +0900 Subject: [PATCH] docs: remove legacy keys --- docs/dzgui.adoc | 15 +++++++-------- docs/dzgui_dark.adoc | 15 +++++++-------- 2 files changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/dzgui.adoc b/docs/dzgui.adoc index da365e7..4b2b12d 100644 --- a/docs/dzgui.adoc +++ b/docs/dzgui.adoc @@ -435,23 +435,22 @@ Uses xdg-open to open the https://aclist.github.io/dzgui/dzgui#_hall_of_fame[Hal == Config file key/value pairs Under normal usage, these values are populated and toggled automatically in-app. This config file is partially compatible with DZTUI. - [%autowidth] |=== |Key|Value |`api_key`|the API key generated at BattleMetrics. See <> -|`whitelist`|comma-separated list of server IDs from BattleMetrics; integer-values only +|`auto_install`|permissible values are 0, 1, and 2. These are set internally depending on if the user enabled auto mod installation +|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch +|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports) +|`default_steam_path`|the path to the default Steam client installation +|`ip_list`|array of server addresses; a concatenation of the IP/GamePort/Queryport |`fav_server`|server to display in the `Fav` field and to quick-connect to (must be one only); a concatenation of the IP/Gameport/Queryport |`fav_label`|the human-readable name of the fav server set above |`name`|a custom "handle" name used to identify the player on a server (required by some servers) -|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports) -|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch -|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted -|`auto_install`|permissible values are 0, 1, and 2. These are set internally depending on if the user enabled auto mod installation -|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable -|`default_steam_path`|the path to the default Steam client installation |`preferred_client`|whether the user prefers native Steam or Flatpak. This value is only set if concurrent installations are found on the system +|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted +|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable |=== == Troubleshooting/FAQ diff --git a/docs/dzgui_dark.adoc b/docs/dzgui_dark.adoc index 4cb7f25..6db172a 100644 --- a/docs/dzgui_dark.adoc +++ b/docs/dzgui_dark.adoc @@ -435,23 +435,22 @@ Uses xdg-open to open the https://aclist.github.io/dzgui/dzgui#_hall_of_fame[Hal == Config file key/value pairs Under normal usage, these values are populated and toggled automatically in-app. This config file is partially compatible with DZTUI. - [%autowidth] |=== |Key|Value |`api_key`|the API key generated at BattleMetrics. See <> -|`whitelist`|comma-separated list of server IDs from BattleMetrics; integer-values only +|`auto_install`|permissible values are 0, 1, and 2. These are set internally depending on if the user enabled auto mod installation +|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch +|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports) +|`default_steam_path`|the path to the default Steam client installation +|`ip_list`|array of server addresses; a concatenation of the IP/GamePort/Queryport |`fav_server`|server to display in the `Fav` field and to quick-connect to (must be one only); a concatenation of the IP/Gameport/Queryport |`fav_label`|the human-readable name of the fav server set above |`name`|a custom "handle" name used to identify the player on a server (required by some servers) -|`debug`|by default, set to 0; set to `1` to print launch options that would have been run, instead of actually connecting (used for troubleshooting and submitting bug reports) -|`branch`|by default, set to `stable`; set to `testing` to fetch the testing branch -|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted -|`auto_install`|permissible values are 0, 1, and 2. These are set internally depending on if the user enabled auto mod installation -|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable -|`default_steam_path`|the path to the default Steam client installation |`preferred_client`|whether the user prefers native Steam or Flatpak. This value is only set if concurrent installations are found on the system +|`seen_news`|stores a hash of the news item last seen by the client. This is used to suppress news messages until a new one is posted +|`staging_dir`|a directory used to stage mods while downloading. This feature is deprecated and is no longer user-configurable |=== == Troubleshooting/FAQ