Skip to content

Disable heavy scanning in chronicle #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions chronicle.lua
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- Chronicles fortress events (deaths, artifacts, invasions)
-- Chronicles fortress events (currently only unit deaths)
--@module = true
--@enable = true

Expand Down Expand Up @@ -64,10 +64,10 @@ local function check_invasions()
end
end

-- main loop; artifact and invasion tracking disabled to avoid scanning large
-- data structures, which was causing hangs on some forts
local function event_loop()
if not state.enabled then return end
check_artifacts()
check_invasions()
dfhack.timeout(1200, 'ticks', event_loop)
end

Expand Down
6 changes: 3 additions & 3 deletions docs/chronicle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ chronicle
=========

.. dfhack-tool::
:summary: Record fortress events like deaths, artifacts, and invasions.
:summary: Record fortress events like deaths. Artifact and invasion tracking disabled.
:tags: fort gameplay

This tool automatically records notable events in a chronicle that is stored
with your save. The chronicle contains entries for unit deaths, newly created
artifacts, and the start of invasions.
with your save. Currently only unit deaths are recorded since artifact and
invasion tracking has been disabled due to performance issues.

Usage
-----
Expand Down