From c67ac4949d6488cf336f98c808c6887c3f0271bc Mon Sep 17 00:00:00 2001 From: cyberbit Date: Fri, 21 Feb 2025 20:46:24 +0000 Subject: [PATCH 01/15] =?UTF-8?q?=F0=9F=93=A6=20refactor=20AP=20docs=20for?= =?UTF-8?q?=20ME=20bridge=20and=20energy=20detector,=20deprecate=20ME=20st?= =?UTF-8?q?orage=20doc=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 43 +++++++----- .../advanced-peripherals/EnergyDetector.md | 65 ++++--------------- .../input/advanced-peripherals/MEBridge.md | 65 +++++++++++++++++++ .../advanced-peripherals/common/preamble.md | 58 +++++++++++++++++ .../input/applied-energistics/MEStorage.md | 54 ++------------- .../MEBridgeInputAdapter.lua | 2 + 6 files changed, 170 insertions(+), 117 deletions(-) create mode 100644 docs/reference/input/advanced-peripherals/MEBridge.md create mode 100644 docs/reference/input/advanced-peripherals/common/preamble.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 82abf04..f1edb65 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -54,16 +54,24 @@ export default defineConfig({ text: 'Advanced Peripherals', collapsed: true, items: [ - { text: 'Energy Detector', link: '/reference/input/advanced-peripherals/EnergyDetector' }, - ] - }, - { - text: 'Applied Energistics', - collapsed: true, - items: [ - { text: 'ME Storage', link: '/reference/input/applied-energistics/MEStorage' }, + { 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: 'Bigger Reactors ✨', + // collapsed: true, + // items: [ + // { text: 'Reactor', link: '/reference/input/bigger-reactors/EnergyDetector' }, + // { text: 'Turbine', link: '/reference/input/bigger-reactors/EnvironmentDetector' }, + // ] + // }, { text: 'Mekanism', collapsed: true, @@ -139,13 +147,18 @@ export default defineConfig({ { text: 'Wind Generator', link: '/reference/input/mekanism/WindGenerator' }, ] }, - { - text: 'Refined Storage', - collapsed: true, - items: [ - { text: 'Refined Storage', link: '/reference/input/refined-storage/RefinedStorage' }, - ] - }, + // { + // text: 'Powah ✨', + // collapsed: true, + // items: [ + // { 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' }, + // ] + // }, ] }, { diff --git a/docs/reference/input/advanced-peripherals/EnergyDetector.md b/docs/reference/input/advanced-peripherals/EnergyDetector.md index 66efd23..033da9f 100644 --- a/docs/reference/input/advanced-peripherals/EnergyDetector.md +++ b/docs/reference/input/advanced-peripherals/EnergyDetector.md @@ -1,60 +1,21 @@ -# Advanced Peripherals Energy Detector - -```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. - - - - - -## Usage - -```lua{4} -local telem = require 'telem' +# Advanced Peripherals Energy Detector -local backplane = telem.backplane() - :addInput('my_energy', telem.input.advancedPeripherals.energyDetector('right')) - :cycleEvery(1)() -``` + -Given an Energy Detector peripheral on the `right` side of the computer, this appends the following metrics to the backplane: +### Basic \ No newline at end of file diff --git a/docs/reference/input/advanced-peripherals/MEBridge.md b/docs/reference/input/advanced-peripherals/MEBridge.md new file mode 100644 index 0000000..0995fce --- /dev/null +++ b/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 + + + +### Basic + + + +### Energy + + + +### Storage + + + +## 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: + + + +If Applied Mekanistics is installed, any stored chemicals and gases will also be included as metrics. \ No newline at end of file diff --git a/docs/reference/input/advanced-peripherals/common/preamble.md b/docs/reference/input/advanced-peripherals/common/preamble.md new file mode 100644 index 0000000..c28cba0 --- /dev/null +++ b/docs/reference/input/advanced-peripherals/common/preamble.md @@ -0,0 +1,58 @@ +```lua-vue +telem.input.advancedPeripherals.{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }} ( + peripheralID: string, + categories?: string[] | '*' +) +``` + +::: warning Mod Dependencies + + +::: + +See the Usage section for a complete list of the metrics in each category. + + + + + +## Usage + +```lua-vue{4} +local telem = require 'telem' + +local backplane = telem.backplane() + :addInput('my_{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }}', telem.input.advancedPeripherals.{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }}('right', '*')) + :cycleEvery(5)() +``` + +Given a {{ $frontmatter?.telem?.adapter?.name || 'ADAPTER.NAME' }} peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity): \ No newline at end of file diff --git a/docs/reference/input/applied-energistics/MEStorage.md b/docs/reference/input/applied-energistics/MEStorage.md index 64c03bb..86a1c62 100644 --- a/docs/reference/input/applied-energistics/MEStorage.md +++ b/docs/reference/input/applied-energistics/MEStorage.md @@ -2,58 +2,12 @@ outline: deep --- -# Applied Energistics ME Storage Input +# Applied Energistics ME Storage Input ```lua telem.input.meStorage (peripheralID: string) ``` -::: warning Mod Dependencies -Requires **Applied Energistics 2** and **Advanced Peripherals**. -::: - -This adapter produces a metric for each item and fluid ID in an ME storage network, with the metric names being the IDs, and the value being the total amount of that item/fluid in storage. Peripheral must be an [Advanced Peripherals ME Bridge](https://docs.advanced-peripherals.de/peripherals/me_bridge/). - -Items that are craftable but not stored are not included in the metrics. - -## Usage - -```lua{4} -local telem = require 'telem' - -local backplane = telem.backplane() - :addInput('my_me', telem.input.meStorage('meBridge_0')) - :cycleEvery(1)() -``` - -Given an ME Bridge peripheral with the ID `meBridge_0` attached to an ME storage network with the following items and fluids: - -![Applied Energistics ME Terminal inventory](/assets/me-inventory.webp) - -This appends the following metrics to the backplane: - - \ No newline at end of file +::: danger Deprecated +This adapter is deprecated and will be removed in a future release. Use the [ME Bridge](/reference/input/advanced-peripherals/MEBridge) adapter instead. +::: \ No newline at end of file diff --git a/src/telem/lib/input/advancedPeripherals/MEBridgeInputAdapter.lua b/src/telem/lib/input/advancedPeripherals/MEBridgeInputAdapter.lua index be53137..6306535 100644 --- a/src/telem/lib/input/advancedPeripherals/MEBridgeInputAdapter.lua +++ b/src/telem/lib/input/advancedPeripherals/MEBridgeInputAdapter.lua @@ -27,6 +27,8 @@ function MEBridgeInputAdapter:beforeRegister (peripheralName, categories) }, } + -- TODO gas storage metrics? + -- getCraftingCPUs -- listCraftableItems -- listCraftableFluid From 4993843f6e672e1413c641bb28f2a06735f125da Mon Sep 17 00:00:00 2001 From: cyberbit Date: Fri, 21 Feb 2025 23:35:48 +0000 Subject: [PATCH 02/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20RS=20br?= =?UTF-8?q?idge,=20deprecate=20RS=20storage=20doc=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 2 +- .../input/advanced-peripherals/RSBridge.md | 60 +++++++++++++++++++ .../input/refined-storage/RefinedStorage.md | 54 ++--------------- 3 files changed, 65 insertions(+), 51 deletions(-) create mode 100644 docs/reference/input/advanced-peripherals/RSBridge.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index f1edb65..2474a2b 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -61,7 +61,7 @@ export default defineConfig({ { 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: 'RS Bridge ✨', link: '/reference/input/advanced-peripherals/RSBridge' }, ] }, // { diff --git a/docs/reference/input/advanced-peripherals/RSBridge.md b/docs/reference/input/advanced-peripherals/RSBridge.md new file mode 100644 index 0000000..36e70ad --- /dev/null +++ b/docs/reference/input/advanced-peripherals/RSBridge.md @@ -0,0 +1,60 @@ +--- +telem: + adapter: + id: 'rsBridge' + name: 'RS Bridge' + categories: '{ "basic", "energy", "storage" }' + requiresMod: 'Refined Storage' +--- + +# Advanced Peripherals RS Bridge Input + + + +### Basic + + + +### Energy + + + +### Storage + + + +## Storage + +Given an RS Bridge peripheral attached to a Refined Storage network with the following stored items and fluids: + +![Refined Storage Fluid Grid and Grid inventory](/assets/rs-inventory.webp) + +This appends the following metrics to the backplane: + + \ No newline at end of file diff --git a/docs/reference/input/refined-storage/RefinedStorage.md b/docs/reference/input/refined-storage/RefinedStorage.md index 1b48f84..fa5609d 100644 --- a/docs/reference/input/refined-storage/RefinedStorage.md +++ b/docs/reference/input/refined-storage/RefinedStorage.md @@ -2,58 +2,12 @@ outline: deep --- -# Refined Storage Input +# Refined Storage Input ```lua telem.input.refinedStorage (peripheralID: string) ``` -::: warning Mod Dependencies -Requires **Refined Storage** and **Advanced Peripherals**. -::: - -This adapter produces a metric for each item and fluid ID in a Refined Storage network, with the metric names being the IDs, and the value being the total amount of that item/fluid in storage. Peripheral must be an [Advanced Peripherals RS Bridge](https://docs.advanced-peripherals.de/peripherals/rs_bridge/). - -Items that are craftable but not stored are not included in the metrics. - -## Usage - -```lua -local telem = require 'telem' - -local backplane = telem.backplane() - :addInput('my_refined', telem.input.refinedStorage('rsBridge_0')) - :cycleEvery(1)() -``` - -Given an RS Bridge peripheral with the ID `rsBridge_0` attached to a Refined Storage network with the following items and fluids: - -![Refined Storage Fluid Grid and Grid inventory](/assets/rs-inventory.webp) - -This appends the following metrics to the backplane: - - \ No newline at end of file +::: danger Deprecated +This adapter is deprecated and will be removed in a future release. Use the [RS Bridge](/reference/input/advanced-peripherals/RSBridge) adapter instead. +::: \ No newline at end of file From f73e86cc892de6723d773fe3fd76b70e87be978b Mon Sep 17 00:00:00 2001 From: cyberbit Date: Sat, 22 Feb 2025 01:06:12 +0000 Subject: [PATCH 03/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20environ?= =?UTF-8?q?ment=20detector?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 4 +- .../EnvironmentDetector.md | 39 +++++++++++++++++++ .../EnvironmentDetectorInputAdapter.lua | 22 +++++------ 3 files changed, 52 insertions(+), 13 deletions(-) create mode 100644 docs/reference/input/advanced-peripherals/EnvironmentDetector.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 2474a2b..40ae177 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -54,8 +54,8 @@ export default defineConfig({ text: 'Advanced Peripherals', collapsed: true, items: [ - { text: 'Energy Detector', link: '/reference/input/advanced-peripherals/EnergyDetector' }, - // { text: 'Environment Detector ✨', link: '/reference/input/advanced-peripherals/EnvironmentDetector' }, + { 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' }, diff --git a/docs/reference/input/advanced-peripherals/EnvironmentDetector.md b/docs/reference/input/advanced-peripherals/EnvironmentDetector.md new file mode 100644 index 0000000..8f4bd8a --- /dev/null +++ b/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 + + + +### 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 +} +``` + + \ No newline at end of file diff --git a/src/telem/lib/input/advancedPeripherals/EnvironmentDetectorInputAdapter.lua b/src/telem/lib/input/advancedPeripherals/EnvironmentDetectorInputAdapter.lua index 84410a8..b917ca4 100644 --- a/src/telem/lib/input/advancedPeripherals/EnvironmentDetectorInputAdapter.lua +++ b/src/telem/lib/input/advancedPeripherals/EnvironmentDetectorInputAdapter.lua @@ -9,17 +9,17 @@ function EnvironmentDetectorInputAdapter:beforeRegister (peripheralName, categor self.queries = { basic = { - block_light_level = fn():call('getBlockLightLevel'), - day_light_level = fn():call('getDayLightLevel'), - sky_light_level = fn():call('getSkyLightLevel'), - moon_id = fn():call('getMoonId'), - time = fn():call('getTime'), - radiation = fn():call('getRadiationRaw'):with('unit', 'Sv/h'), - can_sleep = fn():call('canSleepHere'):toFlag(), - raining = fn():call('isRaining'):toFlag(), - sunny = fn():call('isSunny'):toFlag(), - thundering = fn():call('isThunder'):toFlag(), - slime_chunk = fn():call('isSlimeChunk'):toFlag(), + block_light_level = fn():call('getBlockLightLevel'), + day_light_level = fn():call('getDayLightLevel'), + sky_light_level = fn():call('getSkyLightLevel'), + moon_id = fn():call('getMoonId'), + time = fn():call('getTime'), + radiation = fn():call('getRadiationRaw'):with('unit', 'Sv/h'), + can_sleep = fn():call('canSleepHere'):toFlag(), + raining = fn():call('isRaining'):toFlag(), + sunny = fn():call('isSunny'):toFlag(), + thundering = fn():call('isThunder'):toFlag(), + slime_chunk = fn():call('isSlimeChunk'):toFlag(), }, } From 782dc90cdeede5bac6e5b8ba4c061eb5c2f6bf2f Mon Sep 17 00:00:00 2001 From: cyberbit Date: Sat, 22 Feb 2025 20:34:56 +0000 Subject: [PATCH 04/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20geo=20s?= =?UTF-8?q?canner?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 2 +- .../input/advanced-peripherals/GeoScanner.md | 51 +++++++++++++++++++ .../GeoScannerInputAdapter.lua | 1 + 3 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 docs/reference/input/advanced-peripherals/GeoScanner.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 40ae177..83eadea 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -56,7 +56,7 @@ export default defineConfig({ items: [ { 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: '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' }, diff --git a/docs/reference/input/advanced-peripherals/GeoScanner.md b/docs/reference/input/advanced-peripherals/GeoScanner.md new file mode 100644 index 0000000..a1225b1 --- /dev/null +++ b/docs/reference/input/advanced-peripherals/GeoScanner.md @@ -0,0 +1,51 @@ +# Advanced Peripherals Geo Scanner Input + +```lua +telem.input.advancedPeripherals.geoScanner ( + peripheralID: string, + categories?: string[] | '*' +) +``` + +::: warning Mod Dependencies +Requires **Advanced Peripherals**. +::: + + + +## 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: + + \ No newline at end of file diff --git a/src/telem/lib/input/advancedPeripherals/GeoScannerInputAdapter.lua b/src/telem/lib/input/advancedPeripherals/GeoScannerInputAdapter.lua index 4cf6ee1..bb542a8 100644 --- a/src/telem/lib/input/advancedPeripherals/GeoScannerInputAdapter.lua +++ b/src/telem/lib/input/advancedPeripherals/GeoScannerInputAdapter.lua @@ -12,6 +12,7 @@ function GeoScannerInputAdapter:beforeRegister (peripheralName, categories) basic = {}, } + -- TODO no unit? intentional?? meh??? self.storageQueries = { fn():callElse('chunkAnalyze', {}) :map(function (k, v) return Metric{ name = k, value = v } end) From d359592e5a534414dc6f4fdd423e5f303e315bc8 Mon Sep 17 00:00:00 2001 From: cyberbit Date: Sat, 22 Feb 2025 20:58:58 +0000 Subject: [PATCH 05/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20invento?= =?UTF-8?q?ry=20manager?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 2 +- .../advanced-peripherals/InventoryManager.md | 42 +++++++++++++++++++ 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 docs/reference/input/advanced-peripherals/InventoryManager.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 83eadea..5ada208 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -57,7 +57,7 @@ export default defineConfig({ { 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: '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' }, diff --git a/docs/reference/input/advanced-peripherals/InventoryManager.md b/docs/reference/input/advanced-peripherals/InventoryManager.md new file mode 100644 index 0000000..3f91744 --- /dev/null +++ b/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 + + + +### Basic + + + +## 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: + + \ No newline at end of file From 982ce8d269786930e00f1603cf347a9e38dd3474 Mon Sep 17 00:00:00 2001 From: cyberbit Date: Mon, 24 Feb 2025 18:32:10 +0000 Subject: [PATCH 06/15] =?UTF-8?q?=F0=9F=93=A6=20initial=20work=20for=20pla?= =?UTF-8?q?yer=20detector=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../advanced-peripherals/PlayerDetector.md | 73 +++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 docs/reference/input/advanced-peripherals/PlayerDetector.md diff --git a/docs/reference/input/advanced-peripherals/PlayerDetector.md b/docs/reference/input/advanced-peripherals/PlayerDetector.md new file mode 100644 index 0000000..dba4dab --- /dev/null +++ b/docs/reference/input/advanced-peripherals/PlayerDetector.md @@ -0,0 +1,73 @@ +# Advanced Peripherals Player Detector Input + +```lua +telem.input.advancedPeripherals.playerDetector ( + peripheralID: string, + categories?: string[] | '*', + playerName?: string +) +``` + +::: warning Mod Dependencies +Requires **Advanced Peripherals**. +::: + +See the Usage section for a complete list of the metrics in each category. + + + + + +## Usage + +```lua{4} +local telem = require 'telem' + +local backplane = telem.backplane() + :addInput('my_playerDetector', telem.input.advancedPeripherals.playerDetector('right', '*')) + :cycleEvery(5)() +``` + +Given a Player Detector peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity): + + + +### Basic + + + +### Player + +If `playerName` is provided, the following metrics are appended to the backplane: From 2c150073fbafcf7789a187d95de98e728f2fde65 Mon Sep 17 00:00:00 2001 From: cyberbit Date: Tue, 25 Feb 2025 04:31:21 +0000 Subject: [PATCH 07/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20player?= =?UTF-8?q?=20detector?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 2 +- .../advanced-peripherals/PlayerDetector.md | 26 ++++++++++++++----- 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 5ada208..e7bd148 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -59,7 +59,7 @@ export default defineConfig({ { 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: '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' }, ] diff --git a/docs/reference/input/advanced-peripherals/PlayerDetector.md b/docs/reference/input/advanced-peripherals/PlayerDetector.md index dba4dab..3013c59 100644 --- a/docs/reference/input/advanced-peripherals/PlayerDetector.md +++ b/docs/reference/input/advanced-peripherals/PlayerDetector.md @@ -47,22 +47,24 @@ List of metric categories to query. The value `"*"` can be used to include all c ## Usage -```lua{4} +```lua{4-8} local telem = require 'telem' local backplane = telem.backplane() - :addInput('my_playerDetector', telem.input.advancedPeripherals.playerDetector('right', '*')) + :addInput( + 'my_playerDetector', + telem.input.advancedPeripherals.playerDetector('right', '*'), + 'PlayerName' + ) :cycleEvery(5)() ``` Given a Player Detector peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity): - - ### Basic From 71d3d24db6ce87a60e3ca3a5144e6f01899e5a54 Mon Sep 17 00:00:00 2001 From: cyberbit Date: Sat, 1 Mar 2025 22:59:43 +0000 Subject: [PATCH 08/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20redston?= =?UTF-8?q?e=20integrator,=20fix=20example=20for=20player=20detector?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 2 +- .../advanced-peripherals/PlayerDetector.md | 5 +- .../RedstoneIntegrator.md | 80 +++++++++++++++++++ 3 files changed, 83 insertions(+), 4 deletions(-) create mode 100644 docs/reference/input/advanced-peripherals/RedstoneIntegrator.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index e7bd148..da3d2eb 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -60,7 +60,7 @@ export default defineConfig({ { 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: 'Redstone Integrator ✨', link: '/reference/input/advanced-peripherals/RedstoneIntegrator' }, { text: 'RS Bridge ✨', link: '/reference/input/advanced-peripherals/RSBridge' }, ] }, diff --git a/docs/reference/input/advanced-peripherals/PlayerDetector.md b/docs/reference/input/advanced-peripherals/PlayerDetector.md index 3013c59..922e48e 100644 --- a/docs/reference/input/advanced-peripherals/PlayerDetector.md +++ b/docs/reference/input/advanced-peripherals/PlayerDetector.md @@ -47,14 +47,13 @@ List of metric categories to query. The value `"*"` can be used to include all c ## Usage -```lua{4-8} +```lua{4-7} local telem = require 'telem' local backplane = telem.backplane() :addInput( 'my_playerDetector', - telem.input.advancedPeripherals.playerDetector('right', '*'), - 'PlayerName' + telem.input.advancedPeripherals.playerDetector('right', '*', 'PlayerName') ) :cycleEvery(5)() ``` diff --git a/docs/reference/input/advanced-peripherals/RedstoneIntegrator.md b/docs/reference/input/advanced-peripherals/RedstoneIntegrator.md new file mode 100644 index 0000000..c235f7d --- /dev/null +++ b/docs/reference/input/advanced-peripherals/RedstoneIntegrator.md @@ -0,0 +1,80 @@ +# Advanced Peripherals Redstone Integrator Input + +```lua +telem.input.advancedPeripherals.redstoneIntegrator ( + peripheralID: string, + categories?: string[] | '*', + sides?: string[] | '*' +) +``` + +::: warning Mod Dependencies +Requires **Advanced Peripherals**. +::: + +See the Usage section for a complete list of the metrics in each category. + + + + + + +## Usage + +```lua{4-7} +local telem = require 'telem' + +local backplane = telem.backplane() + :addInput( + 'my_redstoneIntegrator', + telem.input.advancedPeripherals.redstoneIntegrator('right', '*', '*') + ) + :cycleEvery(5)() +``` + +Given a Redstone Integrator peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity): + +### Basic + + From a45514deeef9bfc4973afc2ec090b477e1e5de05 Mon Sep 17 00:00:00 2001 From: cyberbit Date: Sun, 2 Mar 2025 23:47:23 +0000 Subject: [PATCH 09/15] =?UTF-8?q?=F0=9F=93=A6=20add=20Powah=20adapter=20se?= =?UTF-8?q?ction,=20add=20docs=20for=20Energy=20Cell?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 24 ++++----- docs/reference/input/powah/EnergyCell.md | 24 +++++++++ .../input/powah/common/metrics.data.ts | 12 +++++ docs/reference/input/powah/common/preamble.md | 49 +++++++++++++++++++ 4 files changed, 97 insertions(+), 12 deletions(-) create mode 100644 docs/reference/input/powah/EnergyCell.md create mode 100644 docs/reference/input/powah/common/metrics.data.ts create mode 100644 docs/reference/input/powah/common/preamble.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index da3d2eb..b85007d 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -147,18 +147,18 @@ export default defineConfig({ { text: 'Wind Generator', link: '/reference/input/mekanism/WindGenerator' }, ] }, - // { - // text: 'Powah ✨', - // collapsed: true, - // items: [ - // { 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' }, - // ] - // }, + { + text: 'Powah ✨', + collapsed: true, + items: [ + { 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' }, + ] + }, ] }, { diff --git a/docs/reference/input/powah/EnergyCell.md b/docs/reference/input/powah/EnergyCell.md new file mode 100644 index 0000000..3ad3a7b --- /dev/null +++ b/docs/reference/input/powah/EnergyCell.md @@ -0,0 +1,24 @@ +--- +telem: + adapter: + id: 'energyCell' + name: 'Energy Cell' + categories: '{ "basic" }' +--- + + + +# Powah Energy Cell Input + + + +### Basic + + \ No newline at end of file diff --git a/docs/reference/input/powah/common/metrics.data.ts b/docs/reference/input/powah/common/metrics.data.ts new file mode 100644 index 0000000..9e685d3 --- /dev/null +++ b/docs/reference/input/powah/common/metrics.data.ts @@ -0,0 +1,12 @@ +export default { + load() { + return { + energy: { + basic: [ + { name: 'energy', value: '0.0 - inf', unit: 'FE' }, + { name: 'max_energy', value: '0.0 - inf', unit: 'FE' } + ] + }, + } + } +} \ No newline at end of file diff --git a/docs/reference/input/powah/common/preamble.md b/docs/reference/input/powah/common/preamble.md new file mode 100644 index 0000000..9eb0316 --- /dev/null +++ b/docs/reference/input/powah/common/preamble.md @@ -0,0 +1,49 @@ +```lua-vue +telem.input.powah.{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }} ( + peripheralID: string, + categories?: string[] | '*' +) +``` + +::: warning Mod Dependencies +Requires **Advanced Peripherals**. +::: + +See the Usage section for a complete list of the metrics in each category. + + + + + +## Usage + +```lua-vue{4} +local telem = require 'telem' + +local backplane = telem.backplane() + :addInput('my_{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }}', telem.input.powah.{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }}('right', '*')) + :cycleEvery(5)() +``` + +Given a {{ $frontmatter?.telem?.adapter?.name || 'ADAPTER.NAME' }} peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity): \ No newline at end of file From eae7ff53f094e53e803215b1c6eaf62ee603f528 Mon Sep 17 00:00:00 2001 From: cyberbit Date: Mon, 3 Mar 2025 00:56:23 +0000 Subject: [PATCH 10/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20furnato?= =?UTF-8?q?r=20and=20magmator?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 4 +-- docs/reference/input/powah/Furnator.md | 26 ++++++++++++++++++ docs/reference/input/powah/Magmator.md | 27 +++++++++++++++++++ docs/reference/input/powah/common/preamble.md | 2 +- 4 files changed, 56 insertions(+), 3 deletions(-) create mode 100644 docs/reference/input/powah/Furnator.md create mode 100644 docs/reference/input/powah/Magmator.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index b85007d..65cf4d0 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -152,8 +152,8 @@ export default defineConfig({ collapsed: true, items: [ { text: 'Energy Cell', link: '/reference/input/powah/EnergyCell' }, - // { text: 'Furnator', link: '/reference/input/powah/Furnator' }, - // { text: 'Magmator', link: '/reference/input/powah/Magmator' }, + { 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' }, diff --git a/docs/reference/input/powah/Furnator.md b/docs/reference/input/powah/Furnator.md new file mode 100644 index 0000000..e1cade4 --- /dev/null +++ b/docs/reference/input/powah/Furnator.md @@ -0,0 +1,26 @@ +--- +telem: + adapter: + id: 'furnator' + name: 'Furnator' + categories: '{ "basic" }' +--- + + + +# Powah Furnator Input + + + +### Basic + + \ No newline at end of file diff --git a/docs/reference/input/powah/Magmator.md b/docs/reference/input/powah/Magmator.md new file mode 100644 index 0000000..23d2ed2 --- /dev/null +++ b/docs/reference/input/powah/Magmator.md @@ -0,0 +1,27 @@ +--- +telem: + adapter: + id: 'magmator' + name: 'Magmator' + categories: '{ "basic" }' +--- + + + +# Powah Magmator Input + + + +### Basic + + \ No newline at end of file diff --git a/docs/reference/input/powah/common/preamble.md b/docs/reference/input/powah/common/preamble.md index 9eb0316..53065ac 100644 --- a/docs/reference/input/powah/common/preamble.md +++ b/docs/reference/input/powah/common/preamble.md @@ -6,7 +6,7 @@ telem.input.powah.{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }} ( ``` ::: warning Mod Dependencies -Requires **Advanced Peripherals**. +Requires **Minecraft 1.19.2** and **Advanced Peripherals**. ::: See the Usage section for a complete list of the metrics in each category. From f84f21a4f0726ff8e921957eec7aec0bdec5e69c Mon Sep 17 00:00:00 2001 From: cyberbit Date: Thu, 6 Mar 2025 02:55:14 +0000 Subject: [PATCH 11/15] =?UTF-8?q?=F0=9F=93=A6=20add=20docs=20for=20reactor?= =?UTF-8?q?,=20solar=20panel,=20thermo=20generator?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 24 +++++++-------- docs/reference/input/powah/Reactor.md | 29 +++++++++++++++++++ docs/reference/input/powah/SolarPanel.md | 25 ++++++++++++++++ docs/reference/input/powah/ThermoGenerator.md | 25 ++++++++++++++++ 4 files changed, 91 insertions(+), 12 deletions(-) create mode 100644 docs/reference/input/powah/Reactor.md create mode 100644 docs/reference/input/powah/SolarPanel.md create mode 100644 docs/reference/input/powah/ThermoGenerator.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 65cf4d0..296832a 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -55,17 +55,17 @@ export default defineConfig({ collapsed: true, items: [ { 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: '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: 'Bigger Reactors ✨', + // text: 'Bigger Reactors', // collapsed: true, // items: [ // { text: 'Reactor', link: '/reference/input/bigger-reactors/EnergyDetector' }, @@ -148,15 +148,15 @@ export default defineConfig({ ] }, { - text: 'Powah ✨', + text: 'Powah', collapsed: true, items: [ { 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' }, + { text: 'Reactor', link: '/reference/input/powah/Reactor' }, + { text: 'Solar Panel', link: '/reference/input/powah/SolarPanel' }, + { text: 'Thermo Generator', link: '/reference/input/powah/ThermoGenerator' }, ] }, ] diff --git a/docs/reference/input/powah/Reactor.md b/docs/reference/input/powah/Reactor.md new file mode 100644 index 0000000..2aed521 --- /dev/null +++ b/docs/reference/input/powah/Reactor.md @@ -0,0 +1,29 @@ +--- +telem: + adapter: + id: 'reactor' + name: 'Reactor' + categories: '{ "basic" }' +--- + + + +# Powah Reactor Input + + + +### Basic + + \ No newline at end of file diff --git a/docs/reference/input/powah/SolarPanel.md b/docs/reference/input/powah/SolarPanel.md new file mode 100644 index 0000000..d96dd4a --- /dev/null +++ b/docs/reference/input/powah/SolarPanel.md @@ -0,0 +1,25 @@ +--- +telem: + adapter: + id: 'solarPanel' + name: 'Solar Panel' + categories: '{ "basic" }' +--- + + + +# Powah Solar Panel Input + + + +### Basic + + \ No newline at end of file diff --git a/docs/reference/input/powah/ThermoGenerator.md b/docs/reference/input/powah/ThermoGenerator.md new file mode 100644 index 0000000..889e14e --- /dev/null +++ b/docs/reference/input/powah/ThermoGenerator.md @@ -0,0 +1,25 @@ +--- +telem: + adapter: + id: 'thermoGenerator' + name: 'Thermo Generator' + categories: '{ "basic" }' +--- + + + +# Powah Thermo Generator Input + + + +### Basic + + \ No newline at end of file From 4585052c99fbf105bfe01c6c8719eff2467d5d7a Mon Sep 17 00:00:00 2001 From: cyberbit Date: Sun, 9 Mar 2025 17:10:59 +0000 Subject: [PATCH 12/15] =?UTF-8?q?=F0=9F=93=A6=20add=20Bigger=20Reactors=20?= =?UTF-8?q?adapter=20section,=20add=20docs=20for=20Reactor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 16 ++-- .../input/bigger-reactors/Reactor.md | 74 +++++++++++++++++++ .../bigger-reactors/common/metrics.data.ts | 23 ++++++ .../input/bigger-reactors/common/preamble.md | 49 ++++++++++++ 4 files changed, 154 insertions(+), 8 deletions(-) create mode 100644 docs/reference/input/bigger-reactors/Reactor.md create mode 100644 docs/reference/input/bigger-reactors/common/metrics.data.ts create mode 100644 docs/reference/input/bigger-reactors/common/preamble.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 296832a..413fa05 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -64,14 +64,14 @@ export default defineConfig({ { text: 'RS Bridge', link: '/reference/input/advanced-peripherals/RSBridge' }, ] }, - // { - // text: 'Bigger Reactors', - // collapsed: true, - // items: [ - // { text: 'Reactor', link: '/reference/input/bigger-reactors/EnergyDetector' }, - // { text: 'Turbine', link: '/reference/input/bigger-reactors/EnvironmentDetector' }, - // ] - // }, + { + text: 'Bigger Reactors', + collapsed: true, + items: [ + { text: 'Reactor', link: '/reference/input/bigger-reactors/Reactor' }, + // { text: 'Turbine', link: '/reference/input/bigger-reactors/Turbine' }, + ] + }, { text: 'Mekanism', collapsed: true, diff --git a/docs/reference/input/bigger-reactors/Reactor.md b/docs/reference/input/bigger-reactors/Reactor.md new file mode 100644 index 0000000..5872f88 --- /dev/null +++ b/docs/reference/input/bigger-reactors/Reactor.md @@ -0,0 +1,74 @@ +--- +telem: + adapter: + id: 'reactor' + name: 'Reactor' + categories: '{ "basic", "fuel", "coolant", "energy", "formation" }' +--- + + + +# Bigger Reactors Reactor Input + + + +### Basic + + + +### Fuel + + + +### Coolant + + + + + +### Energy + + + +### Formation + + \ No newline at end of file diff --git a/docs/reference/input/bigger-reactors/common/metrics.data.ts b/docs/reference/input/bigger-reactors/common/metrics.data.ts new file mode 100644 index 0000000..d42a4c9 --- /dev/null +++ b/docs/reference/input/bigger-reactors/common/metrics.data.ts @@ -0,0 +1,23 @@ +export default { + load() { + return { + generator: { + basic: [ + { name: 'production_rate', value: '0.0 - inf', unit: 'FE/t' } + ], + + energy: [ + { name: 'energy', value: '0.0 - inf', unit: 'FE' }, + { name: 'energy_capacity', value: '0.0 - inf', unit: 'FE' } + ] + }, + + genericMachine: { + basic: [ + { name: 'active', value: '0 or 1' }, + { name: 'connected', value: '0 or 1' } + ] + } + } + } +} \ No newline at end of file diff --git a/docs/reference/input/bigger-reactors/common/preamble.md b/docs/reference/input/bigger-reactors/common/preamble.md new file mode 100644 index 0000000..b3219dd --- /dev/null +++ b/docs/reference/input/bigger-reactors/common/preamble.md @@ -0,0 +1,49 @@ +```lua-vue +telem.input.biggerReactors.{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }} ( + peripheralID: string, + categories?: string[] | '*' +) +``` + +::: warning Mod Dependencies +Requires **Bigger Reactors**. +::: + +See the Usage section for a complete list of the metrics in each category. + + + + + +## Usage + +```lua-vue{4} +local telem = require 'telem' + +local backplane = telem.backplane() + :addInput('my_{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }}', telem.input.biggerReactors.{{ $frontmatter?.telem?.adapter?.id || 'ADAPTER.ID' }}('right', '*')) + :cycleEvery(5)() +``` + +Given a {{ $frontmatter?.telem?.adapter?.name || 'ADAPTER.NAME' }} peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity): \ No newline at end of file From f996ee93523fa62d2891df8c0791897bfdf61d5c Mon Sep 17 00:00:00 2001 From: cyberbit Date: Tue, 11 Mar 2025 01:10:41 +0000 Subject: [PATCH 13/15] =?UTF-8?q?=F0=9F=93=A6=20add=20conditional=20marks?= =?UTF-8?q?=20to=20reactor=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../input/bigger-reactors/Reactor.md | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/reference/input/bigger-reactors/Reactor.md b/docs/reference/input/bigger-reactors/Reactor.md index 5872f88..70c179d 100644 --- a/docs/reference/input/bigger-reactors/Reactor.md +++ b/docs/reference/input/bigger-reactors/Reactor.md @@ -19,12 +19,15 @@ telem: @@ -43,7 +46,10 @@ telem: ### Coolant - +::: warning Active reactor only +The coolant metrics are only available for active reactors. +::: + - ### Energy +::: warning Passive reactor only +The energy metrics are only available for passive reactors. +::: + @@ -47,7 +51,7 @@ telem: ### Coolant ::: warning Active reactor only -The coolant metrics are only available for active reactors. +Coolant metrics are only available for active reactors. ::: + import { data as metrics } from './common/metrics.data.ts' + + +# Bigger Reactors Turbine Input + + + +### Basic + + + +### Fluid + + + +### Energy + + \ No newline at end of file From 5966d6e1ad22ef2215686de5ab19cbbd9bda12fc Mon Sep 17 00:00:00 2001 From: cyberbit Date: Wed, 12 Mar 2025 02:34:03 +0000 Subject: [PATCH 15/15] =?UTF-8?q?=F0=9F=91=8C=20pr=20fixes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index e661b6e..62c3c72 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -54,10 +54,10 @@ export default defineConfig({ text: 'Advanced Peripherals', collapsed: true, items: [ - { 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: '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' },