Skip to content

Commit

Permalink
📦 add docs for fluidic plenisher, fluid tank, formulaic assemblicator…
Browse files Browse the repository at this point in the history
…, and fuelwood heater
  • Loading branch information
cyberbit committed Sep 10, 2024
1 parent 72e9b20 commit 90a4408
Show file tree
Hide file tree
Showing 6 changed files with 203 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@ export default defineConfig({
// { text: 'Enriching Factory', link: '/reference/input/mekanism/EnrichingFactory' },
{ text: 'Enrichment Chamber', link: '/reference/input/mekanism/EnrichmentChamber' },
{ text: 'Fission Reactor', link: '/reference/input/mekanism/FissionReactor' },
// { text: 'Fluid Tank', link: '/reference/input/mekanism/FluidTank' },
// { text: 'Fluidic Plenisher', link: '/reference/input/mekanism/FluidicPlenisher' },
// { text: 'Formulaic Assemblicator', link: '/reference/input/mekanism/FormulaicAssemblicator' },
// { text: 'Fuelwood Heater', link: '/reference/input/mekanism/FuelwoodHeater' },
{ text: 'Fluid Tank', link: '/reference/input/mekanism/FluidTank' },
{ text: 'Fluidic Plenisher', link: '/reference/input/mekanism/FluidicPlenisher' },
{ 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' },
Expand Down
Binary file added docs/assets/mekanism-fluid-tank.webp
Binary file not shown.
51 changes: 51 additions & 0 deletions docs/reference/input/mekanism/FluidTank.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
telem:
adapter:
id: 'fluidTank'
name: 'Fluid Tank'
categories: '{ "basic", "storage" }'
---

<script setup>
import { data as metrics } from './common/metrics.data.ts'
</script>

# Mekanism Fluid Tank Input <RepoLink path="lib/input/mekanism/FluidTankInputAdapter.lua" />

<!--@include: ./common/preamble.md -->

### Basic

<MetricTable
prefix="mekfluidtank:"
:metrics="[
{ 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' }
]"
/>

### Storage

<MetricTable
prefix="mekfluidtank:"
:metrics="[
{ name: 'stored', value: '0.0 - inf', unit: 'B' },
{ name: 'capacity', value: '0.0 - inf', unit: 'B' },
{ name: 'needed', value: '0.0 - inf', unit: 'B' }
]"
/>

## Storage
If the tank contains a fluid, a storage metric is added for the fluid. Given a fluid tank with the following contents:

![Mekanism Advanced Fluid Tank with contents](/assets/mekanism-fluid-tank.webp)

The following metric would be added:

<MetricTable
prefix="storage:"
:metrics="[
{ name: 'mekanism:oxygen', value: '52', unit: 'B' }
]"
/>
56 changes: 56 additions & 0 deletions docs/reference/input/mekanism/FluidicPlenisher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
telem:
adapter:
id: 'fluidicPlenisher'
name: 'Fluidic Plenisher'
categories: '{ "basic", "advanced", "input", "energy" }'
---

<script setup>
import { data as metrics } from './common/metrics.data.ts'
</script>

# Mekanism Fluidic Plenisher Input <RepoLink path="lib/input/mekanism/FluidicPlenisherInputAdapter.lua" />

<!--@include: ./common/preamble.md -->

### Basic

<MetricTable
prefix="mekplenisher:"
: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="mekplenisher:"
:metrics="[
...metrics.genericMachine.advanced
]"
/>

### Input

<MetricTable
prefix="mekplenisher:"
: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' }
]"
/>

### Energy

<MetricTable
prefix="mekplenisher:"
:metrics="[
...metrics.genericMachine.energy
]"
/>
58 changes: 58 additions & 0 deletions docs/reference/input/mekanism/FormulaicAssemblicator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
telem:
adapter:
id: 'assemblicator'
name: 'Formulaic Assemblicator'
categories: '{ "basic", "advanced", "energy", "recipe" }'
---

<script setup>
import { data as metrics } from './common/metrics.data.ts'
</script>

# Mekanism Formulaic Assemblicator Input <RepoLink path="lib/input/mekanism/FormulaicAssemblicatorInputAdapter.lua" />

<!--@include: ./common/preamble.md -->

### Basic

<MetricTable
prefix="mekassemblicator:"
:metrics="[
{ name: 'input_slot_usage', value: '0 - inf' },
{ name: 'input_slot_count', value: '0 - inf' },
{ name: 'output_slot_usage', value: '0 - inf' },
{ name: 'output_slot_count', value: '0 - inf' },
...metrics.genericMachine.basic
]"
/>

### Advanced

<MetricTable
prefix="mekassemblicator:"
:metrics="[
{ name: 'valid_formula', value: '0 or 1' },
{ name: 'auto_mode', value: '0 or 1' },
{ name: 'stock_control', value: '0 or 1' },
...metrics.genericMachine.advanced
]"
/>

### Energy

<MetricTable
prefix="mekassemblicator:"
:metrics="[
...metrics.genericMachine.energy
]"
/>

### Recipe

<MetricTable
prefix="mekassemblicator:"
:metrics="[
...metrics.recipeProgress.recipe
]"
/>
34 changes: 34 additions & 0 deletions docs/reference/input/mekanism/FuelwoodHeater.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
telem:
adapter:
id: 'fuelwoodHeater'
name: 'Fuelwood Heater'
categories: '{ "basic", "advanced" }'
---

<script setup>
import { data as metrics } from './common/metrics.data.ts'
</script>

# Mekanism Fuelwood Heater Input <RepoLink path="lib/input/mekanism/FuelwoodHeaterInputAdapter.lua" />

<!--@include: ./common/preamble.md -->

### Basic

<MetricTable
prefix="mekfuelheater:"
:metrics="[
{ name: 'fuel_count', value: '0 - inf', unit: 'item' },
{ name: 'temperature', value: '0.0 - inf', unit: 'K' }
]"
/>

### Advanced

<MetricTable
prefix="mekfuelheater:"
:metrics="[
{ name: 'environmental_loss', value: '0.0 - inf' }
]"
/>

0 comments on commit 90a4408

Please sign in to comment.