Merge remote-tracking branch 'upstream/master' into sci-gym-script

Author: realSquidCoder

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.31.2
+  rev: 0.32.1
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

changelog.txt

@@ -29,17 +29,28 @@ Template for new versions:
 ## New Tools
 
 ## New Features
+- `gui/mod-manager`: when run in a loaded world, shows a list of active mods -- click to export the list to the clipboard for easy sharing or posting
+
+## Fixes
+- `starvingdead`: properly restore to correct enabled state when loading a new game that is different from the first game loaded in this session
+- `starvingdead`: ensure undead decay does not happen faster than the declared decay rate when saving and loading the game
+
+## Misc Improvements
+
+## Removed
+
+# 51.11-r1
 
 ## Fixes
 - `list-agreements`: fix date math when determining petition age
 - `gui/petitions`: fix date math when determining petition age
+- `gui/rename`: fix commandline processing when manually specifying target ids
+- `gui/sandbox`: restore metal equipment options when spawning units
 
 ## Misc Improvements
 - `fix/loyaltycascade`: now also breaks up brawls and other intra-fort conflicts that *look* like loyalty cascades
 - `makeown`: remove selected unit from any current conflicts so they don't just start attacking other citizens when you make them a citizen of your fort
 
-## Removed
-
 # 51.09-r1
 
 ## New Features

docs/gui/mod-manager.rst

@@ -2,15 +2,33 @@ gui/mod-manager
 ===============
 
 .. dfhack-tool::
-    :summary: Save and restore lists of active mods.
+    :summary: Manange your active mods.
     :tags: dfhack interface
 
-Adds an optional overlay to the mod list screen that allows you to save and
-load mod list presets, as well as set a default mod list preset for new worlds.
+When run with a world loaded, shows a list of active mods. You can copy the
+list to the system clipboard for easy sharing or posting.
 
 Usage
 -----
 
 ::
 
     gui/mod-manager
+
+Overlay
+-------
+
+This tool also provides two overlays that are managed by the `overlay`
+framework.
+
+gui/mod-manager.button
+~~~~~~~~~~~~~~~~~~~~~~
+
+Adds a widget to the mod list screen that allows you to save and load mod list
+presets. You can also set a default mod list preset for new worlds so you don't
+have to manualy re-select the same mods every time you generate a world.
+
+gui/mod-manager.notification
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Displays a message when a mod preset has been auto-applied.

docs/starvingdead.rst

@@ -10,11 +10,11 @@ gradually decay, losing strength, speed, and toughness. After six months,
 they collapse upon themselves, never to be reanimated.
 
 Strength lost is proportional to the time until death, all units will have
-roughly 10% of each of their attributes' values when close to being removed.
+roughly 10% of each of their attributes' values when they succumb to decay.
 
 In any game, this can be a welcome gameplay feature, but it is especially
-useful in preventing undead cascades in the caverns in reanimating biomes,
-where constant combat can lead to hundreds of undead roaming the caverns and
+useful in preventing undead cascades in the caverns in reanimating biomes.
+Constant combat can lead to hundreds of undead roaming the caverns and
 destroying your FPS.
 
 Usage

emigration.lua

@@ -9,7 +9,10 @@ local unit_link_utils = reqscript('internal/emigration/unit-link-utils')
 local GLOBAL_KEY = 'emigration' -- used for state change hooks and persistence
 
 local function get_default_state()
-    return {enabled=false, last_cycle_tick=0}
+    return {
+        enabled=false,
+        last_cycle_tick=0
+    }
 end
 
 state = state or get_default_state()
@@ -127,15 +130,15 @@ function checkmigrationnow()
 end
 
 local function event_loop()
-    if state.enabled then
-        local current_tick = dfhack.world.ReadCurrentTick() + TICKS_PER_YEAR * dfhack.world.ReadCurrentYear()
-        if current_tick - state.last_cycle_tick < TICKS_PER_MONTH then
-            local timeout_ticks = state.last_cycle_tick - current_tick + TICKS_PER_MONTH
-            dfhack.timeout(timeout_ticks, 'ticks', event_loop)
-        else
-            checkmigrationnow()
-            dfhack.timeout(1, 'months', event_loop)
-        end
+    if not state.enabled then return end
+
+    local current_tick = dfhack.world.ReadCurrentTick() + TICKS_PER_YEAR * dfhack.world.ReadCurrentYear()
+    if current_tick - state.last_cycle_tick < TICKS_PER_MONTH then
+        local timeout_ticks = state.last_cycle_tick - current_tick + TICKS_PER_MONTH
+        dfhack.timeout(timeout_ticks, 'ticks', event_loop)
+    else
+        checkmigrationnow()
+        dfhack.timeout(1, 'months', event_loop)
     end
 end
 

