📦 add docs for combining, compressing, and crushing factories, fix no…

…n-factory combiner and crusher prefix
cyberbit · Feb 17, 2025 · 633476f · 633476f
1 parent 042f7e9
commit 633476f
Show file tree

Hide file tree

Showing 7 changed files with 195 additions and 12 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -75,10 +75,10 @@ export default defineConfig({
               { text: 'Chemical Tank', link: '/reference/input/mekanism/ChemicalTank' },
               { text: 'Chemical Washer', link: '/reference/input/mekanism/ChemicalWasher' },
               { text: 'Combiner', link: '/reference/input/mekanism/Combiner' },
-              // { text: 'Combining Factory', link: '/reference/input/mekanism/CombiningFactory' },
-              // { text: 'Compressing Factory', link: '/reference/input/mekanism/CompressingFactory' },
+              { text: 'Combining Factory', link: '/reference/input/mekanism/CombiningFactory' },
+              { text: 'Compressing Factory', link: '/reference/input/mekanism/CompressingFactory' },
               { text: 'Crusher', link: '/reference/input/mekanism/Crusher' },
-              // { text: 'Crushing Factory', link: '/reference/input/mekanism/CrushingFactory' },
+              { 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' },

diff --git a/docs/reference/input/mekanism/Combiner.md b/docs/reference/input/mekanism/Combiner.md
@@ -17,7 +17,7 @@ telem:
 ### Basic
 
 <MetricTable
-  prefix="mekcombiner:"
+  prefix="mekcombine:"
   :metrics="[
     { name: 'input_main_count',       value: '0 - inf',   unit: 'item' },
     { name: 'input_secondary_count',  value: '0 - inf',   unit: 'item' },
@@ -30,7 +30,7 @@ telem:
 ### Advanced
 
 <MetricTable
-  prefix="mekcombiner:"
+  prefix="mekcombine:"
   :metrics="[
     ...metrics.genericMachine.advanced
   ]"
@@ -40,7 +40,7 @@ telem:
 ### Energy
 
 <MetricTable
-  prefix="mekcombiner:"
+  prefix="mekcombine:"
   :metrics="[
     ...metrics.genericMachine.energy
   ]"
@@ -49,7 +49,7 @@ telem:
 ### Recipe
 
 <MetricTable
-  prefix="mekcombiner:"
+  prefix="mekcombine:"
   :metrics="[
     ...metrics.recipeProgress.recipe
   ]"

