Overview¶
Introduction¶
The UI of KS is divided into several major sections. The names of these sections correlate to the main tabs in the KG UI.
Refer to the individual section documentation pages for details of the automation features on those sections.
UI Concepts¶
Panels¶
The UI of KS is made up of panels. You recognize a panel from the little symbol on it. When you click on the , the panel expands and the turns into a . When you now click the , the panel collapses again.
Note
The / button is sometimes referred to as an expando.
When you use the expando on the top-most entry, you can expand/collapse all panels at once.
Most panels are also settings. Which means that they have a checkbox as their top element, which is always visible, even when the panel is collapsed. When you disable this setting, it causes any automation that is controlled through that section of the UI to be bypassed.
Settings¶
A setting in KS is most commonly a checkbox. When the checkbox is checked, this feature is active. If the checkbox is unchecked, the feature is inactive.
Some settings also come with additional options, like a trigger value, or a limit. These are shown on the same line as the checkbox. You can click on these options to change their value.
Settings Lists¶
A settings list is a series of settings that are grouped with each other. Sometimes, these lists have tools at the bottom. These tools can be any of these:
-
Enable all options
Activates everything.
-
Disable all options
Turns everything off.
-
Reset to defaults
Turns everything off, and also resets any options of the settings.
Triggers¶
One common option to see is the trigger, symbolized by a little lightning . A trigger usually communicates at which threshold an automation should become active. Which resource this threshold refers to, is documented with the individual automations.
Triggers can be absolute values, or a percentage. This percentage then usually refers to your storage capacity for a given resource. When you enter a percentage value into KS, it expects you to provide it as a value between 0
and 100
. So if you wanted a trigger value at ¾ of your storage capacity, you'd enter 75
. Fractions are also supported.
Limits¶
Another common option is the limit. This will usually prevent an automation from going over a certain value. The most important aspects to understand are:
-1
means infinity. Effectively disables the limit.0
means don't do anything ever.- any other number will be the limit for this automation.
Hint
When entering limits, you can usually use the KG notations for big numbers. So 9.5M
will become 9,500,000
.
Ineffective Configuration¶
Sometimes icons in the UI pulse in red to signal an ineffective state. This is most common during the time when you author your first settings. A configuration is ineffective when the parameters don't allow for any action. In such cases, you either need to fix the configuration, or just disable the automation.
Example
Examples of ineffective configurations:
- A building is enabled, but it's set to be built a max of
0
of times. - A building is enabled, but all triggers are set to infinity.
- A trade is enabled, but no seasons are selected.