Merge pull request #908 from myk002/myk_control_panel

Control panel v2

control-panel.lua

@@ -0,0 +1,231 @@
+--@module = true
+
+local argparse = require('argparse')
+local common = reqscript('internal/control-panel/common')
+local json = require('json')
+local persist = require('persist-table')
+local registry = reqscript('internal/control-panel/registry')
+local utils = require('utils')
+
+local GLOBAL_KEY = 'control-panel'
+
+-- state change hooks
+
+local function apply_system_config()
+    local enabled_map =common.get_enabled_map()
+    for _, data in ipairs(registry.COMMANDS_BY_IDX) do
+        if data.mode == 'system_enable' then
+            common.apply_command(data, enabled_map)
+        end
+    end
+    for _, data in ipairs(registry.PREFERENCES_BY_IDX) do
+        local value = safe_index(common.config.data.preferences, data.name, 'val')
+        if value ~= nil then
+            data.set_fn(value)
+        end
+    end
+end
+
+local function apply_autostart_config()
+    local enabled_map =common.get_enabled_map()
+    for _, data in ipairs(registry.COMMANDS_BY_IDX) do
+        if data.mode == 'enable' or data.mode == 'run' then
+            common.apply_command(data, enabled_map)
+        end
+    end
+end
+
+local function apply_fort_loaded_config()
+    if not safe_index(json.decode(persist.GlobalTable[GLOBAL_KEY] or ''), 'autostart_done') then
+        apply_autostart_config()
+        persist.GlobalTable[GLOBAL_KEY] = json.encode({autostart_done=true})
+    end
+    local enabled_repeats = json.decode(persist.GlobalTable[common.REPEATS_GLOBAL_KEY] or '')
+    for _, data in ipairs(registry.COMMANDS_BY_IDX) do
+        if data.mode == 'repeat' and enabled_repeats[data.command] then
+            common.apply_command(data)
+        end
+    end
+end
+
+dfhack.onStateChange[GLOBAL_KEY] = function(sc)
+    if sc == SC_CORE_INITIALIZED then
+        apply_system_config()
+    elseif sc == SC_MAP_LOADED and dfhack.world.isFortressMode() then
+        apply_fort_loaded_config()
+    end
+end
+
+
+-- CLI
+
+local function print_header(header)
+    print()
+    print(header)
+    print(('-'):rep(#header))
+end
+
+local function list_command_group(group, filter_strs, enabled_map)
+    local header = ('Group: %s'):format(group)
+    for idx, data in ipairs(registry.COMMANDS_BY_IDX) do
+        local first_word = common.get_first_word(data.command)
+        if not common.command_passes_filters(data, group, first_word, filter_strs) then
+            goto continue
+        end
+        if header then
+            print_header(header)
+            ---@diagnostic disable-next-line: cast-local-type
+            header = nil
+        end
+        local extra = ''
+        if data.mode == 'system_enable' then
+            extra = ' (global)'
+        end
+        print(('%d) %s%s'):format(idx, data.command, extra))
+        local desc = common.get_description(data)
+        if #desc > 0 then
+            print(('        %s'):format(desc))
+        end
+        local default_value = not not data.default
+        local current_value = safe_index(common.config.data.commands, data.command, 'autostart')
+        if current_value == nil then
+            current_value = default_value
+        end
+        print(('        autostart enabled: %s (default: %s)'):format(current_value, default_value))
+        if enabled_map[data.command] ~= nil then
+            print(('        currently enabled: %s'):format(enabled_map[data.command]))
+        end
+        print()
+        ::continue::
+    end
+    if not header then
+    end
+end
+
+local function list_preferences(filter_strs)
+    local header = 'Preferences'
+    for _, data in ipairs(registry.PREFERENCES_BY_IDX) do
+        local search_key = ('%s %s %s'):format(data.name, data.label, data.desc)
+        if not utils.search_text(search_key, filter_strs) then goto continue end
+        if header then
+            print_header(header)
+            ---@diagnostic disable-next-line: cast-local-type
+            header = nil
+        end
+        print(('%s) %s'):format(data.name, data.label))
+        print(('        %s'):format(data.desc))
+        print(('        current: %s (default: %s)'):format(data.get_fn(), data.default))
+        if data.min then
+            print(('        minimum: %s'):format(data.min))
+        end
+        print()
+        ::continue::
+    end
+end
+
+local function do_list(filter_strs)
+    local enabled_map =common.get_enabled_map()
+    list_command_group('automation', filter_strs, enabled_map)
+    list_command_group('bugfix', filter_strs, enabled_map)
+    list_command_group('gameplay', filter_strs, enabled_map)
+    list_preferences(filter_strs)
+end
+
+local function get_command_data(name_or_idx)
+    if type(name_or_idx) == 'number' then
+        return registry.COMMANDS_BY_IDX[name_or_idx]
+    end
+    return registry.COMMANDS_BY_NAME[name_or_idx]
+end
+
+local function do_enable_disable(which, entries)
+    local enabled_map =common.get_enabled_map()
+    for _, entry in ipairs(entries) do
+        local data = get_command_data(entry)
+        if data.mode ~= 'system_enable' and not dfhack.world.isFortressMode() then
+            qerror('must have a loaded fortress to enable '..data.name)
+        end
+        if common.apply_command(data, enabled_map, which == 'en') then
+            print(('%sabled %s'):format(which, entry))
+        end
+    end
+end
+
+local function do_enable(entries)
+    do_enable_disable('en', entries)
+end
+
+local function do_disable(entries)
+    do_enable_disable('dis', entries)
+end
+
+local function do_autostart_noautostart(which, entries)
+    for _, entry in ipairs(entries) do
+        local data = get_command_data(entry)
+        if not data then
+            qerror(('autostart command or index not found: "%s"'):format(entry))
+        else
+            common.set_autostart(data, which == 'en')
+            print(('%sabled autostart for: %s'):format(which, entry))
+        end
+    end
+    common.config:write()
+end
+
+local function do_autostart(entries)
+    do_autostart_noautostart('en', entries)
+end
+
+local function do_noautostart(entries)
+    do_autostart_noautostart('dis', entries)
+end
+
+local function do_set(params)
+    local name, value = params[1], params[2]
+    local data = registry.PREFERENCES_BY_NAME[name]
+    if not data then
+        qerror(('preference name not found: "%s"'):format(name))
+    end
+    common.set_preference(data, value)
+    common.config:write()
+end
+
+local function do_reset(params)
+    local name = params[1]
+    local data = registry.PREFERENCES_BY_NAME[name]
+    if not data then
+        qerror(('preference name not found: "%s"'):format(name))
+    end
+    common.set_preference(data, data.default)
+    common.config:write()
+end
+
+local command_switch = {
+    list=do_list,
+    enable=do_enable,
+    disable=do_disable,
+    autostart=do_autostart,
+    noautostart=do_noautostart,
+    set=do_set,
+    reset=do_reset,
+}
+
+local function main(args)
+    local help = false
+
+    local positionals = argparse.processArgsGetopt(args, {
+            {'h', 'help', handler=function() help = true end},
+        })
+
+    local command = table.remove(positionals, 1)
+    if help or not command or not command_switch[command] then
+        print(dfhack.script_help())
+        return
+    end
+
+    command_switch[command](positionals)
+end
+
+if not dfhack_flags.module then
+    main{...}
+end

docs/control-panel.rst

@@ -0,0 +1,69 @@
+control-panel
+=============
+
+.. dfhack-tool::
+    :summary: Configure DFHack and manage active DFHack tools.
+    :tags: dfhack
+
+This is the commandline interface for configuring DFHack behavior, toggling
+which functionality is enabled right now, and setting up which tools are
+enabled/run when starting new fortress games. For an in-game
+graphical interface, please use `gui/control-panel`. For a commandline
+interface for configuring which overlays are enabled, please use `overlay`.
+
+This interface controls three kinds of configuration:
+
+1. Tools that are enabled right now. These are DFHack tools that run in the
+background, like `autofarm`, or tools that DFHack can run on a repeating
+schedule, like the "autoMilk" functionality of `workorder`. Most tools that can
+be enabled are saved with your fort, so you can have different tools enabled
+for different forts. If a tool is marked "global", however, like
+`hide-tutorials`, then enabling it will make it take effect for all games.
+
+2. Tools or commands that should be auto-enabled or auto-run when you start a
+new fortress. In addition to tools that can be "enabled", this includes
+commands that you might want to run once just after you embark, such as
+commands to configure `autobutcher` or to drain portions of excessively deep
+aquifers.
+
+3. DFHack system preferences, such as whether "Armok" (god-mode) tools are
+shown in DFHack lists (including the lists of commands shown by the control
+panel) or mouse configuration like how fast you have to click for it to count
+as a double click (for example, when maximizing DFHack tool windows).
+Preferences are "global" in that they apply to all games.
+
+Run ``control-panel list`` to see the current settings and what tools and
+preferences are available for configuration.
+
+Usage
+-----
+
+::
+
+    control-panel list <search string>
+    control-panel enable|disable <command or number from list>
+    control-panel autostart|noautostart <command or number from list>
+    control-panel set <preference> <value>
+    control-panel reset <preference>
+
+Examples
+--------
+``control-panel list butcher``
+    Shows the current configuration of all commands related to `autobutcher`
+    (and anything else that includes the text "butcher" in it).
+``control-panel enable fix/empty-wheelbarrows`` or ``control-panel enable 25``
+    Starts to run `fix/empty-wheelbarrows` periodically to maintain the
+    usability of your wheelbarrows. In the second version of this command, the
+    number "25" is used as an example. You'll have to run
+    ``control-panel list`` to see what number this command is actually listed
+    as.
+``control-panel autostart autofarm``
+    Configures `autofarm` to become automatically enabled when you start a new
+    fort.
+``control-panel autostart fix/blood-del``
+    Configures `fix/blood-del` to run once when you start a new fort.
+``control-panel set HIDE_ARMOK_TOOLS true``
+    Enable "mortal mode" and hide "armok" tools in the DFHack UIs. Note that
+    this will also remove some entries from the ``control-panel list`` output.
+    Run ``control-panel list`` to see all preference options and their
+    descriptions.