Denser documentation. 'Slay The Dragon' Part 2

README.md

@@ -18,6 +18,7 @@ world. A few notable features:
   * [pipeworks](https://gitlab.com/VanessaE/pipeworks/) -> automation of item transport
   * [moreores](https://github.com/minetest-mods/moreores/) -> additional ores
   * [basic_materials](https://gitlab.com/VanessaE/basic_materials) -> basic craft items
+  * Supports [moretrees](https://gitlab.com/VanessaE/moretrees) -> rubber trees
   * Consult `depends.txt` or `mod.conf` of each mod for further dependency information.
 
 

manual.md

@@ -79,151 +79,108 @@ shielding materials available.
 
 Keep a safety distance of a meter to avoid being harmed by radiation.
 
-
 #### Silver ²
+Use: conductors
 
-Silver is supplied by the moreores mod.  It is found from elevation -2
+Depth: -2m, evenly common
-downwards, with no elevation-dependent variations in abundance beyond
+
-that point.  It is a semi-precious metal.  It is little used, being most
+Silver is a semi-precious metal and is the best conductor of all the pure elements.
-notably used in electrical items due to its conductivity, being the best
-conductor of all the pure elements.
 
 #### Gold ¹
-Gold is part of the basic Minetest game (having migrated there from
+Use: various
-moreores).  It is found from elevation -64 downwards, but is more
+
-abundant from elevation -256 downwards.  It is a precious metal.  It is
+Depth: -64m, more commonly below -256m
-little used, being most notably used in electrical items due to its
+
-combination of good conductivity (third best of all the pure elements)
+Gold is a precious metal. It is most notably used in electrical items due to
-and corrosion resistance.
+its combination of good conductivity and corrosion resistance.
 
 #### Mithril ²
-Mithril is supplied by the moreores mod.  It is found from elevation
+Use: chests
--512 downwards, the deepest ceiling of any minable substance, with
+
-no elevation-dependent variations in abundance beyond that point.
+Depth: -512m, evenly common
-It is a rare precious metal, and unlike all the other metals described
+
-here it is entirely fictional, being derived from J. R. R. Tolkien's
+Mithril is a fictional ore, being derived from J. R. R. Tolkien's
 Middle-Earth setting.  It is little used.
 
 #### Mese ¹
-Mese is part of the basic Minetest game.  It is found from elevation
+Use: various
--64 downwards.  The ore is more abundant from elevation -256 downwards,
+
-and from elevation -1024 downwards there are also occasional blocks of
+Mese is a precious gemstone, and unlike diamond it is entirely fictional.
-solid mese (each yielding as much mese as nine blocks of ore).  It is a
+It is used in small quantities, wherever some magic needs to be imparted.
-precious gemstone, and unlike diamond it is entirely fictional.  It is
-used in many recipes, though mainly not in large quantities, wherever
-some magical quality needs to be imparted.
 
 #### Diamond ¹
-Diamond is part of the basic Minetest game (having migrated there from
+Use: mainly for cutting machines
-technic).  It is found from elevation -128 downwards, but is more abundant
-from elevation -256 downwards.  It is a precious gemstone.  It is used
-moderately, mainly for reasons connected to its extreme hardness.
 
-### Rock
+Diamond is a precious gemstone. It is used moderately, mainly for reasons
+connected to its extreme hardness.
 
-In addition to the ores, there are multiple kinds of rock that need to be
+### Rocks
-mined in their own right, rather than for minerals.  The rock types that
-matter in technic are standard stone, desert stone, marble, and granite.
 
-Standard stone is part of the basic Minetest game.  It is extremely
+This section describes the rock types added by technic. Further rock types
-common.  As in the basic game, when dug it yields cobblestone, which can
+are supported by technic machines. These can be processed using the grinder:
-be cooked to turn it back into standard stone.  Cobblestone is used in
-recipes only for some relatively primitive machines.  Standard stone is
-used in a couple of machine recipes.  These rock types gain additional
-significance with technic because the grinder can be used to turn them
-into dirt and sand.  This, especially when combined with an automated
-cobblestone generator, can be an easier way to acquire sand than
-collecting it where it occurs naturally.
 
-Desert stone is part of the basic Minetest game.  It is found specifically
+ * Stone (plain)
-in desert biomes, and only from elevation +2 upwards.  Although it is
+ * Cobblestone
-easily accessible, therefore, its quantity is ultimately quite limited.
+ * Desert Stone
-It is used in a few recipes.
 
-Marble is supplied by technic.  It is found in dense clusters from
+#### Marble
-elevation -50 downwards.  It has mainly decorative use, but also appears
+Depth: -50m, evenly common
-in one machine recipe.
 
-Granite is supplied by technic.  It is found in dense clusters from
+Marble is found in dense clusters and has mainly decorative use, but also
-elevation -150 downwards.  It is much harder to dig than standard stone,
+appears in one machine recipe.
-so impedes mining when it is encountered.  It has mainly decorative use,
-but also appears in a couple of machine recipes.
 
-### rubber ###
+#### Granite
+Depth: -150m, evenly common
 
+Granite is found in dense clusters and is much harder to dig than standard
+stone. It has mainly decorative use, but also appears in a couple of
+machine recipes.
+
+### Rubber
 Rubber is a biologically-derived material that has industrial uses due
 to its electrical resistivity and its impermeability.  In technic, it
 is used in a few recipes, and it must be acquired by tapping rubber trees.
 
-If you have the moretrees mod installed, the rubber trees you need
+Rubber trees are provided by technic if the moretrees mod is not present.
-are those defined by that mod.  If not, technic supplies a copy of the
-moretrees rubber tree.
 
-Extracting rubber requires a specific tool, a tree tap.  Using the tree
+Extract raw latex from rubber using the "Tree Tap" tool. Punch/left-click the
-tap (by left-clicking) on a rubber tree trunk block extracts a lump of
+tool on a rubber tree trunk to extract a lump of raw latex from the trunk.
-raw latex from the trunk.  Each trunk block can be repeatedly tapped for
+Emptied trunks will regenerate at intervals of several minutes, which can be
-latex, at intervals of several minutes; its appearance changes to show
+observed by its appearance.
-whether it is currently ripe for tapping.  Each tree has several trunk
-blocks, so several latex lumps can be extracted from a tree in one visit.
 
-Raw latex isn't used directly.  It must be vulcanized to produce finished
+To obtain rubber from latex, alloy latex with coal dust.
-rubber.  This can be performed by alloying the latex with coal dust.
 
-### metal ###
+### Metals
+Generally, each metal can exist in five forms:
 
-Many of the substances important in technic are metals, and there is
+ * ore -> stone containing the lump
-a common pattern in how metals are handled.  Generally, each metal can
+ * lump -> draw metal obtained by digging ("nuggets")
-exist in five forms: ore, lump, dust, ingot, and block.  With a couple of
+ * dust -> grinder output
-tricky exceptions in mods outside technic, metals are only *used* in dust,
+ * ingot -> melted/cooked lump or dust
-ingot, and block forms.  Metals can be readily converted between these
+ * block -> placeable node
-three forms, but can't be converted from them back to ore or lump forms.
 
-As in the basic Minetest game, a "lump" of metal is acquired directly by
+Metals can be converted between dust, ingot and block, but can't be converted
-digging ore, and will then be processed into some other form for use.
+from them back to ore or lump forms.
-A lump is thus more akin to ore than to refined metal.  (In real life,
-metal ore rarely yields lumps ("nuggets") of pure metal directly.
-More often the desired metal is chemically bound into the rock as an
-oxide or some other compound, and the ore must be chemically processed
-to yield pure metal.)
 
-Not all metals occur directly as ore.  Generally, elemental metals (those
+#### Grinding
-consisting of a single chemical element) occur as ore, and alloys (those
+Ores can be processed as follows:
-consisting of a mixture of multiple elements) do not.  In fact, if the
-fictional mithril is taken to be elemental, this pattern is currently
-followed perfectly.  (It is not clear in the Middle-Earth setting whether
-mithril is elemental or an alloy.)  This might change in the future:
-in real life some alloys do occur as ore, and some elemental metals
-rarely occur naturally outside such alloys.  Metals that do not occur
-as ore also lack the "lump" form.
 
-The basic Minetest game offers a single way to refine metals: cook a lump
+ * ore -> lump (digging) -> ingot (melting)
-in a furnace to produce an ingot.  With technic this refinement method
+ * ore -> lump (digging) -> 2x dust (grinding) -> 2x ingot (melting)
-still exists, but is rarely used outside the early part of the game,
-because technic offers a more efficient method once some machines have
-been built.  The grinder, available only in electrically-powered forms,
-can grind a metal lump into two piles of metal dust.  Each dust pile
-can then be cooked into an ingot, yielding two ingots from one lump.
-This doubling of material value means that you should only cook a lump
-directly when you have no choice, mainly early in the game when you
-haven't yet built a grinder.
 
-An ingot can also be ground back to (one pile of) dust.  Thus it is always
+At the expense of some energy consumption, the grinder can extract more material
-possible to convert metal between ingot and dust forms, at the expense
+from the lump, resulting in 2x dust which can be melted to two ingots in total.
-of some energy consumption.  Nine ingots of a metal can be crafted into
-a block, which can be used for building.  The block can also be crafted
-back to nine ingots.  Thus it is possible to freely convert metal between
-ingot and block forms, which is convenient to store the metal compactly.
-Every metal has dust, ingot, and block forms.
 
+#### Alloying
 Alloying recipes in which a metal is the base ingredient, to produce a
 metal alloy, always come in two forms, using the metal either as dust
 or as an ingot.  If the secondary ingredient is also a metal, it must
 be supplied in the same form as the base ingredient.  The output alloy
-is also returned in the same form.  For example, brass can be produced
+is also returned in the same form.
-by alloying two copper ingots with one zinc ingot to make three brass
+
-ingots, or by alloying two piles of copper dust with one pile of zinc
+Example: 2x copper ingots + zinc ingot -> 3x brass ingot (alloying)
-dust to make three piles of brass dust.  The two ways of alloying produce
+
-equivalent results.
+The same will also work for dust ingredients, resulting in brass dist.
 
 ### iron and its alloys ###
 

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
+