Skip to content

Commit

Permalink
docs: Clarify consume rate
Browse files Browse the repository at this point in the history
  • Loading branch information
oliversalzburg committed Mar 9, 2023
1 parent cf38511 commit e9d229a
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion packages/documentation/docs/sections/resource-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

This section allows you to control how much of your resources will be consumed by KS automations.

## Stock

The value you set for **Stock** determines the amount of the resource that KS will never touch. The only reason to set this value to anything but `0`, is for you to manually do something. The stocked amount of the resource will be entirely unavailable to KS.

The **Consume** rate defines how much of an available resource should be made available to automation as a percentage. The usefulness of this value is debateable.
## Consume

The **Consume** rate defines how much of an available resource should be made available to automation as a percentage.

This applies to the amount of resources that are available after the **Stock** has been considered. Of the excess amount beyond your stock, the consume rate is made available for consumption.

The default value for this is always `1`. You would usually want to lower this, if you want to interact with the game more manually.

!!! example

Your capacity for **Wood** is `10K`. Your **Stock** for Wood is `5K`. Your **Consume** rate for Wood is set to `0.1`.

When an automation now asks for the available amount of Wood, we would expect the result to be:

( 10K Wood - 5K Stock ) * 0.1 Consume Rate = 500 Wood

0 comments on commit e9d229a

Please sign in to comment.