consolidate upstream wiki into repository as markdown files (upstream-wiki only has minor edits since 2017)

related: #53

README.md

@@ -10,6 +10,9 @@ A mod for [minetest](http://www.minetest.net)
 
 # Overview
 
+<img src="./technic/doc/images/Technic Screenshot.png"/>
+
+
 The technic modpack extends the Minetest game with many new elements,
 mainly constructable machines and tools.  It is a large modpack, and
 tends to dominate gameplay when it is used.  This manual describes how
@@ -42,6 +45,7 @@ its specialised recipe types.
 # Documentation
 
 Ingame:
+* [Resources](./technic/doc/resources.md)
 * [Substances](./technic/doc/substances.md)
 * [Processes](./technic/doc/processes.md)
 * [Chests](./technic/doc/chests.md)
@@ -52,22 +56,12 @@ Ingame:
 * [Forceload anchor](./technic/doc/anchor.md)
 * [Digilines](./technic/doc/digilines.md)
 * [Mesecons](./technic/doc/mesecons.md)
+* [Tools](./technic/doc/tools.md)
 
 Mod development:
 * [Api](./technic/doc/api.md)
 
 subjects missing from this manual:
-* powered tools
-  * tool charging
-  * battery and energy crystals
-  * chainsaw
-  * flashlight
-  * mining lasers
-  * mining drills
-  * prospector
-  * sonic screwdriver
-* liquid cans
-* wrench
 * frames
 * templates
 

technic/doc/digilines.md

@@ -8,7 +8,14 @@ technic machines with the `digilines` mod (https://github.com/minetest-mods/digi
 
 **NOTE**: make sure the channel is set accordingly, "switch" in this case
 
-Get power and lag stats:
+There are two ways getting information from the switching station:
+1. Give it a mesecon signal (eg. with a lever) and it will send always when the supply or demand changes.
+
+2. Send to the switching station `"get"` or `"GET"` and it will send back.
+
+The sent message is always a table containing the supply, demand and lag.
+
+Example luacontroller code:
 ```lua
 if event.type == "program" then
 	-- start interrupt cycle
@@ -30,3 +37,68 @@ if event.type == "digiline" and event.channel == "switch" then
 	--]]
 end
 ```
+
+
+## Supply Converter
+You can send the following to it:
+- `"get"`: It will send back a table containing the fields `"enabled"`, `"power"` and `"mesecon_mode"` which are all integers.
+- `"off"`: Deactivate the supply converter.
+- `"on"`: Activate the supply converter.
+- `"toggle"`: Activate or deactivate the supply converter depending on its current state.
+- `"power "..power`: Set the amount of the power, it shall convert.
+- `"mesecon_mode "..<int>`: Set the mesecon mode.
+
+## Battery Boxes
+Send to it `"get"` or `"GET"` and it will send a table back containing:
+- `demand`: A number.
+- `supply`: A number.
+- `input`: A number.
+- `charge`: A number.
+- `max_charge`: A number.
+- `src`: Itemstack made to table.
+- `dst`: Itemstack made to table.
+- `upgrade1`: Itemstack made to table.
+- `upgrade2`: Itemstack made to table.
+
+
+## Forcefield Emitter
+You should send a table to it containing the `command` and for some commands the `value` field.
+Some strings will automatically be made to tables:
+- `"get"` :arrow_right: `{command = "get"}`
+- `"off"` :arrow_right: `{command = "off"}`
+- `"on"` :arrow_right: `{command = "on"}`
+- `"toggle"` :arrow_right: `{command = "toggle"}`
+- `"range "..range` :arrow_right: `{command = "range", value = range}`
+- `"shape "..shape` :arrow_right: `{command = "shape", value = shape}`
+
+The commands:
+- `"get"`: The forcefield emitter sends back a table containing:
+  - `"enabled"`: `0` is off, `1` is on.
+  - `"range"`
+  - `"shape"`: `0` is spheric, `1` is cubic.
+- `"off"`: Deactivate the forcefield emitter.
+- `"on"`: Activate the forcefield emitter.
+- `"toggle"`: Activate or deactivate the forcefield emitter depending on its current state.
+- `"range"`: Set the range to `value`.
+- `"shape"`: `value` can be a number (`0` or `1`) or a string (`"sphere"` or `"cube"`).
+
+
+## Nuclear Reactor
+Since the nuclear reactor core can't be accessed by digiline wire because the water layer which mustn't have a hole, you need the HV Digicables to interact with it.
+
+You should send a table to it containing at least the `command` field and for some commands other fields.
+
+The commands:
+- `"get"`: The nuclear reactor sends back a table containing:
+  - `"burn_time"`: The time in seconds how long the reactor already runs. One week after start, when it reaches 7 * 24 * 60 * 60 (=604800), the fuel is completely used.
+  - `"enabled"`: A bool.
+  - `"siren"`: A bool.
+  - `"structure_accumulated_badness"`
+  - `"rods"`: A table with 6 numbers in it, one for each fuel slot.
+    -  A positive value is the count of fuel rods in the slot.
+    - `0` means the slot is empty.
+    -  A negative value means some other items are in the slot. The absolute value is the count of these items.
+- `"self_destruct"`: A setting has to be enabled to use this. The reactor will melt down after `timer` seconds or instantly.
+- `"start"`: Tries to start the reactor, `"Start successful"` is sent back on success, `"Error"` if something is wrong.
+
+If the automatic start is enabled, it will always send `"fuel used"` when it uses fuel.

technic/doc/machines.md

@@ -2,6 +2,26 @@
 powered machines
 ----------------
 
+## Overview
+Many of the important machines in Technic run on electricity, using wires to connect generators with the consuming machines. These electric circuits consist of a generator, a consumer, wiring, and a switching station. Every independent circuit requires all 4 of these elements to function. In general the machines are all connected on the bottom by wire. Machines should be placed first and then the wire placed under and around them. The wiring should automatically adjust itself to connect to each machine and adjacent wires. If the wiring looks incorrect, it's likely that it won't work so be sure to check this!
+
+Circuits are also grouped into 3 different categories based on how much power they transfer and the corresponding voltage: low voltage (LV), medium voltage (MV), and high voltage (HV). The base level for all electronics is low voltage, so if voltage isn't specified for a electrical component, you may safely assume it's low voltage. Most low-voltage components are upgradable to medium- and high-voltage through further crafting. To get started, you won't need to worry about any MV or HV components, and the basic low-voltage components are fine.
+
+## Getting started
+The first step to working with the more advanced machines are to get a basic electrical circuit set up for converting coal into power for other machines. This will rely on the following:
+
+<img src="./images/LV_Fuel_Fired_Generator_Crafting.png"/>
+1x LV Fuel Fired Generator
+
+<img src="./images/Switching_station_crafting.png"/>
+1x Switching station
+
+<img src="./images/LV_cable_Crafting.png"/>
+2x LV Cable
+
+The generator and switching station should be placed side-by-side with the wire underneath connecting both of them. Once this is done, additional consumers can be added to the network. A grinder or extractor are both good choices to expand the capabilities of the coal-fired smelter and coal-fired alloy furnace that you already have.
+
+
 ### powered machine tiers ###
 
 Each powered machine takes its power in some specific form, being

technic/doc/resources.md

@@ -0,0 +1,7 @@
+Technic provides additional resources for building these machines.
+
+## Latex
+
+<img src="../textures/technic_raw_latex.png"/>
+
+Latex is used for manufacturing rubber, which is heavily used for the medium- and high-voltage components within Technic. Latex can be harvested directly from rubber trees (look for the pale green/seafoam leaves) using the tree tap like any other tool. Rubber trees regenerate their latex supplies after about a day.

technic/doc/tools.md

@@ -0,0 +1,69 @@
+Tools in Technic fall into two categories: manual and electric. Both sets of tools are unstackable in the inventory. Manual tools work similarly to the manual tools in `minetest`, they have limited durability that is reduced during use (they disappear after they hit 0 durability). Manual tools can be regenerated by using the Tool Workshop, so that valuable tools, such as mese or diamond tools can be preserved. Electric tools require charging in Battery Boxes (of any voltage) and will not be destroyed when they reach 0 charge. Higher levels of electric tools are more powerful and contain more charge so they work longer.
+
+## Chainsaw
+
+<img src="../textures/technic_chainsaw.png"/>
+
+This electric tool speeds up harvesting of wood by allowing the harvesting of an entire tree in a single click. Just click on any part of a tree, and the wood and leaves of that tree at that point and above will be cut and dropped on the ground as blocks. It has enough charge to cut down about 5 trees before running out of power.
+
+**Note:** If you can't find the drops from using the chainsaw, dig around as they can be buried under neighbouring terrain blocks.
+
+## Flashlight
+
+<img src="../textures/technic_flashlight.png"/>
+
+This electric tool illumates the area in front of the player. While it is electric, and so requires charging, to use it one only needs to equip it. Punching with this tool does nothing.
+
+## Lava can
+
+<img src="../textures/technic_lava_can.png"/>
+
+The lava can works similarly to the bucket tool and the water can, but instead of carrying water, it can carry lava source blocks (the ones that aren't animated), up to 8 at a time. To use, simply equip and click on lava source blocks (they will highlight in black). Then clicking anywhere where there isn't a lava source block will place them again.
+
+**Warning:** Be careful where you place these source blocks! Since you're placing lava source blocks, lava will flow out of them and may trap or burn you depending on where you are.
+
+## Mining drill
+
+<img src="../textures/technic_mining_drill.png"/>
+<img src="../textures/technic_mining_drill_mk2.png"/>
+<img src="../textures/technic_mining_drill_mk3.png"/>
+
+This electric tool operates similarly to a pickaxe, though every block takes exactly one click to drill out. While the Mining Laser allows for faster collection of bulk minerals, it's cutting path can sometimes be undesirable, and the mining drill is useful in these instances.
+
+The higher levels of the mining drill allow for drilling more blocks at once, substantially reducing mining time. At mark-2, the mining drill can drill 3 blocks at once, either 3-deep, 3-wide, or 3-tall. At mark-3, the mining drill can drill 9-blocks at once in a 3x3 layout around the block selected. Switching between these modes can be done by shift-clicking.
+
+**Advice:** Since these tools require substantially more diamonds than the mining laser, and yet drills slower, it is suggested that a mining laser be built first.
+
+## Mining laser
+
+<img src="../textures/technic_mining_laser_mk1.png"/>
+<img src="../textures/technic_mining_laser_mk2.png"/>
+<img src="../textures/technic_mining_laser_mk3.png"/>
+
+This electric tool is a substantial upgrade above the pickaxe that you start mining with. The laser works by drilling directly forward 7 blocks making a path that's roughly 1-block in diameter. The laser is electric, requiring charging in a battery box (any voltage). As soon as an LV electrical system is set up, this is a great next step.
+
+## Sonic screwdriver
+
+<img src="../textures/technic_sonic_screwdriver.png"/>
+
+This electric tool is used for rotating nodes, much like the default Screwdriver tool, but loses charge instead of durability. This is useful for any nodes which have a "front" direction, like stairs, machines, furniture, etc. Nodes are rotated around the Y-axes (vertical).
+
+## Tree tap
+
+<img src="../textures/technic_tree_tap.png"/>
+
+This manual tool allows for harvesting latex from rubber trees. Extracting latex can be done by hitting rubber trees with it yields for 1 latex. The rubber tree will regenerate its latex supply over the course of a day.
+
+## Water can
+
+<img src="../textures/technic_water_can.png"/>
+
+The water can works similarly to the bucket tool from minetest_game, but it can hold 16 `water_source` (the water blocks that don't look like they're flowing) blocks instead of 1. To use, simply equip the water can and click on water source blocks (they will highlight in black). Then clicking anywhere where there isn't a `water_source` block with the water can equipped will place them.
+
+**Warning:** Be careful where you place these source blocks! Since you're placing water source blocks, water will flow out of them and may trap or drown you depending on where you are.
+
+## Wrench
+
+<img src="../textures/technic_wrench.png"/>
+
+The manual tool allows for moving blocks which contain an inventory, like chests. A shift-right-click on a machine/chest will immediately add it to the inventory.