fix/ownership.lua

@@ -33,7 +33,7 @@ local zone_vecs = {
 local function relink_zones()
     for _,zones in ipairs(zone_vecs) do
         for _,zone in ipairs(zones) do
-            local unit = zone.assigned_unit
+            local unit = dfhack.buildings.getOwner(zone)
             if not unit then goto continue end
             if not utils.linear_index(unit.owned_buildings, zone.id, 'id') then
                 print(('fix/ownership: Restoring %s ownership link for %s'):format(

gui/family-affairs.lua

@@ -777,7 +777,7 @@ end
 FamilyAffairs = defclass(FamilyAffairs, widgets.Window)
 FamilyAffairs.ATTRS {
     frame_title='Family manager',
-    frame={w=50, h=30, r=2, t=18},
+    frame={w=65, h=30, r=2, t=18},
     frame_inset={t=1, l=1, r=1},
     resizable=true,
     initial_tab=DEFAULT_NIL,

gui/manipulator.lua

@@ -709,11 +709,11 @@ function Spreadsheet:init()
         },
         DataColumn{
             view_id='name',
-            frame={w=30},
+            frame={w=45},
             label='Name',
             label_inset=8,
             data_fn=dfhack.units.getReadableName,
-            data_width=30,
+            data_width=45,
             shared=self.shared,
         },
         cols,

gui/mod-manager.lua

@@ -1,12 +1,13 @@
--- Save and restore lists of active mods.
+-- Show, save, and restore lists of active mods.
 --@ module = true
 
-local overlay = require('plugins.overlay')
-local gui = require('gui')
-local widgets = require('gui.widgets')
 local dialogs = require('gui.dialogs')
+local gui = require('gui')
 local json = require('json')
+local overlay = require('plugins.overlay')
+local scriptmanager = require('script-manager')
 local utils = require('utils')
+local widgets = require('gui.widgets')
 
 local presets_file = json.open("dfhack-config/mod-manager.json")
 local GLOBAL_KEY = 'mod-manager'
@@ -119,6 +120,9 @@ local function swap_modlist(viewscreen, modlist)
     return failures
 end
 
+--------------------
+-- ModmanageMenu
+
 ModmanageMenu = defclass(ModmanageMenu, widgets.Window)
 ModmanageMenu.ATTRS {
     view_id = "modman_menu",
@@ -389,6 +393,9 @@ function ModmanageMenu:init()
     }
 end
 
+--------------------
+-- ModmanageScreen
+
 ModmanageScreen = defclass(ModmanageScreen, gui.ZScreen)
 ModmanageScreen.ATTRS {
     focus_path = "mod-manager",
@@ -401,6 +408,163 @@ function ModmanageScreen:init()
     }
 end
 
+--------------------
+-- ModlistWindow
+
+ModlistWindow = defclass(ModlistWindow, widgets.Window)
+ModlistWindow.ATTRS{
+    frame_title="Active Mods",
+    frame={w=55, h=20},
+    resizable=true,
+}
+
+local function get_num_vanilla_mods()
+    local count = 0
+    for _,mod in ipairs(scriptmanager.get_active_mods()) do
+        if mod.vanilla then
+            count = count + 1
+        end
+    end
+    return count
+end
+
+local function get_num_non_vanilla_mods()
+    local count = 0
+    for _,mod in ipairs(scriptmanager.get_active_mods()) do
+        if not mod.vanilla then
+            count = count + 1
+        end
+    end
+    return count
+end
+
+function ModlistWindow:init()
+    self:addviews{
+        widgets.CycleHotkeyLabel{
+            view_id='vanilla',
+            frame={l=0, t=0, w=24},
+            key='CUSTOM_V',
+            label='Vanilla mods:',
+            options={
+                {label='Include', value=true, pen=COLOR_LIGHTBLUE},
+                {label='Exclude', value=false, pen=COLOR_LIGHTRED},
+            },
+            initial_option=false,
+            on_change=function() self:refresh_list() end,
+        },
+        widgets.Divider{
+            frame={t=2, h=1},
+            frame_style=gui.FRAME_THIN,
+            frame_style_l=false,
+            frame_style_r=false,
+        },
+        widgets.HotkeyLabel{
+            frame={t=4, r=0},
+            label='Export to clipboard (single line)',
+            text_pen=COLOR_YELLOW,
+            auto_width=true,
+            on_activate=function()
+                local text = {}
+                for _,choice in ipairs(self.subviews.list:getChoices()) do
+                    table.insert(text, ('%s %s'):format(choice.data.name, choice.data.version))
+                end
+                dfhack.internal.setClipboardTextCp437Multiline(table.concat(text, ', '))
+            end,
+            enabled=function() return #self.subviews.list:getChoices() > 0 end,
+        },
+        widgets.HotkeyLabel{
+            frame={t=5, r=0},
+            label='Export to clipboard (with links)',
+            text_pen=COLOR_YELLOW,
+            auto_width=true,
+            on_activate=function()
+                local text = {}
+                for _,choice in ipairs(self.subviews.list:getChoices()) do
+                    table.insert(text, choice.export_text)
+                end
+                dfhack.internal.setClipboardTextCp437Multiline(table.concat(text, NEWLINE))
+            end,
+            enabled=function() return #self.subviews.list:getChoices() > 0 end,
+        },
+        widgets.Label{
+            frame={l=0, t=4},
+            text={
+                'Load',
+                NEWLINE,
+                'order',
+            },
+        },
+        widgets.Label{
+            frame={l=7, t=5},
+            text='Mod',
+        },
+        widgets.List{
+            view_id='list',
+            frame={t=7, b=2},
+        },
+        widgets.Label{
+            frame={l=0, b=0},
+            text={
+                {text=('%d'):format(get_num_vanilla_mods()), pen=COLOR_LIGHTBLUE},
+                ' vanilla mods',
+                {text=function() return self.subviews.vanilla:getOptionValue() and '' or ' (hidden)' end},
+                ', ',
+                {text=('%d'):format(get_num_non_vanilla_mods()), pen=COLOR_BROWN},
+                ' non-vanilla mods',
+            },
+        },
+    }
+
+    self:refresh_list()
+end
+
+function ModlistWindow:refresh_list()
+    local include_vanilla = self.subviews.vanilla:getOptionValue()
+
+    local choices = {}
+    for idx,mod in ipairs(scriptmanager.get_active_mods()) do
+        if not include_vanilla and mod.vanilla then goto continue end
+        local steam_id = scriptmanager.get_mod_info_metadata(mod.path, 'STEAM_FILE_ID').STEAM_FILE_ID
+        local url = steam_id and (': https://steamcommunity.com/sharedfiles/filedetails/?id=%s'):format(steam_id) or ''
+        table.insert(choices, {
+            text={
+                {text=idx, width=2, rjustify=true},
+                ') ',
+                {text=mod.name, gap=3},
+                ' (',
+                {text=mod.version, pen=COLOR_LIGHTGREEN},
+                ')',
+            },
+            data=mod,
+            export_text=('- %s (%s)%s'):format(mod.name, mod.version, url),
+        })
+        ::continue::
+    end
+
+    self.subviews.list:setChoices(choices)
+end
+
+--------------------
+-- ModlistScreen
+
+ModlistScreen = defclass(ModlistScreen, gui.ZScreen)
+ModlistScreen.ATTRS{
+    focus_path="mod-manager",
+}
+
+function ModlistScreen:init()
+    self:addviews{
+        ModlistWindow{}
+    }
+end
+
+function ModlistScreen:onDismiss()
+    view = nil
+end
+
+--------------------
+-- Overlays
+
 ModmanageOverlay = defclass(ModmanageOverlay, overlay.OverlayWidget)
 ModmanageOverlay.ATTRS {
     frame = { w=16, h=3 },
@@ -494,5 +658,8 @@ if dfhack_flags.module then
     return
 end
 
--- TODO: when invoked as a command, should show information on which mods are loaded
--- and give the player the option to export the list (or at least copy it to the clipboard)
+if not dfhack.isWorldLoaded() then
+    qerror("Please load a game before using the mod manager to see active mods.")
+end
+
+view = view and view:raise() or ModlistScreen{}:show()

gui/notes.lua

@@ -361,8 +361,7 @@ function main()
         qerror('notes requires a fortress map to be loaded')
     end
 
-    view = view and view:raise() or NotesScreen{
-    }:show()
+    view = view and view:raise() or NotesScreen{}:show()
 end
 
 if not dfhack_flags.module then