Release/v0.9.0

docs/.vitepress/config.mts

@@ -54,14 +54,22 @@ export default defineConfig({
             text: 'Advanced Peripherals',
             collapsed: true,
             items: [
-              { text: 'Energy Detector', link: '/reference/input/advanced-peripherals/EnergyDetector' },
+              { text: 'Energy Detector',      link: '/reference/input/advanced-peripherals/EnergyDetector' },
+              { text: 'Environment Detector', link: '/reference/input/advanced-peripherals/EnvironmentDetector' },
+              { text: 'Geo Scanner',          link: '/reference/input/advanced-peripherals/GeoScanner' },
+              { text: 'Inventory Manager',    link: '/reference/input/advanced-peripherals/InventoryManager' },
+              { text: 'ME Bridge',            link: '/reference/input/advanced-peripherals/MEBridge' },
+              { text: 'Player Detector',      link: '/reference/input/advanced-peripherals/PlayerDetector' },
+              { text: 'Redstone Integrator',  link: '/reference/input/advanced-peripherals/RedstoneIntegrator' },
+              { text: 'RS Bridge',            link: '/reference/input/advanced-peripherals/RSBridge' },
             ]
           },
           {
-            text: 'Applied Energistics',
+            text: 'Bigger Reactors',
             collapsed: true,
             items: [
-              { text: 'ME Storage', link: '/reference/input/applied-energistics/MEStorage' },
+              { text: 'Reactor',  link: '/reference/input/bigger-reactors/Reactor' },
+              { text: 'Turbine',  link: '/reference/input/bigger-reactors/Turbine' },
             ]
           },
           {
@@ -140,10 +148,15 @@ export default defineConfig({
             ]
           },
           {
-            text: 'Refined Storage',
+            text: 'Powah',
             collapsed: true,
             items: [
-              { text: 'Refined Storage', link: '/reference/input/refined-storage/RefinedStorage' },
+              { text: 'Energy Cell',      link: '/reference/input/powah/EnergyCell' },
+              { text: 'Furnator',         link: '/reference/input/powah/Furnator' },
+              { text: 'Magmator',         link: '/reference/input/powah/Magmator' },
+              { text: 'Reactor',          link: '/reference/input/powah/Reactor' },
+              { text: 'Solar Panel',      link: '/reference/input/powah/SolarPanel' },
+              { text: 'Thermo Generator', link: '/reference/input/powah/ThermoGenerator' },
             ]
           },
         ]

docs/reference/input/advanced-peripherals/EnergyDetector.md

@@ -1,60 +1,21 @@
-# Advanced Peripherals Energy Detector <RepoLink path="lib/input/advancedPeripherals/EnergyDetectorInputAdapter.lua" />
-
-```lua
-telem.input.advancedPeripherals.energyDetector (
-  peripheralID: string,
-  categories?: string[] | '*'
-)
-```
-
-::: warning Mod Dependencies
-Requires **Advanced Peripherals**.
-:::
+---
+telem:
+  adapter:
+    id: 'energyDetector'
+    name: 'Energy Detector'
+    categories: '{ "basic" }'
+---
 
-This adapter produces metrics for the transfer rate and limit of an attached Energy Detector. By default, the metrics are limited to an opinionated basic list, but this can be expanded with the `categories` parameter at initialization.
-
-See the Usage section for a complete list of the metrics in each category.
-
-<PropertiesTable
-  :properties="[
-    {
-      name: 'peripheralID',
-      type: 'string',
-      default: 'nil',
-      description: 'Peripheral ID of the Energy Detector'
-    },
-    {
-      name: 'categories',
-      type: 'string[] | &quot;*&quot;',
-      default: '{ &quot;basic&quot; }'
-    }
-  ]"
->
-<template v-slot:categories>
-
-List of metric categories to query. The value `"*"` can be used to include all categories, which are listed below.
-
-```lua
-{ "basic" }
-```
-</template>
-</PropertiesTable>
-
-## Usage
-
-```lua{4}
-local telem = require 'telem'
+# Advanced Peripherals Energy Detector <RepoLink path="lib/input/advancedPeripherals/EnergyDetectorInputAdapter.lua" />
 
-local backplane = telem.backplane()
-  :addInput('my_energy', telem.input.advancedPeripherals.energyDetector('right'))
-  :cycleEvery(1)()
-```
+<!--@include: ./common/preamble.md -->
 
