This repository contains the tech_api mod, which makes energy delivery and distribution uniform throughout all the mods that use it. This means that if you are creating a Minetest mod that will use/produce/store/carry energy, this API will give you all the tools you need to simplify your life and make your creation compatible with all the other mods that use it.
It is also an excuse to rewrite the energy subsystem of the Technic mod, which will probably be the first one to use the API.
Also, in the future, it may be extended to provide useful methods to deal with items and fluids (i.e. pipes and tubes compatible between different mods), but the focus is currently on power distribution.
Currently it has no implementation, but a specification sheet
is being written. Go check it out and feel free to contribute with your ideas,
requirements or wishes, so that we can build something we all agree upon and
we'll all be using in our mods.
A first implementation is in progress on the experimental branch.
The code is well documented using LDoc. First be sure to read the
specifications document to understand the architecture
of the energy system. Then, to have in-depth documentation for the Lua code, you
can run the script generate-doc.sh, which will generate HTML pages for the
various modules. Open ldoc/index.html. Obviously you must have LDoc installed,
along with its requirements. Follow the
instructions here.
If you don't care about pretty docs then you can just go through the code and follow the comments.
You can contribute by creating an issue (or participating to the already open ones). If you want to help directly with the specs, just fork the repository and make a pull request.
You can also join the IRC channel #minetest-technic to talk with us.
Thank you!