📦 add docs for digital miner, dynamic tank

cyberbit · Aug 17, 2024 · 1473bb0 · 1473bb0
1 parent 33fb6af
commit 1473bb0
Show file tree

Hide file tree

Showing 5 changed files with 126 additions and 4 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -61,7 +61,7 @@ export default defineConfig({
             ]
           },
           {
-            text: 'Mekanism',
+            text: 'Mekanism [🚧 WIP 🚧]',
             collapsed: true,
             items: [
               { text: 'Antiprotonic Nucleosynthesizer', link: '/reference/input/mekanism/AntiprotonicNucleosynthesizer' },
@@ -79,8 +79,8 @@ export default defineConfig({
               // { text: 'Compressing Factory', link: '/reference/input/mekanism/CompressingFactory' },
               { text: 'Crusher', link: '/reference/input/mekanism/Crusher' },
               // { 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: 'Digital Miner', link: '/reference/input/mekanism/DigitalMiner' },
+              { text: 'Dynamic Tank', link: '/reference/input/mekanism/DynamicTank' },
               // { text: 'Electric Pump', link: '/reference/input/mekanism/ElectricPump' },
               // { text: 'Electrolytic Separator', link: '/reference/input/mekanism/ElectrolyticSeparator' },
               // { text: 'Energized Smelter', link: '/reference/input/mekanism/EnergizedSmelter' },

diff --git a/docs/assets/mekanism-dynamic-tank.webp b/docs/assets/mekanism-dynamic-tank.webp
diff --git a/docs/reference/input/mekanism/DigitalMiner.md b/docs/reference/input/mekanism/DigitalMiner.md
@@ -0,0 +1,61 @@
+---
+telem:
+  adapter:
+    id: 'digitalMiner'
+    name: 'Digital Miner'
+    categories: '{ "basic", "advanced", "energy" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Digital Miner Input <RepoLink path="lib/input/mekanism/DigitalMinerInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+```lua
+STATES = { FINISHED = 1, IDLE = 2, PAUSED = 3, SEARCHING = 4 }
+```
+
+<MetricTable
+  prefix="mekminer:"
+  :metrics="[
+    { name: 'running',      value: '0 or 1'                   },
+    { name: 'slot_count',   value: '0 - inf'                  },
+    { name: 'state',        value: 'STATES value'             },
+    { name: 'to_mine',      value: '0 - inf'                  },
+    { name: 'energy_usage', value: '0.0 - inf', unit: 'FE/t'  },
+    { name: 'slot_usage',   value: '0 - inf'                  },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekminer:"
+  :metrics="[
+    { name: 'auto_eject',                         value: '0 or 1'             },
+    { name: 'auto_pull',                          value: '0 or 1'             },
+    { name: 'inverse_mode',                       value: '0 or 1'             },
+    { name: 'inverse_mode_requires_replacement',  value: '0 or 1'             },
+    { name: 'max_radius',                         value: '1 - inf', unit: 'm' },
+    { name: 'max_y',                              value: '-inf - inf'         },
+    { name: 'min_y',                              value: '-inf - inf'         },
+    { name: 'radius',                             value: '0 - inf', unit: 'm' },
+    { name: 'silk_touch',                         value: '0 or 1'             },
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekminer:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/DynamicTank.md b/docs/reference/input/mekanism/DynamicTank.md
@@ -0,0 +1,61 @@
+---
+telem:
+  adapter:
+    id: 'dynamicTank'
+    name: 'Dynamic Tank'
+    categories: '{ "basic", "storage", "formation" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Dynamic Tank Input <RepoLink path="lib/input/mekanism/DynamicTankInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<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' }
+  ]"
+/>
+
+### Storage
+
+<MetricTable
+  prefix="mekdyntank:"
+  :metrics="[
+    { name: 'stored',             value: '0.0 - inf', unit: 'B' },
+    { name: 'fluid_capacity',     value: '0.0 - inf', unit: 'B' },
+    { name: 'chemical_capacity',  value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Formation
+
+<MetricTable
+  prefix="mekdyntank:"
+  :metrics="[
+    ...metrics.multiblock.formation
+  ]"
+/>
+
+
+## Storage
+Dynamic tanks may hold either a fluid or a chemical. If the tank is not empty, a storage metric is added for the contents. Given a dynamic tank with the following contents:
+
+![Mekanism Dynamic Tank with contents](/assets/mekanism-dynamic-tank.webp)
+
+The following metric would be added:
+
+<MetricTable
+  prefix="storage:"
+  :metrics="[
+    { name: 'tconstruct:molten_ender', value: '7455.75', unit: 'B' }
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/common/metrics.data.ts b/docs/reference/input/mekanism/common/metrics.data.ts
@@ -29,7 +29,7 @@ export default {
 
       multiblock: {
         formation: [
-          { name: 'formed', value: '0 or 1',  unit: 'B' },
+          { name: 'formed', value: '0 or 1',            },
           { name: 'height', value: '0 - inf', unit: 'm' },
           { name: 'length', value: '0 - inf', unit: 'm' },
           { name: 'width',  value: '0 - inf', unit: 'm' }