ATS-StockAlert

ATS-StockAlert is a BepInEx mod for Against the Storm that warns you when your stock of a good drops below its in-game global production limit.

What it does

Displays goods that have a production limit set in the Recipes menu, and shows their current/max stock in a compact, movable, hideable HUD anchored to the bottom-right or bottom-left corner.

Stock below production limit that cannot be produced further (after current in-progress productions), are now marked in red.

It can also optionally auto-adjust production limits for all goods you currently have a recipe for, based on the number of people consuming them and an adjustable multiplier.

It can also optionally auto-adjust the Purging Fire production limit in blight posts to the number of existing cysts plus one.

It can also optionally queue a chosen race for a worker slot by Ctrl+clicking a race portrait, so the slot auto-fills the next time it becomes empty and a matching free villager becomes available.

It can also optionally show how much of each insufficient ingredient is currently sitting in non-warehouse buildings in the ingredient selection wheel.

It can also optionally show the embarkation bonus cost range on the top-left and the current cost on the top-right, colored by where it falls in the possible range.

It can also optionally show estimated trade route profit as a percentage compared to selling the raw material inputs at the bottom of the production chain.

It also shows a countdown badge on bottom-left event modifier icons when the modifier has a repeating time-based trigger, such as Friend or Foe.

It also changes the base-game top-left builder counter from available to available/needed, where needed is how many additional builders could immediately work on active construction sites.

When assigning a villager to a building from the builders pool, it also preserves the game's normal builder choice formula but deprioritizes builders who are currently carrying goods. The base game scores eligible builders by break status plus distance to the target building, with lower scores picked first. Stock Alert adds a penalty to builders carrying goods, so a nearby builder hauling materials is less likely to drop their delivery when another suitable free builder is available.

Hovering an assigned worker slot or a race portrait in the worker selection wheel shows a bright ring at the feet of the villager who is assigned or would be assigned.

Hovering the bottom blightrot icon shows unlocked buildings that you currently have zero of, with building icons, excluding decorations, houses, warehouses, hearths, hydrants, roads, gathering posts, geysers, and similar source-only buildings.

It can also show an overlay for finding items by Ctrl+clicking an item's icon. The overlay appears above buildings, events, and resource nodes that contain or provide that item.

It can also optionally show a persistent alert when you have idle builders, and optionally pause with an alert 3 seconds before a season ends so you can check trade routes.

It can also optionally highlight recipe buildings in the world when they have an enabled recipe for goods that are currently under threshold:

• red when the building can help, but has no workers assigned
• yellow when the building can help, has at least one worker, but is not fully staffed
• grey when the building has enabled shortage recipes, but none can currently be produced because ingredients are missing
• normal white vanilla icon when the building is unmanned but none of its recipes are currently under threshold

Building shortage indicators also show the matching shortage product icons next to the worker icon, and also mark farms when fields in range need seasonal work.

When a good is marked red because it cannot continue production after current in-progress productions, these building indicators can also extend to gathering/source posts that can provide its missing ingredients.

Warehouses with assigned haulers show a small hauler indicator with the current hauler count.

Integrated Builder Icon mod made by ~DGH into my mod with some changes:

• the exclamation marker for builders that are idling
• the hammer icon for all other builders
• when builder status icons are enabled, race portraits in the building worker assignment wheel are also marked if that race has an idle builder

Newly triggered shortages go at the top of the list.

Options for HUD anchor, movable, hideable, building indicators, builder status icons, idle builders alert, queued worker assignments, ingredient wheel building stock, embarkation cost ranges, trade route profit, season ending trade routes alert, Purging Fire auto-adjust, and production limit multiplier are available in the F8 settings window.

The builder demand counter is enabled by default and is configured only in the BepInEx config file, not the F8 settings window. To disable it, edit BepInEx/config/StockAlert.cfg and set:

[HUD]
ShowBuilderDemandCounter = false

Some other default-on HUD helpers are also configured only in BepInEx/config/StockAlert.cfg, not the F8 settings window. To disable them, set:

[HUD]
ShowWorkerHoverHighlight = false
ShowZeroBuildingBlueprintHover = false

If a good has no production limit, it is ignored by the mod.

Usage

1. Set a global production limit for a good in the Recipes menu.
2. When your current stock drops below that limit, the good appears in the Stock Alert HUD.
3. Press F8 to open the Stock Alert settings window.
4. Optional: choose whether the Stock Alert HUD anchors to the bottom-right or bottom-left corner.
5. Optional: enable auto-adjust in the F8 window to make the mod set eligible global production limits for you.
6. Optional: enable Purging Fire auto-adjust in the F8 window to make blight posts keep that limit at existing cysts + 1.
7. Optional: enable building shortage indicators in the F8 window to spot where extra staffing would help with current shortages.
8. Optional: enable builder status icons in the F8 window to distinguish idle free builders from busy free builders and mark matching race portraits in the building worker assignment wheel.
9. Optional: enable queued worker assignments in the F8 window, then Ctrl+click a race portrait to reserve that race for a worker slot until the next vacancy.
10. Optional: enable ingredient wheel building stock in the F8 window to show how much of each insufficient ingredient is currently sitting in non-warehouse buildings.
11. Optional: enable embarkation cost ranges in the F8 window to show the possible cost range and current cost on embarkation bonuses.
12. Optional: enable trade route profit in the F8 window to show estimated percentage profit on trade route offers.
13. Ctrl+click an item's icon to show an overlay over buildings, events, and resource nodes that contain or provide that item.

