📦 add docs for oredict, osmium compressor, painting machine, pigment …

…extractor, pigment mixer
cyberbit · Dec 27, 2024 · 3bff69d · 3bff69d
1 parent 065dbdc
commit 3bff69d
Show file tree

Hide file tree

Showing 6 changed files with 304 additions and 5 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -107,11 +107,11 @@ export default defineConfig({
               { text: 'Mechanical Pipe', link: '/reference/input/mekanism/MechanicalPipe' },
               { text: 'Metallurgic Infuser', link: '/reference/input/mekanism/MetallurgicInfuser' },
               { text: 'Nutritional Liquifier', link: '/reference/input/mekanism/NutritionalLiquifier' },
-              // { text: 'Oredictionificator', link: '/reference/input/mekanism/Oredictionificator' },
-              // { text: 'Osmium Compressor', link: '/reference/input/mekanism/OsmiumCompressor' },
-              // { text: 'Painting Machine', link: '/reference/input/mekanism/PaintingMachine' },
-              // { text: 'Pigment Extractor', link: '/reference/input/mekanism/PigmentExtractor' },
-              // { text: 'Pigment Mixer', link: '/reference/input/mekanism/PigmentMixer' },
+              { text: 'Oredictionificator', link: '/reference/input/mekanism/Oredictionificator' },
+              { text: 'Osmium Compressor', link: '/reference/input/mekanism/OsmiumCompressor' },
+              { text: 'Painting Machine', link: '/reference/input/mekanism/PaintingMachine' },
+              { text: 'Pigment Extractor', link: '/reference/input/mekanism/PigmentExtractor' },
+              { text: 'Pigment Mixer', link: '/reference/input/mekanism/PigmentMixer' },
               // { text: 'Precision Sawmill', link: '/reference/input/mekanism/PrecisionSawmill' },
               // { text: 'Pressurized Reaction Chamber', link: '/reference/input/mekanism/PressurizedReactionChamber' },
               // { text: 'Pressurized Tube', link: '/reference/input/mekanism/PressurizedTube' },

diff --git a/docs/reference/input/mekanism/Oredictionificator.md b/docs/reference/input/mekanism/Oredictionificator.md
@@ -0,0 +1,25 @@
+---
+telem:
+  adapter:
+    id: 'oredictionificator'
+    name: 'Oredictionificator'
+    categories: '{ "basic" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Oredictionificator Input <RepoLink path="lib/input/mekanism/OredictionificatorInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekoredict:"
+  :metrics="[
+    { name: 'input_count',  value: '0 - inf', unit: 'item'  },
+    { name: 'output_count', value: '0 - inf', unit: 'item'  }
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/OsmiumCompressor.md b/docs/reference/input/mekanism/OsmiumCompressor.md
@@ -0,0 +1,67 @@
+---
+telem:
+  adapter:
+    id: 'osmiumCompressor'
+    name: 'Osmium Compressor'
+    categories: '{ "basic", "advanced", "input", "energy", "recipe" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Osmium Compressor Input <RepoLink path="lib/input/mekanism/OsmiumCompressorInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekcompress:"
+  :metrics="[
+    { name: 'chemical_filled_percentage', value: '0.0 - 1.0'                },
+    { name: 'input_count',                value: '0 - inf',   unit: 'item'  },
+    { name: 'chemical_item_count',        value: '0 - inf',   unit: 'item'  },
+    { name: 'output_count',               value: '0 - inf',   unit: 'item'  },
+    { name: 'energy_usage',               value: '0.0 - inf', unit: 'FE/t'  },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekcompress:"
+  :metrics="[
+    ...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.recipe,
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/PaintingMachine.md b/docs/reference/input/mekanism/PaintingMachine.md
@@ -0,0 +1,67 @@
+---
+telem:
+  adapter:
+    id: 'paintingMachine'
+    name: 'Painting Machine'
+    categories: '{ "basic", "advanced", "input", "energy", "recipe" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Painting Machine Input <RepoLink path="lib/input/mekanism/PaintingMachineInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekpainting:"
+  :metrics="[
+    { name: 'input_pigment_item_count',         value: '0 - inf',   unit: 'item'  },
+    { name: 'input_pigment_filled_percentage',  value: '0.0 - 1.0'                },
+    { name: 'input_item_count',                 value: '0 - inf',   unit: 'item'  },
+    { name: 'output_count',                     value: '0 - inf',   unit: 'item'  },
+    { name: 'energy_usage',                     value: '0.0 - inf', unit: 'FE/t'  },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekpainting:"
+  :metrics="[
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Input
+
+<MetricTable
+  prefix="mekpainting:"
+  :metrics="[
+    { name: 'input_pigment',          value: '0.0 - inf', unit: 'B' },
+    { name: 'input_pigment_capacity', value: '0.0 - inf', unit: 'B' },
+    { name: 'input_pigment_needed',   value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekpainting:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>
+
+### Recipe
+
+<MetricTable
+  prefix="mekpainting:"
+  :metrics="[
+    ...metrics.recipeProgress.recipe,
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/PigmentExtractor.md b/docs/reference/input/mekanism/PigmentExtractor.md
@@ -0,0 +1,66 @@
+---
+telem:
+  adapter:
+    id: 'pigmentExtractor'
+    name: 'Pigment Extractor'
+    categories: '{ "basic", "advanced", "output", "energy", "recipe" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Pigment Extractor Input <RepoLink path="lib/input/mekanism/PigmentExtractorInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekpigmentextractor:"
+  :metrics="[
+    { name: 'input_count',              value: '0 - inf',   unit: 'item'  },
+    { name: 'output_item_count',        value: '0 - inf',   unit: 'item'  },
+    { name: 'output_filled_percentage', value: '0.0 - 1.0'                },
+    { name: 'energy_usage',             value: '0.0 - inf', unit: 'FE/t'  },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekpigmentextractor:"
+  :metrics="[
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Output
+
+<MetricTable
+  prefix="mekpigmentextractor:"
+  :metrics="[
+    { name: 'output',           value: '0.0 - inf', unit: 'B' },
+    { name: 'output_capacity',  value: '0.0 - inf', unit: 'B' },
+    { name: 'output_needed',    value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekpigmentextractor:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>
+
+### Recipe
+
+<MetricTable
+  prefix="mekpigmentextractor:"
+  :metrics="[
+    ...metrics.recipeProgress.recipe,
+  ]"
+/>
diff --git a/docs/reference/input/mekanism/PigmentMixer.md b/docs/reference/input/mekanism/PigmentMixer.md
@@ -0,0 +1,74 @@
+---
+telem:
+  adapter:
+    id: 'pigmentMixer'
+    name: 'Pigment Mixer'
+    categories: '{ "basic", "advanced", "input", "output", "energy" }'
+---
+
+<script setup>
+  import { data as metrics } from './common/metrics.data.ts'
+</script>
+
+# Mekanism Pigment Mixer Input <RepoLink path="lib/input/mekanism/PigmentMixerInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="mekpigmentmixer:"
+  :metrics="[
+    { name: 'input_left_item_count',          value: '0 - inf',   unit: 'item'  },
+    { name: 'input_right_item_count',         value: '0 - inf',   unit: 'item'  },
+    { name: 'input_left_filled_percentage',   value: '0.0 - 1.0'                },
+    { name: 'input_right_filled_percentage',  value: '0.0 - 1.0'                },
+    { name: 'output_item_count',              value: '0 - inf',   unit: 'item'  },
+    { name: 'output_filled_percentage',       value: '0.0 - 1.0'                },
+    { name: 'energy_usage',                   value: '0.0 - inf', unit: 'FE/t'  },
+    ...metrics.genericMachine.basic
+  ]"
+/>
+
+### Advanced
+
+<MetricTable
+  prefix="mekpigmentmixer:"
+  :metrics="[
+    ...metrics.genericMachine.advanced
+  ]"
+/>
+
+### Input
+
+<MetricTable
+  prefix="mekpigmentmixer:"
+  :metrics="[
+    { name: 'input_left',           value: '0.0 - inf', unit: 'B' },
+    { name: 'input_left_capacity',  value: '0.0 - inf', unit: 'B' },
+    { name: 'input_left_needed',    value: '0.0 - inf', unit: 'B' },
+    { name: 'input_right',          value: '0.0 - inf', unit: 'B' },
+    { name: 'input_right_capacity', value: '0.0 - inf', unit: 'B' },
+    { name: 'input_right_needed',   value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Output
+
+<MetricTable
+  prefix="mekpigmentmixer:"
+  :metrics="[
+    { name: 'output',           value: '0.0 - inf', unit: 'B' },
+    { name: 'output_capacity',  value: '0.0 - inf', unit: 'B' },
+    { name: 'output_needed',    value: '0.0 - inf', unit: 'B' }
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="mekpigmentmixer:"
+  :metrics="[
+    ...metrics.genericMachine.energy
+  ]"
+/>