diff --git a/docs/reference/input/mekanism/CombiningFactory.md b/docs/reference/input/mekanism/CombiningFactory.md
@@ -0,0 +1,57 @@
+---
+telem:
+  adapter:
+    id: 'combiningFactory'
+    name: 'Combining Factory'
+    categories: '{ "basic", "advanced", "energy", "recipe" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Combining Factory Input <RepoLink path="lib/input/mekanism/CombiningFactoryInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekcombine:"
+  :metrics="[
+    { name: 'input_main_count_sum',   value: '0 - inf',   unit: 'item' },
+    { name: 'input_secondary_count',  value: '0 - inf',   unit: 'item' },
+    { name: 'output_count_sum',       value: '0 - inf',   unit: 'item' },
+    { name: 'energy_usage',           value: '0.0 - inf', unit: 'FE/t' },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekcombine:"
+  :metrics="[
+    { name: 'auto_sort', value: '0 or 1' },
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+
+### Energy
+
+<MetricTable
+  prefix="mekcombine:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>
+
+### Recipe
+
+<MetricTable
+  prefix="mekcombine:"
+  :metrics="[
+    ...metrics.recipeProgress.recipeFactory
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/CompressingFactory.md b/docs/reference/input/mekanism/CompressingFactory.md
@@ -0,0 +1,68 @@
+---
+telem:
+  adapter:
+    id: 'compressingFactory'
+    name: 'Compressing Factory'
+    categories: '{ "basic", "advanced", "input", "energy", "recipe" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Compressing Factory Input <RepoLink path="lib/input/mekanism/CompressingFactoryInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekcompress:"
+  :metrics="[
+    { name: 'chemical_item_count',        value: '0 - inf',   unit: 'item'  },
+    { name: 'chemical_filled_percentage', value: '0.0 - 1.0'                },
+    { name: 'input_count_sum',            value: '0 - inf',   unit: 'item'  },
+    { name: 'output_count_sum',           value: '0 - inf',   unit: 'item'  },
+    { name: 'energy_usage',               value: '0.0 - inf', unit: 'FE/t'  },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekcompress:"
+  :metrics="[
+    { name: 'auto_sort', value: '0 or 1' },
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Input
+
+<MetricTable
+  prefix="mekcompress:"
+  :metrics="[
+    { name: 'chemical',           value: '0.0 - inf', unit: 'B' },
+    { name: 'chemical_capacity',  value: '0.0 - inf', unit: 'B' },
+    { name: 'chemical_needed',    value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekcompress:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>
+
+### Recipe
+
+<MetricTable
+  prefix="mekcompress:"
+  :metrics="[
+    ...metrics.recipeProgress.recipeFactory,
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/Crusher.md b/docs/reference/input/mekanism/Crusher.md
@@ -17,7 +17,7 @@ telem:
 ### Basic
 
 <MetricTable
-  prefix="mekcrusher:"
+  prefix="mekcrush:"
   :metrics="[
     { name: 'input_count',  value: '0 - inf',   unit: 'item' },
     { name: 'output_count', value: '0 - inf',   unit: 'item' },
@@ -29,7 +29,7 @@ telem:
 ### Advanced
 
 <MetricTable
-  prefix="mekcrusher:"
+  prefix="mekcrush:"
   :metrics="[
     ...metrics.genericMachine.advanced
   ]"
@@ -38,7 +38,7 @@ telem:
 ### Energy
 
 <MetricTable
-  prefix="mekcrusher:"
+  prefix="mekcrush:"
   :metrics="[
     ...metrics.genericMachine.energy
   ]"
@@ -47,7 +47,7 @@ telem:
 ### Recipe
 
 <MetricTable
-  prefix="mekcrusher:"
+  prefix="mekcrush:"
   :metrics="[
     ...metrics.recipeProgress.recipe
   ]"

diff --git a/docs/reference/input/mekanism/CrushingFactory.md b/docs/reference/input/mekanism/CrushingFactory.md
@@ -0,0 +1,55 @@
+---
+telem:
+  adapter:
+    id: 'crushingFactory'
+    name: 'Crushing Factory'
+    categories: '{ "basic", "advanced", "energy", "recipe" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Crushing Factory Input <RepoLink path="lib/input/mekanism/CrushingFactoryInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekcrush:"
+  :metrics="[
+    { name: 'input_count_sum',  value: '0 - inf',   unit: 'item' },
+    { name: 'output_count_sum', value: '0 - inf',   unit: 'item' },
+    { name: 'energy_usage',     value: '0.0 - inf', unit: 'FE/t' },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekcrush:"
+  :metrics="[
+    { name: 'auto_sort', value: '0 or 1' },
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekcrush:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>
+
+### Recipe
+
+<MetricTable
+  prefix="mekcrush:"
+  :metrics="[
+    ...metrics.recipeProgress.recipeFactory
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/common/metrics.data.ts b/docs/reference/input/mekanism/common/metrics.data.ts
@@ -42,7 +42,10 @@ export default {
           { name: 'ticks_required',   value: '0 - inf', unit: 't' }
         ],
         recipeFactory: [
-          { name: 'recipe_progress_N',  value: '0 - inf', unit: 't' },
+          {
+            name: 'recipe_progress_N',  value: '0 - inf', unit: 't',
+            badge: { type: 'tip', text: 'Indexed per process' }
+          },
           { name: 'ticks_required',     value: '0 - inf', unit: 't' }
         ]
       }