[FEATURE] Addition of Hytale Electricity API called HyVoltz #357
Description
Feature Type
- [✔️] New documentation topic
- Site functionality improvement
- UI/UX enhancement
- Search improvement
- Navigation enhancement
- Developer experience
- Other (please describe)
- [ ]
Addition of said library for centralised handling of power with all mods
Description of library
Hyvoltz is a simple developer friendly high performance electrical handling library. It works on a Node-Network graph generator system. As a mod developer, all you have to do is properly add a node to your mod and attach it to the engine when the node is in world and rest is all handled by the mod.
Nodes are simply produces, consumers, buffers or connectors or as you call a power generator, electrical furnace, batteries and wires.
Network is defined by the mod when a Attach or Detach call is made by the mods. Networks do not persist and hence are woven on world load, this also means in case of a chunk error or loss of generators/mods not loading, the network does not error and just builds from scratch.
If you call attach too early, the mod simply delays the action till the world loads.
Its a simple system which support priority and balancing and still stays performant.
I will personally write the documentation if required and approved by the staff.
If we support a single library from day 1, it will become a standard so as to not cause issues later.
You can see the mod here at https://github.com/AlmanaX-21/HyVoltz
Additional Context
I wish to clarify that documentation and unit tests are AI assisted but I have looked over them and ensured quality