Auto-adjust option

• off by default
• when enabled, the mod checks how many alive villagers can consume a good and sets that good's global production limit to consumers x multiplier
• the multiplier is editable in the F8 window from 1.0 to 9.0
• values round up to the next whole number
• only goods for recipes available from unlocked blueprints are adjusted
• disabling the option stops further automatic changes, but does not restore previous manual limits

Purging Fire auto-adjust option

• off by default
• when enabled, the mod sets the Purging Fire production limit in blight posts to existing cysts + 1
• disabling the option stops further automatic changes, but does not restore the previous manual limit

Queued worker assignments

• off by default
• when enabled, Ctrl+clicking a race portrait queues that race for the worker slot, whether or not a free villager of that race is currently available
• the queued race appears to the left of the normal worker slot icon
• clicking the queued icon lets you change or clear the queued race
• queued workers only auto-fill when the slot becomes empty and a matching free villager becomes available
• if multiple slots are waiting for the same race, the oldest queue is filled first
• queues last only for the current session

Builder assignment priority

• enabled by default
• the base game chooses from eligible free builders by scoring break status plus distance to the target building, then picking the lowest score
• Stock Alert keeps that formula and adds a penalty when a candidate builder is currently carrying goods
• this makes carrying builders less likely to be pulled away from deliveries when assigning a villager to a building
• hovering an assigned worker slot highlights that villager in the world with a bright ring at their feet
• hovering a race portrait in the worker selection wheel highlights the villager who would currently be assigned
• to disable the carrying-builder assignment priority, edit BepInEx/config/StockAlert.cfg and set:

[Workers]
AvoidAssigningCarryingBuilders = false

• to disable the hover highlight ring, edit BepInEx/config/StockAlert.cfg and set:

[HUD]
ShowWorkerHoverHighlight = false

Blightrot zero-building hover

• enabled by default
• hovering the bottom blightrot icon shows unlocked buildings that you currently have zero of, with building icons
• excludes decorations, houses, warehouses, hearths, hydrants, roads, gathering posts, geysers, and similar source-only buildings
• to disable it, edit BepInEx/config/StockAlert.cfg and set ShowZeroBuildingBlueprintHover = false; set it back to true to re-enable it:

[HUD]
ShowZeroBuildingBlueprintHover = false

Ingredient wheel building stock

• off by default
• when enabled, the ingredient wheel shows how much of each insufficient ingredient is currently sitting in non-warehouse buildings
• the extra amount appears in parentheses after the normal available/needed value

Embarkation cost ranges

• off by default
• when enabled, embarkation bonus cost ranges are shown on the top-left of each bonus, with the current cost on the top-right
• the current cost is green for the lowest possible roll, yellow for a middle roll, and red for the highest possible roll
• since the F8 settings window is currently only available while in a mission, players who want to enable it before embarking should launch the game once with this mod version to generate the config option, quit the game, then set ShowEmbarkationCostRanges = true in the BepInEx config

Trade route profit

• off by default
• when enabled, trade route offers show estimated percentage profit next to the travel time
• profit is calculated as final amber reward minus the estimated production cost of the materials and packs of provisions
• production cost uses the cheapest available recipe chain from unlocked blueprints, following the chain down to raw material inputs
• recipe costs use the live recipe output amounts shown in buildings, including perks and other production bonuses, falling back to trader sell value for raw or unavailable goods
• the trade routes screen has an Available inputs option to only use recipe chains that can currently be crafted from available raw ingredients
• the displayed percentage compares total route profit to the trader sell value of the raw inputs used by that recipe path
• hover the profit text to see the calculation breakdown
• trade route reward, packs of provisions, and trader sell value modifiers are included
• travel time is not converted into profit

Item finder overlay

• Ctrl+click an item's icon to toggle an overlay for finding that item
• the overlay appears above buildings, events, and resource nodes that contain or provide the item
• building overlays show a count for how much of that item is there, including goods already in transit to that building
• resource nodes do not show a count

Requirements

• Against the Storm
• BepInEx 5
• ATS API 3.7.0 or newer

Credits

• Builder status icon feature adapted from BuilderIcon source by ~DGH

Build

Update StormPath in StockAlert.csproj to match your game install, then build the project.