Denser documentation. 'Slay The Dragon' Part 2

2020-09-16 18:56:10 +02:00
parent cd5a3ee1ef
commit c06a56daff
3 changed files with 85 additions and 109 deletions
--- a/mod_api.md
+++ b/mod_api.md
@ -0,0 +1,18 @@
+# technic API
+
+This is an initial version of the API that can be used by mods.
+
+
+ * `technic.register_tier(tier, description)`
+    * Registers a network type (tier)
+    * `tier`: string, short name (ex. `LV`)
+    * `description`: string, long name (ex. `Low Voltage`)
+ * `technic.register_machine(tier, nodename, machine_type)`
+    * Registers a machine bound to the network tier
+    * `tier`: see `register_tier`
+    * `nodename`: string, node name
+    * `machine_type`: string, following options are possible:
+        * `"RE"`: Receiver
+        * `"PR"`: Producer
+        * `"BA"`: Battery, energy storage
+