-Given an Energy Detector peripheral on the `right` side of the computer, this appends the following metrics to the backplane:
+### Basic
 
 <MetricTable
+  prefix="apenergy:"
   :metrics="[
-    { name: 'apenergy:transfer_rate',       value: '0 - inf', unit: 'FE/t' },
-    { name: 'apenergy:transfer_rate_limit', value: '0 - inf', unit: 'FE/t' },
+    { name: 'transfer_rate',        value: '0 - inf', unit: 'FE/t' },
+    { name: 'transfer_rate_limit',  value: '0 - inf', unit: 'FE/t' },
   ]"
 />

docs/reference/input/advanced-peripherals/EnvironmentDetector.md

@@ -0,0 +1,39 @@
+---
+telem:
+  adapter:
+    id: 'environmentDetector'
+    name: 'Environment Detector'
+    categories: '{ "basic" }'
+---
+
+# Advanced Peripherals Environment Detector Input <RepoLink path="lib/input/advancedPeripherals/EnvironmentDetectorInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+```lua
+MOON_PHASES = {
+  ['Full moon']     = 0,  ['Waning gibbous']  = 1,
+  ['Third quarter'] = 2,  ['Waning crescent'] = 3,
+  ['New moon']      = 4,  ['Waxing crescent'] = 5,
+  ['First quarter'] = 6,  ['Waxing gibbous']  = 7
+}
+```
+
+<MetricTable
+  prefix="apenv:"
+  :metrics="[
+    { name: 'block_light_level',  value: '0 - 15',                          },
+    { name: 'day_light_level',    value: '0 - 15',                          },
+    { name: 'sky_light_level',    value: '0 - 15',                          },
+    { name: 'moon_id',            value: 'MOON_PHASES value'                },
+    { name: 'time',               value: '0 - inf'                          },
+    { name: 'radiation',          value: '0.0 - inf',         unit: 'Sv/h'  },
+    { name: 'can_sleep',          value: '0 or 1'                           },
+    { name: 'raining',            value: '0 or 1'                           },
+    { name: 'sunny',              value: '0 or 1'                           },
+    { name: 'thundering',         value: '0 or 1'                           },
+    { name: 'slime_chunk',        value: '0 or 1'                           }
+  ]"
+/>

docs/reference/input/advanced-peripherals/GeoScanner.md

@@ -0,0 +1,51 @@
+# Advanced Peripherals Geo Scanner Input <RepoLink path="lib/input/advancedPeripherals/GeoScannerInputAdapter.lua" />
+
+```lua
+telem.input.advancedPeripherals.geoScanner (
+  peripheralID: string,
+  categories?: string[] | '*'
+)
+```
+
+::: warning Mod Dependencies
+Requires **Advanced Peripherals**.
+:::
+
+<PropertiesTable
+  :properties="[
+    {
+      name: 'peripheralID',
+      type: 'string',
+      default: 'nil',
+      description: 'Peripheral ID of the Geo Scanner'
+    },
+    {
+      name: 'categories',
+      type: 'string[] | &quot;*&quot;',
+      default: '{ &quot;basic&quot; }',
+      description: 'N/A'
+    }
+  ]"
+/>
+
+## Usage
+
+```lua{4}
+local telem = require 'telem'
+
+local backplane = telem.backplane()
+  :addInput('my_geoScanner', telem.input.advancedPeripherals.geoScanner('right', '*'))
+  :cycleEvery(5)()
+```
+
+## Storage
+If a Geo Scanner is in a chunk containing ore blocks, a storage metric is added for each ore block ID scanned.
+
+Given a chunk with 1 layer of dirt, 2 layers of stone, and 1 layer of iron ore, the following metrics would be added:
+
+<MetricTable
+  prefix="storage:"
+  :metrics="[
+    { name: 'minecraft:iron_ore', value: '256' }
+  ]"
+/>

docs/reference/input/advanced-peripherals/InventoryManager.md

@@ -0,0 +1,42 @@
+---
+telem:
+  adapter:
+    id: 'inventoryManager'
+    name: 'Inventory Manager'
+    categories: '{ "basic" }'
+---
+
+# Advanced Peripherals Inventory Manager Input <RepoLink path="lib/input/advancedPeripherals/InventoryManagerInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="apinv:"
+  :metrics="[
+    { name: 'equipped',                   value: '0 or 1'   },
+    { name: 'equipped_helmet',            value: '0 or 1'   },
+    { name: 'equipped_chestplate',        value: '0 or 1'   },
+    { name: 'equipped_leggings',          value: '0 or 1'   },
+    { name: 'equipped_boots',             value: '0 or 1'   },
+    { name: 'inventory_available',        value: '0 or 1'   },
+    { name: 'inventory_slots_available',  value: '0 - inf'  }
+  ]"
+/>
+
+## Storage
+
+Given an Inventory Manager peripheral containing a memory card tied to a player with the following inventory:
+
+![Player inventory](/assets/inventory.png)
+
+This appends the following metrics to the backplane:
+
+<MetricTable
+  prefix="storage:"
+  :metrics="[
+    { name: 'minecraft:redstone',       value: 45,  unit: 'item' },
+    { name: 'minecraft:spruce_planks',  value: 8,   unit: 'item' }
+  ]"
+/>

docs/reference/input/advanced-peripherals/MEBridge.md

@@ -0,0 +1,65 @@
+---
+telem:
+  adapter:
+    id: 'meBridge'
+    name: 'ME Bridge'
+    categories: '{ "basic", "energy", "storage" }'
+    requiresMod: 'Applied Energistics 2'
+---
+
+# Advanced Peripherals ME Bridge Input <RepoLink path="lib/input/advancedPeripherals/MEBridgeInputAdapter.lua" />
+
+<!--@include: ./common/preamble.md -->
+
+### Basic
+
+<MetricTable
+  prefix="apmebridge:"
+  :metrics="[
+    { name: 'energy_usage',       value: '0.0 - inf', unit: 'FE/t'  },
+    { name: 'item_storage_used',  value: '0 - inf',   unit: 'bytes' },
+    { name: 'fluid_storage_used', value: '0 - inf',   unit: 'bytes' },
+    { name: 'cell_count',         value: '0 - inf'                  }
+  ]"
+/>
+
+### Energy
+
+<MetricTable
+  prefix="apmebridge:"
+  :metrics="[
+    { name: 'energy',     value: '0.0 - inf', unit: 'FE'  },
+    { name: 'max_energy', value: '0.0 - inf', unit: 'FE'  }
+  ]"
+/>
+
+### Storage
+
+<MetricTable
+  prefix="apmebridge:"
+  :metrics="[
+    { name: 'item_storage_capacity',    value: '0 - inf', unit: 'bytes' },
+    { name: 'item_storage_available',   value: '0 - inf', unit: 'bytes' },
+    { name: 'fluid_storage_capacity',   value: '0 - inf', unit: 'bytes' },
+    { name: 'fluid_storage_available',  value: '0 - inf', unit: 'bytes' }
+  ]"
+/>
+
+## Storage
+
+Given an ME Bridge peripheral attached to an ME storage network with the following stored items and fluids:
+
+![Applied Energistics ME Terminal inventory](/assets/me-inventory.webp)
+
+This appends the following metrics to the backplane:
+
+<MetricTable
+  prefix="storage:"
+  :metrics="[
+    { name: 'minecraft:lava',       value: 29.25, unit: 'B'     },
+    { name: 'minecraft:oak_planks', value: 3,     unit: 'item'  },
+    { name: 'minecraft:redstone',   value: 1408,  unit: 'item'  }
+  ]"
+/>
+
+If Applied Mekanistics is installed, any stored chemicals and gases will also be included as metrics.