📦 add docs for gas generator and heat generator

cyberbit · Oct 23, 2024 · 348b984 · 348b984
1 parent 90a4408
commit 348b984
Show file tree

Hide file tree

Showing 3 changed files with 122 additions and 2 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -93,8 +93,8 @@ export default defineConfig({
               { text: 'Formulaic Assemblicator', link: '/reference/input/mekanism/FormulaicAssemblicator' },
               { text: 'Fuelwood Heater', link: '/reference/input/mekanism/FuelwoodHeater' },
               { text: 'Fusion Reactor', link: '/reference/input/mekanism/FusionReactor' },
-              // { text: 'Gas Generator', link: '/reference/input/mekanism/GasGenerator' },
-              // { text: 'Heat Generator', link: '/reference/input/mekanism/HeatGenerator' },
+              { text: 'Gas Generator', link: '/reference/input/mekanism/GasGenerator' },
+              { text: 'Heat Generator', link: '/reference/input/mekanism/HeatGenerator' },
               { text: 'Induction Matrix', link: '/reference/input/mekanism/InductionMatrix' },
               { text: 'Industrial Turbine', link: '/reference/input/mekanism/IndustrialTurbine' },
               // { text: 'Infusing Factory', link: '/reference/input/mekanism/InfusingFactory' },

diff --git a/docs/reference/input/mekanism/GasGenerator.md b/docs/reference/input/mekanism/GasGenerator.md
@@ -0,0 +1,59 @@
+---
+telem:
+  adapter:
+    id: 'gasGenerator'
+    name: 'Gas Generator'
+    categories: '{ "basic", "advanced", "fuel", "energy" }'
+    requiresMekGen: true
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Gas Generator Input <RepoLink path="lib/input/mekanism/GasGeneratorInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekgasgen:"
+  :metrics="[
+    { name: 'fuel_filled_percentage', value: '0.0 - 1.0'                },
+    { name: 'burn_rate',              value: '0.0 - inf', unit: 'B/t'   },
+    { name: 'fuel_item_count',        value: '0 - inf',   unit: 'item'  },
+    ...metrics.genericMachine.basic,
+    ...metrics.generator.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekgasgen:"
+  :metrics="[
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Fuel
+
+<MetricTable
+  prefix="mekgasgen:"
+  :metrics="[
+    { name: 'fuel',           value: '0.0 - inf', unit: 'B' },
+    { name: 'fuel_capacity',  value: '0.0 - inf', unit: 'B' },
+    { name: 'fuel_needed',    value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekgasgen:"
+  :metrics="[
+    ...metrics.genericMachine.energy,
+    ...metrics.generator.energy
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/HeatGenerator.md b/docs/reference/input/mekanism/HeatGenerator.md
@@ -0,0 +1,61 @@
+---
+telem:
+  adapter:
+    id: 'heatGenerator'
+    name: 'Heat Generator'
+    categories: '{ "basic", "advanced", "fuel", "energy" }'
+    requiresMekGen: true
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Heat Generator Input <RepoLink path="lib/input/mekanism/HeatGeneratorInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekheatgen:"
+  :metrics="[
+    { name: 'fuel_item_count',        value: '0 - inf',   unit: 'item'  },
+    { name: 'lava_filled_percentage', value: '0.0 - 1.0'                },
+    { name: 'temperature',            value: '0.0 - inf', unit: 'K'     },
+    ...metrics.genericMachine.basic,
+    ...metrics.generator.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekheatgen:"
+  :metrics="[
+    { name: 'transfer_loss',      value: '0.0 - inf' },
+    { name: 'environmental_loss', value: '0.0 - inf' },
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Fuel
+
+<MetricTable
+  prefix="mekheatgen:"
+  :metrics="[
+    { name: 'lava',           value: '0.0 - inf', unit: 'B' },
+    { name: 'lava_capacity',  value: '0.0 - inf', unit: 'B' },
+    { name: 'lava_needed',    value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekheatgen:"
+  :metrics="[
+    ...metrics.genericMachine.energy,
+    ...metrics.generator.energy
+  ]"
+/>