docs: Add Bonfire

kitten-science · Jan 9, 2023 · c2ca8ea · c2ca8ea
1 parent 52dd6fc
commit c2ca8ea
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 11 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -15,6 +15,7 @@
   "cSpell.words": [
     "Astro",
     "autofeed",
+    "automations",
     "beforesave",
     "biolab",
     "Blackcoin",
@@ -31,6 +32,7 @@
     "chronoforge",
     "chronofurnace",
     "chronosphere",
+    "chronospheres",
     "cinfo",
     "Craftable",
     "Cryochamber",

diff --git a/packages/documentation/docs/sections/bonfire.md b/packages/documentation/docs/sections/bonfire.md
@@ -1 +1,19 @@
 # Bonfire
+
+## Buildings
+
+When you enable a building, this building will be built if all of these are true:
+
+1. Less than **Max** buildings have already been built.
+1. _All_ of the resources required for the building to built are filled to **Trigger** of their stock capacity.
+1. _All_ of the resources required for the building to built are sufficiently available after considering configured **Stock** and **Consume**.
+
+### Upgrades
+
+Buildings with a "⮤" in front of their name are upgrades to the building above them.
+
+You can select which upgrade will be automatically purchased by enabling them under **Upgrade buildings**.
+
+## Additional options
+
+**Turn on steamworks** turns on the Steamworks building as soon as the first one is purchased.
diff --git a/packages/documentation/docs/sections/overview.md b/packages/documentation/docs/sections/overview.md
@@ -18,17 +18,15 @@ The UI of KS is made up of _panels_. You recognize a panel from the little `+` s
 
 Most panels are also [settings](#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.
 
-#### Utilities
-
-!!! warning
+### Settings
 
-    These buttons are likely to be replaced by a different approach. Don't get used to them.
+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 panels, when expanded, show 3 more buttons:
+Some settings also come with additional options. These are shown on the same line as the checkbox. You can click on these options to change their value. Sometimes, these options behave like expando buttons and expand an entire new panel with options.
 
-1. Reset to defaults
+### Settings Lists
 
-    Set all options to the values that come with KS.
+A _settings list_ is a series of settings that have are grouped with each other. Sometimes, these lists have tools at the bottom. These tools can be any of these:
 
 1. Enable all options
 
@@ -38,11 +36,9 @@ Some panels, when expanded, show 3 more buttons:
 
     Turns everything off.
 
-### 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.
+1. Reset to defaults
 
-Some settings also come with additional options. These are shown on the same line as the checkbox. You can click on these options to change their value. Sometimes, these options behave like expando buttons and expand an entire new panel with options.
+    Set all options to the values that come with KS.
 
 ### Triggers