📦 add docs for electric pump, tweak docs for dynamic tank

cyberbit · Aug 31, 2024 · 5f0920a · 5f0920a
1 parent 2064c7f
commit 5f0920a
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 4 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -81,7 +81,7 @@ export default defineConfig({
               // { text: 'Crushing Factory', link: '/reference/input/mekanism/CrushingFactory' },
               { text: 'Digital Miner', link: '/reference/input/mekanism/DigitalMiner' },
               { text: 'Dynamic Tank', link: '/reference/input/mekanism/DynamicTank' },
-              // { text: 'Electric Pump', link: '/reference/input/mekanism/ElectricPump' },
+              { text: 'Electric Pump', link: '/reference/input/mekanism/ElectricPump' },
               // { text: 'Electrolytic Separator', link: '/reference/input/mekanism/ElectrolyticSeparator' },
               // { text: 'Energized Smelter', link: '/reference/input/mekanism/EnergizedSmelter' },
               // { text: 'Energy Cube', link: '/reference/input/mekanism/EnergyCube' },

diff --git a/docs/reference/input/mekanism/DynamicTank.md b/docs/reference/input/mekanism/DynamicTank.md
@@ -19,9 +19,9 @@ telem:
 <MetricTable
   prefix="mekdyntank:"
   :metrics="[
-    { name: 'filled_percentage', value: '0.0 - 1.0',  unit: 'B' },
-    { name: 'input_item_count',  value: '0 - inf',    unit: 'item' },
-    { name: 'output_item_count', value: '0 - inf',    unit: 'item' }
+    { name: 'filled_percentage', value: '0.0 - 1.0'                 },
+    { name: 'input_item_count',  value: '0 - inf',    unit: 'item'  },
+    { name: 'output_item_count', value: '0 - inf',    unit: 'item'  }
   ]"
 />
 

diff --git a/docs/reference/input/mekanism/ElectricPump.md b/docs/reference/input/mekanism/ElectricPump.md
@@ -0,0 +1,56 @@
+---
+telem:
+  adapter:
+    id: 'electricPump'
+    name: 'Electric Pump'
+    categories: '{ "basic", "advanced", "output", "energy" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Electric Pump Input <RepoLink path="lib/input/mekanism/ElectricPumpInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekpump:"
+  :metrics="[
+    { name: 'input_item_count',         value: '0 - inf', unit: 'item'  },
+    { name: 'output_item_count',        value: '0 - inf', unit: 'item'  },
+    { name: 'fluid_filled_percentage',  value: '0.0 - 1.0'              },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekpump:"
+  :metrics="[
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekpump:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>
+
+### Output
+
+<MetricTable
+  prefix="mekpump:"
+  :metrics="[
+    { name: 'fluid',          value: '0.0 - inf', unit: 'B' },
+    { name: 'fluid_capacity', value: '0.0 - inf', unit: 'B' },
+    { name: 'fluid_needed',   value: '0.0 - inf', unit: 'B' }
+  ]"
+/>