Skip to content
forked from cyberbit/telem

Trivial Extract and Load Engine for Minecraft

License

Notifications You must be signed in to change notification settings

Erb3-forked/telem

 
 

Repository files navigation

Telem - Trivial Extract and Load Engine for Minecraft

Build PineStore

Tired of creating complex logic to monitor inventory or production? Want something more modern, modular, and scalable? Want something that can empower a dashboard like the screenshot below? You have come to the right place.

image

Requirements

  • ComputerCraft (Tweaked and Restitched also supported)
  • http access for installer and certain adapters

Note: These docs are being actively written so please excuse my dust! If you have questions, post them in this discussion.

Install

This runs the installer. You have a choice to install minified, packaged, and source versions.

wget run https://pinestore.cc/d/14

Usage

Please visit telem.cc for full documentation.

local telem = require 'telem'

local backplane = telem.backplane()                  -- setup the fluent interface
  :addInput('hello_in', telem.input.helloWorld(123)) -- add a named input
  :addOutput('hello_out', telem.output.helloWorld()) -- add a named output

-- call a function that reads all inputs and writes all outputs, then waits 3 seconds, repeating indefinitely
backplane:cycleEvery(3)()

-- alternative threadable option
parallel.waitForAny(
  backplane:cycleEvery(3),
  
  function ()
    while true do
      -- listen for events, control your reactor, etc.
      
      -- make sure to yield somewhere in your loop or the backplane will not cycle correctly
      sleep()
    end
  end)

Input Adapters

  • Hello World (testing)
  • Item Storage
  • Fluid Storage
  • Refined Storage (RS Bridge)
  • ME Storage (ME Bridge)
  • Mekanism Fission Reactor
  • Mekanism Fusion Reactor
  • Mekanism Induction Matrix
  • Mekanism Industrial Turbine
  • Custom Inputs
  • Secure Modems ✨
  • More to come!

Output Adapters

  • Hello World (testing)
  • Grafana* (Grafana Cloud or self-hosted)
  • Basalt labels
  • Custom Outputs
  • Secure Modems ✨
  • More to come!

*You will need to set up a free account on Grafana Cloud or provision a self-hosted Grafana + InfluxDB + Telegraf instance to use the Grafana output. A more detailed guide for Grafana is planned for the future.

About

Trivial Extract and Load Engine for Minecraft

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Lua 98.6%
  • Shell 1.4%